Rubrik SDK for PowerShell
This is a community project that provides a Microsoft PowerShell module for managing and monitoring Rubrik's Multi-Cloud Data Control 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, for example 5.3.1
🔌 Connection
The Rubrik SDK for PowerShell provides multiple mechanisms for supplying credentials to the Connect-Rubrik function; in particular we highlight here 2 methods:
- Using a credential object.
Credentials in the credential object may be entered manually or provided as an object.
This 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-RubrikDebugInfo
- Using a service account ID and secret.
Example:
This connects to Rubrik cluster utilizing a service account ID and secret, and displays the running version.
Connect-Rubrik -Server 192.168.10.10 -Id "Service Account ID" -Secret "Service Account Secret" Get-RubrikDebugInfo
📘 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
- VIDEO: Getting Started with the Rubrik SDK for PowerShell
- BLOG: Get-Started with the Rubrik PowerShell Module
- BLOG: Using Automation to Validate Applications and Services in Rubrik Backups
- BLOG: PowerShell and RESTful APIs - Making Backup Awesome Again
💪 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! ⭐
📌 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: [email protected] 💌