@f5devcentral/f5-cloud-libs/scripts/commonOptions.js

/**
 * Copyright 2016-2018 F5 Networks, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

'use strict';

const options = require('commander');

/**
 * @module
 */
module.exports = {
    /**
     * Gets common options used by all scripts.
     *
     * @returns {Object} An instance of commander options on which one can add options and call parse()
     */
    getCommonOptions(defaultLogFile) {
        options.reboot = true;
        options.port = 443;

        /* eslint-disable max-len */
        return options
            .version('4.23.0-beta.3')
            .option(
                '--host <ip_address>',
                'Device management IP to which to send commands.'
            )
            .option(
                '-u, --user <user>',
                'Device admin user name. Default is to create a temporary user (this only works when running on the device).'
            )
            .option(
                '-p, --password [password]',
                'Device admin user password. Use this or --password-url. One of these is required when specifying the user.'
            )
            .option(
                '--password-url [password_url]',
                'URL (file, http(s)) to location that contains device admin user password. Use this or --password. One of these is required when specifying the user.'
            )
            .option(
                '--password-encrypted',
                'Indicates that the password is encrypted (either with encryptDataToFile or generatePassword)'
            )
            .option(
                '--port <port>',
                'device management SSL port to connect to. Default 443.'
            )
            .option(
                '--no-reboot',
                'Skip reboot even if it is recommended.'
            )
            .option(
                '--background',
                'Spawn a background process to do the work. If you are running in cloud init, you probably want this option.'
            )
            .option(
                '--signal <signal>',
                'Signal to send when done. Default ONBOARD_DONE.'
            )
            .option(
                '--wait-for <signal>',
                'Wait for the named signal before running.'
            )
            .option(
                '--log-level <level>',
                'Log level (none, error, warn, info, verbose, debug, silly). Default is info.', 'info'
            )
            .option(
                '-o, --output <file>',
                `Log to file as well as console. This is the default if background process is spawned. Default is ${defaultLogFile}`
            )
            .option(
                '-e, --error-file <file>',
                'Log exceptions to a specific file. Default is /tmp/cloudLibsError.log, or cloudLibsError.log in --output file directory'
            )
            .option(
                '--no-console',
                'Do not log to console. Default false (log to console).'
            );
        /* eslint-enable max-len */
    }
};