-
Notifications
You must be signed in to change notification settings - Fork 86
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Invoke RubrikRESTCall #118
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,101 @@ | ||
function Invoke-RubrikRESTCall { | ||
<# | ||
.SYNOPSIS | ||
Provides generic interface to make Rubrik REST API calls | ||
|
||
.DESCRIPTION | ||
The Invoke-RubrikRESTCall allows users to make raw API endpoint calls to the Rubrik REST interface. The user | ||
will need to manage the format of both the endpoint call(including resource ids) and body, but provides the | ||
option to make cmdlet independent API calls for automating Rubrik actions through PowerShell. The Rubrik API | ||
reference is found on the Rubrik device at: | ||
<Rubrik IP>/docs/v1 | ||
<Rubrik IP>/docs/v1/playground | ||
|
||
.NOTES | ||
Written by Matt Altimar & Mike Fal for community usage | ||
Twitter: @Mike_Fal | ||
GitHub: mikefal | ||
|
||
.LINK | ||
https://github.com/rubrikinc/PowerShell-Module | ||
|
||
.EXAMPLE | ||
Invoke-RubrikRESTCall -Endpoint 'vmware/vm' -Method GET | ||
|
||
Retrieve the raw output for all VMWare VMs being managed by the Rubrik device. | ||
|
||
.EXAMPLE | ||
Invoke-RubrikRESTCall -Endpoint 'vmware/vm' -Method GET -Query (New-Object -TypeName PSObject -Property @{'name'='msf-sql2016'}) | ||
|
||
Retrieve the raw output for the VMWare VM msf-sql2016 using a query parameter. | ||
|
||
.EXAMPLE | ||
$body = New-Object -TypeName PSObject -Property @{'slaID'='INHERIT';'ForceFullSnapshot'='FALSE'} | ||
Invoke-RubrikRESTCall -Endpoint 'vmware/vm/VirtualMachine:::fbcb1f51-9520-4227-a68c-6fe145982f48-vm-649/snapshot' -Method POST -Body $body | ||
|
||
Execute an on-demand snapshot for the VMWare VM where the id is part of the endpoint. | ||
#> | ||
|
||
[cmdletbinding()] | ||
Param ( | ||
#Rubrik API endpoint, DO NOT USE LEADING '/' | ||
[Parameter(Mandatory = $true,HelpMessage = 'REST Endpoint')] | ||
[ValidateNotNullorEmpty()] | ||
[System.String]$Endpoint, | ||
#REST API method | ||
[Parameter(Mandatory = $true,HelpMessage = 'REST Method')] | ||
[ValidateSET('GET','PUT','PATCH','DELETE','POST','HEAD','OPTIONS')] | ||
[System.String]$Method, | ||
#Hash table body to pass to API call | ||
[Parameter(Mandatory = $false,HelpMessage = 'REST Content')] | ||
[ValidateNotNullorEmpty()] | ||
[psobject]$Query, | ||
#Hash table body to pass to API call | ||
[Parameter(Mandatory = $false,HelpMessage = 'REST Content')] | ||
[ValidateNotNullorEmpty()] | ||
[psobject]$Body, | ||
# Rubrik server IP or FQDN | ||
[String]$Server = $global:RubrikConnection.server, | ||
# API version | ||
[ValidateNotNullorEmpty()] | ||
[String]$api = $global:RubrikConnection.api | ||
) | ||
BEGIN | ||
{ | ||
#connect to Rubrik if not already connected | ||
Test-RubrikConnection | ||
} | ||
|
||
PROCESS | ||
{ | ||
#execute REST operation | ||
try { | ||
#construct uri | ||
[string]$uri = New-URIString -server $Server -endpoint "/api/$api/$Endpoint" | ||
|
||
#If query object, add query parameters to URI | ||
if($query) | ||
{ | ||
$querystring = @() | ||
foreach($q in $query.PSObject.Properties) | ||
{ | ||
$querystring += "$($q.name)=$($q.Value)" | ||
} | ||
$uri = New-QueryString -query $querystring -uri $uri | ||
} | ||
|
||
#If Method is not a GET call and a REST Body is passed, build the JSON body | ||
if($Method -ne 'GET' -and $body){ | ||
[string]$JsonBody = $Body | ConvertTo-Json | ||
} | ||
Write-Verbose "URI string: $uri" | ||
|
||
$result = Submit-Request -uri $uri -header $Header -method $Method -body $JsonBody | ||
} | ||
catch { | ||
throw $_ | ||
} | ||
|
||
return $result | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Curious why this change was required?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Due to the change made to line 15 for the Invoke-WebRequest. The original version was locked into whatever the $resources item was. I needed Submit-Request to not be dependent on the $resources collection (be more generic). However, to maintain the functionality I changed the method to default to $resources.Method .