# ansibrest

> RESTify Ansible playbook

Latest version **1.1.2** (published 2016-12-07) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install ansibrest
pnpm add ansibrest
yarn add ansibrest
bun add ansibrest
```

Provides the command `ansibrest`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2016-12-07 |
| First published | 2016-03-06 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 14 |
| Known vulnerabilities | 0 (+5 in 3 direct dependencies) |
| Install scripts | no |
| Author | muddydixon |
| Maintainers | muddydixon |
| Keywords | ansible, rest, api server |

## Links

- npm: https://www.npmjs.com/package/ansibrest
- npm.io page: https://npm.io/package/ansibrest

## Dependencies (14)

- [debug](https://npm.io/package/debug.md) ^2.2.0
- [log4js](https://npm.io/package/log4js.md) ^0.6.31
- [express](https://npm.io/package/express.md) ^4.13.4
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.5.3
- [fs-extra](https://npm.io/package/fs-extra.md) ^1.0.0
- [bootstrap](https://npm.io/package/bootstrap.md) ^3.3.6
- [commander](https://npm.io/package/commander.md) ^2.9.0
- [socket.io](https://npm.io/package/socket.io.md) ^1.5.1
- [body-parser](https://npm.io/package/body-parser.md) ^1.15.0
- [create-error](https://npm.io/package/create-error.md) ^0.3.1
- [font-awesome](https://npm.io/package/font-awesome.md) ^4.5.0
- [node-ansible](https://npm.io/package/node-ansible.md) ^0.5.5
- [serve-static](https://npm.io/package/serve-static.md) ^1.10.2
- [cookie-parser](https://npm.io/package/cookie-parser.md) ^1.4.1

## Recent versions

- 1.1.2 (latest) — 2016-12-07
- 1.1.1 — 2016-11-15
- 1.1.0 — 2016-11-10
- 1.0.0 — 2016-03-06

## README

<img src="./public/images/ansibrest.png" width="48"> Ansibrest - Ansible REST Server
-----

## Abstract

Start REST Server to execute local ansible.

## How to use

```
% npm install ansibrest -g
% ansibrest -h

  Usage: ansibrest [options]

  Options:

    -h, --help                         output usage information
    -p,--port <PORT>                   PORT
    --endpoint <ENDPOINT>              ENDPOINT
    --ansible-path <ANSIBLE_PATH>      ANSIBLE_PATH
    --inventory-path <INVENTORY_PATH>  INVENTORY_PATH
```

## Dockerize

```
docker run -d -p 2400:2400 -v $ANSIBLE_PATH:/opt/ansible muddydixon/ansibrest
docker run -d -p 2400:2400 -v $YOURANSIBRRESTFILE:/opt/ansibrest/.ansibrest \
                           -v $ANSIBLE_PATH:/opt/ansible \
                           muddydixon/ansibrest
```


## Contribute

```
% npm install -g git://github.com/muddydixon/ansibrest.git
% cd someproject/
% ls -l
ansible/
% ls ansible
sample1.yml sample2.yml inventories/
% ansibrest --ansible-path ./ansible --inventory-path inventories
% curl -X POST -d "host=samplehost001" -d "startAt=Some Task" "http://localhost:8080/api/playbook/sample1.yml"
```

## Screens

### Top
<img src="./public/images/top.png" width="512" />

### Playbook Tasks
<img src="./public/images/playbook.png" width="512" />

### Config
<img src="./public/images/config.png" width="512" />

### Execute Playbook
<img src="./public/images/execute.png" width="512" />

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