Metadata-Version: 2.1
Name: rbkcli
Version: 1.0.0b0
Summary: A python package that creates a CLI conversion from Rubrik APIs
Home-page: https://github.com/rubrikinc/rbkcli
Author: Bruno Manesco
Author-email: bruno.manesco@rubrik.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: requests
Requires-Dist: Paramiko
Requires-Dist: argcomplete
Requires-Dist: PyYAML
Requires-Dist: urllib3

# rbkcli

This project provides a Command Line Interface (CLI) conversion of Rubrik APIs.
It can be used for both running commands or writing simplified scripts.

## Installation

Install from PyPI:

```
$ pip install rbkcli
$ echo 'eval "$(register-python-argcomplete rbkcli)"' >> ~/.bashrc
```

## Example

By default, the rbkcli will attempt to read the the Rubrik Cluster credentials from the following environment variables:

* `rubrik_cdm_node_ip`
* `rubrik_cdm_username`
* `rubrik_cdm_password`

So the commands to be run would be:

```
$ export rubrik_cdm_node_ip=<IP>
$ export rubrik_cdm_username=<username>
$ export rubrik_cdm_password=<password>
```

Once the above environment variables are exported with the authentication data, *rbkcli* will dynamically create the command line based on the available APIs in that cluster.

```
$ rbkcli cluster me
{
  "acceptedEulaVersion": "0.0",
  "apiVersion": "1",
  "id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
  "latestEulaVersion": "1.1",
  "name": "MyCluster",
  "timezone": {
    "timezone": ""
  },
  "version": "4.2.2-1699"
}
```

## Documentation

* [Quick Start Guide](https://github.com/rubrikinc/rbkcli/blob/master/docs/quick-start.md)
* [rbkcli Documentation](https://rubrik.gitbook.io/rbkcli/)
* [Rubrik API Documentation](https://github.com/rubrikinc/api-documentation)

