@broadcom/ca7-for-zowe-cli
Version:
CA 7 Workload Automation Plug-in for Zowe CLI
244 lines • 9.19 kB
JavaScript
"use strict";
/*
* Copyright (c) 2025 Broadcom. All Rights Reserved. The term
* "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
*
* This software and all information contained therein is
* confidential and proprietary and shall not be duplicated,
* used, disclosed, or disseminated in any way except as
* authorized by the applicable license agreement, without the
* express written permission of Broadcom. All authorized
* reproductions must be marked with this language.
*
* EXCEPT AS SET FORTH IN THE APPLICABLE LICENSE AGREEMENT, TO
* THE EXTENT PERMITTED BY APPLICABLE LAW, BROADCOM PROVIDES THIS
* SOFTWARE WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT
* LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR
* FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT WILL BROADCOM
* BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY LOSS OR
* DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS SOFTWARE,
* INCLUDING WITHOUT LIMITATION, LOST PROFITS, BUSINESS
* INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF BROADCOM IS
* EXPRESSLY ADVISED OF SUCH LOSS OR DAMAGE.
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.PutInstanceDefinition = void 0;
exports.PutInstanceDefinition = {
name: "put-instance",
aliases: ["ui"],
summary: "Update CA 7 instance",
description: "Update a CA 7 Instance Configuration",
examples: [
{
options: "--name INSTANCE1 --ca7_host myhost.domain.com --ca7_port 12345",
description: "Update a CA 7 Instance Configuration for specified instance"
}
],
type: "command",
handler: __dirname + "/PutInstance.handler",
profile: {
optional: ["ca7"]
},
options: [
{
name: "name",
description: "The unique name of this instance." +
"\nThis is the name to be used in all API requests" +
"\n.",
type: "string",
required: true
},
{
name: "ca7_host",
description: "The CA7ONL host IP/DNS" +
"\n.",
type: "string",
required: true
},
{
name: "ca7_port",
description: "The CA7ONL port" +
"\n.",
type: "number",
required: true
},
{
name: "ca7_secure",
description: "True, if the communication with CA 7 should use secure sockets.",
type: "boolean",
required: false
},
{
name: "ca7_keystore",
description: "The full path to the keystore/truststore file used for SSL communication to CA7ONL",
type: "string",
required: false
},
{
name: "ca7_keystorePass",
description: "The keystore/truststore password" +
"\n.",
type: "string",
required: false
},
{
name: "ca7_protocol",
description: " The SSL protocol to be used for secure socket communication with CA7ONL." +
"\nThe default is TLSv1.2." +
"\nIf it is not specified the default will be used.",
type: "string",
required: false
},
{
name: "ca7_communicatorPoolSize",
description: "The maximum number of connections to be opened to a CA7ONL instance." +
"\nThis must be a positive value that does not exceed the maximum number of terminals." +
"\n",
type: "number",
required: false
},
{
name: "ca7_communicatorEvictableIdleTimeSeconds",
description: "The time, in seconds, to keep an existing connection open." +
"\nIf the connection is not used and the idle time passes, the connection will be closed." +
"\n",
type: "number",
required: false
},
{
name: "ca7_authorizationRetryCount",
description: "The number of retries to be used for access to endpoint authorization." +
"\nIf HttpStatus.SERVICE_UNAVAILABLE is returned, the authorization will be retried up to ca7_authorizationRetryCount." +
"\nThe default is 5.",
type: "number",
required: false
},
{
name: "ca7_timeout",
description: "The timeout, in seconds, used when connecting to and reading from CA 7 via the TCP/IP terminal interface." +
"\nThe default is 60.",
type: "number",
required: false
},
{
name: "ca7_use_uid_filter",
description: "Flag to turn on/off the UID/COIDs usage" +
"\nDefault: false",
type: "boolean",
required: false
},
{
name: "ca7_pool_retry",
description: "How many times to try to get the communicator from the pool" +
"\nDefault: 10",
type: "number",
required: false
},
{
name: "ca7_pool_retry_timeout",
description: "The time interval between 2 attempts to get the communicator from the pool, in milliseconds" +
"\nDefault: 500",
type: "number",
required: false
},
{
name: "db_logical_name",
description: "The logical database name" +
"\nIf not specified in the instance configuration, the name will need to be passed as a parameter to the request.",
type: "string",
required: false
},
{
name: "db_host",
description: "The Datacom server host IP/DNS" +
"\nIf not specified in the instance configuration, all the requests that requires Datacom connection will fail",
type: "string",
required: false
},
{
name: "db_port",
description: "The Datacom server port" +
"\nIf not specified in the instance configuration, all the requests that requires Datacom connection will fail",
type: "number",
required: false
},
{
name: "db_user",
description: "The Datacom user ID" +
"\nIf not specified in the instance configuration, all the requests that requires Datacom connection will fail",
type: "string",
required: false
},
{
name: "db_password",
description: "The Datacom user's password" +
"\nIf not specified in the instance configuration, all the requests that requires Datacom connection will fail",
type: "string",
required: false
},
{
name: "db_server_name",
description: "The Datacom server name" +
"\nIf not specified in the instance configuration, all the requests that requires Datacom connection will fail",
type: "string",
required: false
},
{
name: "db_secure",
description: "Flag to be set to true if the connection to db will be done using SSL" +
"\nThe default is false",
type: "boolean",
required: false
},
{
name: "db_trustStore",
description: "The full path to the keystore/truststore file used for SSL communication to Datacom",
type: "string",
required: false
},
{
name: "db_trustPass",
description: "The keystore/truststore password" +
"\n.",
type: "string",
required: false
},
{
name: "db_protocol",
description: " The SSL protocol to be used for secure socket communication with Datacom." +
"\nThe default is TLSv1.2." +
"\nIf it is not specified, the default will be used.",
type: "string",
required: false
},
{
name: "db_max_pool",
description: "The maximum number of Datacom connections to be available in the same time." +
"\nDefault: 10",
type: "number",
required: false
},
{
name: "db_min_pool",
description: "The minimum number of Datacom connections to be kept idle when they are not used" +
"\nDefault: 0",
type: "number",
required: false
},
{
name: "db_timeout",
description: "The connection to Datacom timeout in seconds" +
"\nDefault: 60",
type: "number",
required: false
},
{
name: "db_trace",
description: "Flag to turn on/off the jdbc trace on the RestApi side for Datacom queries" +
"\nDefault: false",
type: "boolean",
required: false
}
]
};
//# sourceMappingURL=PutInstance.definition.js.map