@zowe/zosmf-for-zowe-sdk/lib/constants/Zosmf.constants.js

Zowe SDK to interact with the z/OS Management Facility

"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.
*
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.ZosFilesOptions = exports.ZosmfConstants = void 0;
/**
 * Constants to be used by the z/OSMF API
 */
exports.ZosmfConstants = {
    /**
     * Specifies the z/OS data set and file REST interface
     * @type {string}
     */
    RESOURCE: "/zosmf",
    /**
     * indicator for get info request
     * @type {string}
     */
    INFO: "/info",
    /**
     * indicator for get topology services
     * @type {string}
     */
    TOPOLOGY: "/resttopology",
    /**
     * indicator for get defined systems in zosmf
     * @type {string}
     */
    SYSTEMS: "/systems",
    /**
     * URI for the z/OSMF change password/passphrase endpoint
     * @type {string}
     */
    AUTHENTICATE_RESOURCE: "/zosmf/services/authenticate",
    /**
     * Known error codes return by the API
     * @type {object}
     */
    ERROR_CODES: {
        /**
         * Error code when unable to connect to host
         * @type {string}
         */
        BAD_HOST_NAME: "ENOTFOUND",
        /**
         * Error code when unable to connect to port
         * @type {string}
         */
        BAD_PORT: "ECONNREFUSED",
        /**
         * Error code when self signed certificate in chain
         * @type {string}
         */
        SELF_SIGNED_CERT_IN_CHAIN: "SELF_SIGNED_CERT_IN_CHAIN",
        /**
         * Error code when unable to verify the first certificate
         * @type {string}
         */
        UNABLE_TO_VERIFY_LEAF_SIGNATURE: "UNABLE_TO_VERIFY_LEAF_SIGNATURE"
    },
    // https://www.ibm.com/docs/en/zos/2.5.0?topic=service-retrieve-zosmf-information
    VERSIONS: {
        V2R1: "24",
        V2R2: "25",
        V2R3: "26",
        V2R4: "27",
        V2R5: "28",
        V3R1: "29",
    }
};
/**
 * Object containing all options to be used by the Download data set API
 */
exports.ZosFilesOptions = {
    /**
     * The files timeout header value
     * @type {ICommandOptionDefinition}
     */
    responseTimeout: {
        name: "response-timeout",
        aliases: ["rto"],
        description: "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",
        type: "number",
        defaultValue: undefined,
        // eslint-disable-next-line @typescript-eslint/no-magic-numbers
        numericValueRange: [5, 600]
    }
};
//# sourceMappingURL=Zosmf.constants.js.map