Quick Start
Compatibility
rbkcli is compatible with any combination of the following:
OS:
Linux
Mac
Windows
Python:
python-2.7.16
python-3.5.6
python-3.6.9
python-3.7.3
Requirements
Before starting the installation make sure you match the following requirements
Python (2.7, 3.5-3.7)
pip (Python's package indexer)
setuptools (Python module that automates modules installation)
In order to install setuptools package you can run the following command:
For more information on how to install Python for each platform please visit: Python Software Foundation
Tutorials
Installation
Option 1:
Install from source, by downloading rbkcli with GitHub link: https://github.com/rubrikinc/rbkcli.git
Option 2: 1. Install from Python Package Index, with pip:
Post install: 1. Enable auto-complete (only for bash environments):
Configuring target
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
You can also specify a token to be used in the authentication by exporting the following environment variable, but it is not required:
rubrik_cdm_token
Linux
So for Linux/Mac systems the commands to be run would be:
Windows
For windows systems the commands to be run would be:
The token will take precedence over username/password authentication, once the token expires rbkcli will default back to username and password if provided.
Example
Once the above environment variables are exported, rbkcli will dynamically create the command line based on the available APIs in that cluster.
At this point all rbkcli features should be available, including auto-complete.
Package version and removal
In case you want to verify the version of rbkcli package currently installed, run the following:
This will return all Python packages installed in your environment, you can use a command line modifier to filter rbkcli packages:
Linux
You can use grep in Linux to filter for rbkcli package:
Windows
You can use find in Windows to filter for rbkcli package:
In order to uninstall rbkcli you can run the following:
You can also remove the profile files created by rbkcli run-time, by removing folder ~/rbkcli
More information
For more information about rbkcli tool and its features go to:
For complete rbkcli usage and feature documentation go to:
To discuss any subject related to rbkcli got to Rubrik Support Portal Forums:
To provide any feedback or ask any questions, you can also send and email to rbkcli@rubrik.com
Last updated