RubyDoc.info: File: README – Documentation for nexpose-security-console (0.0.2)

For security engineers who needs to interact with a Rapid7 Nexpose console, the nexpose-security-console gem is a Git like command line utility that manage (e.g. create, list, update, and remove) the following entities: - sites, - scans, - assets, - asset groups, - reports, - vulnerabilities - etc…

Personal scratch

I need to delete ~ 100 thousands assets from a group asset. The web GUI only allows to delete 500 at a time. Hence, nexpose-security-console was born.

Installation

From Ruby Gems

Simply run the command below

$ gem install nexpose-security-console

From source code

If you have access to the Internet, obtain the source code from Github repository.
```
$ git clone https://github.com/rhc/nexpose-security-console.git
```
Access the source code folder directory.
```
$ cd nexpose-security-console
```
Install the dependencies
```
$ bin/setup
```
Install the gem in your local machine
```
$ bundle exec rake install
```
Run the test suite
```
$ rake test
```

Usage

You can get help on available commands.

$ nsc help

Commands:
  nsc --version, -v   # Print the version
  nsc help [COMMAND]  # Describe available commands or one specific command

Configuration

# ~/lab.yaml consists of the following:

config:
   server: 10.10.10.10
   port: 3780
   user: nxuser
   password: password

License

The gem is available as open source under the terms of the MIT License.