/rubrik-sdk-for-powershell

Rubrik Module for PowerShell

Primary LanguagePowerShellMIT LicenseMIT

Rubrik SDK for PowerShell

Build status

This is a community project that provides a Microsoft PowerShell module for managing and monitoring Rubrik's Cloud Data Management fabric by way of published RESTful APIs. If you're looking to perform interactive automation, setting up scheduled tasks, leverage an orchestration engine, or need ad-hoc operations, this module is intended to be valuable to your needs.

🔨 Installation

Load the module by using:

Import-Module Rubrik

If you wish to load a specific version, use:

Import-Module Rubrik -RequiredVersion #.#.#.#

Where #.#.#.# represents the version number.

🔍 Example

The Rubrik SDK for PowerShell provides two mechanisms for supplying credentials to the Connect-Rubrik function. A combination of username and password or a credential object. Credentials in the credential object may be entered manually or provided as an object. The example below prompts for a username and password to create a credential object, connects to a cluster and displays the running version.

$Credential = Get-Credential
Connect-Rubrik -Server 192.168.10.10 -Credential $Credential
Get-RubrikVersion

📘 Documentation

Here are some resources to get you started! If you find any challenges from this project are not properly documented or are unclear, please raise an issue and let us know! This is a fun, safe environment - don't worry if you're a GitHub newbie! ❤️

Additional Links

💪 How You Can Help

We glady welcome contributions from the community. From updating the documentation to adding more functions, all ideas are welcome. Thank you in advance for all of your issues pull requests, and comments! ⭐

Important Note

As we continue to improve our Community PowerShell module we have begun work on the next version of the module. As we are working on refactoring the module we will focus our attention on the refactor branch. As a result of this code rewrite we are focussed on the rubrik-sdk-for-powershell/Refactor branch. We do still take issues and pull requests but we are mostly focussed on bug fixes in the existing branch.

Moving forward

We will continue to support the issues and pull requests coming in, but for the 4.0 version of the module we will focus on bug fixes and security risks. New features and functionality will be implemented in the refactored 4.1 release of the module. If you have any questions in regards to this feel free to reach out to us.

📌 License

👉 About Rubrik Build

We encourage all contributors to become members. We aim to grow an active, healthy community of contributors, reviewers, and code owners. Learn more in our Welcome to the Rubrik Build Community page.

We'd love to hear from you! Email us: build@rubrik.com 💌