# hubot-ibmcloud-virtualserver

> hubot for IBM Cloud Virtual Server interactions

Latest version **0.0.25** (published 2016-09-02) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install hubot-ibmcloud-virtualserver
pnpm add hubot-ibmcloud-virtualserver
yarn add hubot-ibmcloud-virtualserver
bun add hubot-ibmcloud-virtualserver
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.25 |
| Published | 2016-09-02 |
| First published | 2016-08-01 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 4.2.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 0 |
| Author | ibm-cloud-solutions |
| Maintainers | ibmmobilecloud |
| Keywords | hubot, hubot-scripts, bluemix, cloud, slack, ibm, ibm cloud |

## Links

- npm: https://www.npmjs.com/package/hubot-ibmcloud-virtualserver
- Repository: https://github.com/ibm-cloud-solutions/hubot-ibmcloud-virtualserver
- Homepage: https://github.com/ibm-cloud-solutions/hubot-ibmcloud-virtualserver#readme
- Issues: https://github.com/ibm-cloud-solutions/hubot-ibmcloud-virtualserver/issues
- npm.io page: https://npm.io/package/hubot-ibmcloud-virtualserver

## Dependencies (1)

- [pkgcloud](https://npm.io/package/pkgcloud.md) ^1.3.0

## Recent versions

- 0.0.25 (latest) — 2016-09-02
- 0.0.24 — 2016-08-26
- 0.0.23 — 2016-08-02
- 0.0.22 — 2016-08-01

## README

[![Build Status](https://travis-ci.org/ibm-cloud-solutions/hubot-ibmcloud-virtualserver.svg?branch=master)](https://travis-ci.org/ibm-cloud-solutions/hubot-ibmcloud-virtualserver)
[![Coverage Status](https://coveralls.io/repos/github/ibm-cloud-solutions/hubot-ibmcloud-virtualserver/badge.svg?branch=master)](https://coveralls.io/github/ibm-cloud-solutions/hubot-ibmcloud-virtualserver?branch=master)
[![Dependency Status](https://dependencyci.com/github/ibm-cloud-solutions/hubot-ibmcloud-virtualserver/badge)](https://dependencyci.com/github/ibm-cloud-solutions/hubot-ibmcloud-virtualserver)
[![npm](https://img.shields.io/npm/v/hubot-ibmcloud-virtualserver.svg?maxAge=2592000)](https://www.npmjs.com/package/hubot-ibmcloud-virtualserver)

# hubot-ibmcloud-virtualserver

Script package that exposes various IBM Cloud Virtual Server functionality through Hubot.

## Getting Started
  * [Usage](#usage)
  * [Commands](#commands)
  * [Hubot Adapter Setup](#hubot-adapter-setup)
  * [Cognitive Setup](#cognitive-setup)
  * [Development](#development)
  * [License](#license)
  * [Contribute](#contribute)

## Usage

If you are new to Hubot visit the [getting started](https://hubot.github.com/docs/) content to get a basic bot up and running.  Next, follow these steps for adding this external script into your hubot:

1. `cd` into your hubot directory
2. Install this package via `npm install hubot-ibmcloud-virtualserver --save`
3. Add `hubot-ibmcloud-virtualserver` to your `external-scripts.json`
4. Add the necessary environment variables:
```
HUBOT_BLUEMIX_API=<Bluemix API URL>
HUBOT_BLUEMIX_ORG=<Bluemix Organization>
HUBOT_BLUEMIX_SPACE=<Bluemix space>
HUBOT_BLUEMIX_USER=<Bluemix User ID>
HUBOT_BLUEMIX_PASSWORD=<Password for the Bluemix use>
HUBOT_VIRTUAL_SERVER_REGION=<Bluemix Virtual Server region, OS_REGION_NAME in rcfile>
HUBOT_VIRTUAL_SERVER_AUTH_URL=<Bluemix Virtual Server authentication url, OS_AUTH_URL in rcfile>
HUBOT_VIRTUAL_SERVER_DOMAIN_NAME=<Bluemix Virtual Server domain name, OS_USER_DOMAIN_NAME in rcfile>
```
_Note_: for virtual server related variables, follow [this](https://console.ng.bluemix.net/docs/virtualmachines/vm_setup_os_clients.html#vm_download_rcfile) to get [rcfile](http://docs.openstack.org/developer/python-openstackclient/index.html).

5. Start up your bot & off to the races!


## Commands

- `hubot virtual server delete|destroy|remove [virtualserver]` - Deletes a virtual server.
- `hubot virtual server list|show` - Lists all of the virtual servers.
- `hubot virtual server reboot [virtualserver]` - Restarts the virtual server.
- `hubot virtual server start [virtualserver]` - Starts the virtual server.
- `hubot virtual server stop [virtualserver]` - Stops the virtual server.
- `hubot virtual server help` - Show available virtual server commands.

## Hubot Adapter Setup

Hubot supports a variety of adapters to connect to popular chat clients.  For more feature rich experiences you can setup the following adapters:
- [Slack setup](https://github.com/ibm-cloud-solutions/hubot-ibmcloud-space-management/blob/master/docs/adapters/slack.md)
- [Facebook Messenger setup](https://github.com/ibm-cloud-solutions/hubot-ibmcloud-space-management/blob/master/docs/adapters/facebook.md)

## Cognitive Setup

This project supports natural language interactions using Watson and other Bluemix services.  For more information on enabling these features, refer to [Cognitive Setup](https://github.com/ibm-cloud-solutions/hubot-ibmcloud-nlc/blob/master/docs/cognitiveSetup.md).

## Development

Please refer to the [CONTRIBUTING.md](https://github.com/ibm-cloud-solutions/hubot-ibmcloud-space-management/blob/master/CONTRIBUTING.md) before starting any work.  Steps for running this script for development purposes:

### Configuration Setup

1. Create `config` folder in root of this project.
2. Create `env` in the `config` folder, with the following contents:
```
export HUBOT_BLUEMIX_API=<Bluemix API URL>
export HUBOT_BLUEMIX_ORG=<Bluemix Organization>
export HUBOT_BLUEMIX_SPACE=<Bluemix space>
export HUBOT_BLUEMIX_USER=<Bluemix User ID>
export HUBOT_BLUEMIX_PASSWORD=<Password for the Bluemix use>
export HUBOT_VIRTUAL_SERVER_REGION=<Bluemix Virtual Server region, OS_REGION_NAME in rcfile>
export HUBOT_VIRTUAL_SERVER_AUTH_URL=<Bluemix Virtual Server authentication url, OS_AUTH_URL in rcfile>
export HUBOT_VIRTUAL_SERVER_DOMAIN_NAME=<Bluemix Virtual Server domain name, OS_USER_DOMAIN_NAME in rcfile>
```
_Note_: for virtual server related variables, follow [these directions](https://console.ng.bluemix.net/docs/virtualmachines/vm_setup_os_clients.html#vm_download_rcfile) to get [rcfile](http://docs.openstack.org/developer/python-openstackclient/index.html)

3. In order to view content in chat clients you will need to add `hubot-ibmcloud-formatter` to your `external-scripts.json` file. Additionally, if you want to use `hubot-help` to make sure your command documentation is correct. Create `external-scripts.json` in the root of this project, with the following contents:
```
[
	"hubot-help",
	"hubot-ibmcloud-formatter"
]
```
4. Lastly, run `npm install` to obtain all the dependent node modules.

### Running Hubot with Adapters

Hubot supports a variety of adapters to connect to popular chat clients.

If you just want to use:
 - Terminal: run `npm run start`
 - [Slack: link to setup instructions](https://github.com/ibm-cloud-solutions/hubot-ibmcloud-space-management/blob/master/docs/adapters/slack.md)
 - [Facebook Messenger: link to setup instructions](https://github.com/ibm-cloud-solutions/hubot-ibmcloud-space-management/blob/master/docs/adapters/facebook.md)

## License

See [LICENSE.txt](https://github.com/ibm-cloud-solutions/hubot-ibmcloud-space-management/blob/master/LICENSE.txt) for license information.

## Contribute

Please check out our [Contribution Guidelines](https://github.com/ibm-cloud-solutions/hubot-ibmcloud-space-management/blob/master/CONTRIBUTING.md) for detailed information on how you can lend a hand.

---
_Source: https://npm.io/package/hubot-ibmcloud-virtualserver · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
