Solarwinds NPM

SolarWinds Node.js

The Node.js library and CLI for the Solarwinds API.

Configuration

This library/cli uses the following environment variables:

Env Variable	Description
SOLARWINDS_USERNAME	Username of SolarWinds API user.
SOLARWINDS_PASSWORD	Password of SolarWinds API user.
SOLARWINDS_HOSTNAME	Name of host where SolarWinds API is installed, e.g `solarwinds.example.com`
SOLARWINDS_PORT	Port of SolarWinds API, default is `17778`.

Install

$ npm install -g solarwinds

CLI Usage

  Usage: solarwinds [options] [command]


  Commands:

    node           Nodes monitored by SolarWinds.
    vm             Virtual machines accessible by SolarWinds.
    app-template   Application templates.
    credential     Credentials.

  Options:

    -h, --help     output usage information
    -V, --version  output the version number

Nodes

Nodes monitored by SolarWinds. NODE can be a node id or a hostname.

  Usage: solarwinds node [options] [command]


  Commands:

    list|ls                    lists all available nodes
    inspect <NODE>             displays detailed information about a node
    unmanage [options] <NODE>  Unmanages a node for a duration
    remanage <NODE>            remanage node by id of hostname

  Options:

    -h, --help  output usage information

node create

  Usage: solarwinds node create [options]

  Create a node

  Options:

    -h, --help           output usage information
    --name <value>       Node name
    --hostname <value>   Node host name for polling. Has to be resolvable by DNS
    --community [value]  Community string (default '')
    --ip <value>         IP address

node list

  Usage: solarwinds node list|ls [options]

  List all available nodes

  Options:

    --filter <value>  Filter output based on conditions provided
    -h, --help        output usage information

Filtering

The filtering flag format is "key=value".

The currently supported filters are:

id
name
hostname
ip

node inspect

  Usage: solarwinds node inspect [options] <NODE>

  Displays detailed information about a node

  Options:

    -h, --help  output usage information

node unmanage

  Usage: solarwinds node unmanage [options] <NODE>

  Unmanage a node for a duration

  Options:

    -h, --help              output usage information
    -d, --duration <value>  Duration, for example 15s, 30m, 3h or 1d

node remanage

  Usage: solarwinds node remanage [options] <NODE>

  Remanage node by id of hostname

  Options:

    -h, --help  output usage information

node remove

  Usage: solarwinds node remove|rm [options] <NODE>

  Remove node

  Options:

    -h, --help  output usage information

Application Templates

Application templates. APPTEMPLATE can be a application template id or a name.

  Usage: solarwinds app-template [options] [command]


  Commands:

    list|ls                List all application templates
    inspect <APPTEMPLATE>  Display detailed information about an application template

  Options:

    -h, --help  output usage information

app-template list

  Usage: solarwinds app-template list|ls [options]

  List all application templates

  Options:

    -h, --help  output usage information

app-template inspect

  Usage: solarwinds app-template inspect [options] <APPTEMPLATE>

  Display detailed information about an application template

  Options:

    -h, --help  output usage information

Credentials

Credentials. CREDENTIAL can be a credential id or a name.

  Usage: solarwinds credential [options] [command]


  Commands:

    list|ls               List all credentials
    inspect <CREDENTIAL>  Display detailed information about a credential

  Options:

    -h, --help  output usage information

credential list

  Usage: solarwinds credential list|ls [options]

  List all credentials

  Options:

    -h, --help  output usage information

credential inspect

  Usage: solarwinds credential inspect [options] <CREDENTIAL>

  Display detailed information about a credential

  Options:

    -h, --help  output usage information

Virtual Machines

Virtual machines accessible by SolarWinds. VM can be a vm id or a vm name.

  Usage: solarwinds vm [options] [command]

  Commands:

  list|ls       List all available virtual machines
  inspect <VM>  Display detailed information about a virtual machine

  Options:

  -h, --help  output usage information

vm list

  Usage: solarwinds vm list|ls [options]

  List all available virtual machines

  Options:

    --filter <value>  Filter output based on conditions provided
    -h, --help        output usage information

Filtering

The filtering flag format is "key=value".

The currently supported filters are:

id
name
ip

vm inspect

  Usage: solarwinds vm inspect [options] <VM>

  Display detailed information about a virtual machine

  Options:

  -h, --help  output usage information

Library Usage

This library by default uses the environment variables specified above that can be overwritten:

import SolarWinds from 'solarwinds'

const solarwinds = new SolarWinds('username', 'password', 'url')
...
const nodes = await solarwinds.nodes.query()