lsi-soar

1.9.1 • Public • Published

LSI SOAR management utility

Usage: soar [options] [command]

Options:
  -v, --version      version of the soar application
  -f, --force        force action
  --deploy           deploy local file 'soar --deploy <file>'
  --uid              output unique system identifier (UID)
  --user <username>  username for server operations
  --pass <password>  password for server operations
  --token <token>    use token credentials
  --plain            raw ascii output (no ansi)
  --main             assign as main console window
  --hide             hide main console window
  --show             show main console window
  -h, --help         output usage information

Commands:
  alias              alias a package with a name
  bind               bind soar data source to a specific url
  build [options]    build and archive nodejs module/application
  config             show module configuration
  ctl [options]      control NATS-capable application
  fetch [options]    install package from a remote url
  hostname           display or change hostname
  publish            publish file to server via scp
  purge [options]    purge all modules and data folders
  reboot             initiate reboot
  remove             remove module
  restart            restart modules started as services
  run [options]      run packages
  set [options]      change package setting
  start [options]    run all packages toggled to autostart
  stop               run packages
  update [options]   update all installed modules
  upgrade [options]  upgrade SOAR utility
  • alias - create an alias for module with a specific version (i.e. transcend -> transcend-v1.0.0); alias allows creation of arbitrary identifiers that can later target different packages or different versions of packages (useful for managing and testing different versions of the same module)
  • start - starts all installed modules that have been selected for autostart; works like a supervisor - will restart a module if module exists. Use set <module> autostart <true|false> to enable or disable autostart flag.
  • stop - stop all installed modules that are running under start mode
  • bind - binds SOAR utility to a specific server URL to be used as a remote module repository.
  • build - runs a build process for a module; specify module GitHub repository, name in pre-configured repository (using soar set soar git <github URL>); produces a ZIP file containing the module build in ~/.soar/.build/
  • config - prints config data in JSON
  • ctl - allows control of modules via NATS
  • fetch - downloads and installs a specific module; use soar fetch to get a list of available modules; module listing/availability is platform-specific.
  • publish - uploads specific file via scp to a pre-configured destination server; use soar set publish <scp address> to configure destination server and folder (typically user@fqdn:.soar/downloads/)
  • purge - deletes the entire .soar folder, while preserving the SOAR config file; can be used to purge all installed modules as well as temporary files and everything else stored in the ~/.soar folder.
  • reboot - reboots the target system
  • remove - delete a specific installed module and related aliases
  • run - run a specific module (usually supplied via an alias name soar run transcend)
  • set - sets module settings; use: soar set <module|alias> <property> <value>; use --force | -f to create options for modules that are not present on the system.
  • update - update all modules to latest versions available on the server
  • upgrade - self-upgrade (download and install latest version of the SOAR utility directly from the server (not via NPM))

Readme

Keywords

none

Package Sidebar

Install

npm i lsi-soar

Weekly Downloads

4

Version

1.9.1

License

Proprietary

Unpacked Size

2.89 MB

Total Files

27

Last publish

Collaborators

  • aspect