VMUG - Mastering PowerShell to Call RESTful API Endpoints
2 likes2,506 views
This document discusses how to use PowerShell to call RESTful API endpoints. It provides an overview of the key concepts needed to get started, including using the Invoke-WebRequest and Invoke-RestMethod cmdlets to make requests. It also covers authentication, endpoints, resources, HTTP methods, and includes sample code for basic authentication. The document promotes learning PowerShell to access REST APIs as an easy way to integrate disparate systems.
![Sample Basic Auth Code for PowerShell
$auth =
[System.Convert]::ToBase64String([System.Text.Encoding]:
:UTF8.GetBytes($Username + “:” + $Password))
$header =
@{“Authorization”=“Basic $auth”}
36](https://image.slidesharecdn.com/rubrik-masteringpowershelltocallrestfulapiendpoints-151110164532-lva1-app6891/85/VMUG-Mastering-PowerShell-to-Call-RESTful-API-Endpoints-36-320.jpg)
VMUG - Mastering PowerShell to Call RESTful API Endpoints
- 1. Mastering PowerShell To Call RESTful API Endpoints
- 2. Who is @ChrisWahl? VMware Certified Design Expert (VCDX) #104 Data Center Virtualization (DCV) Network Virtualization (NV)
- 3. 3 Technical Blog WahlNetwork.com Networking for VMware Administrators Over 30 hours of video training Pluralsight.com Datanauts – Busting IT Silos DatanautsPodcast.com Internet Resources
- 4. Networking for VMware Administrators 100% of royalties are being donated to the Alzheimer’s Association
- 5. 5
- 6. Can I Get The Deck? Yes. Yes you can.
- 7. 7 Why should you care?
- 8. 8 Why Should You Care?
- 9. 9 Rise of the generalist! Why Should You Care?
- 10. 10 Make disparate systems work together (fun) Why Should You Care?
- 11. 11 Feed your hungry orchestration engines Why Should You Care?
- 12. 12 Make buckets of cash Why Should You Care?
- 13. 13 It’s really easy to learn Why Should You Care?
- 14. 14 The ecosystem has done most of the work Why Should You Care?
- 15. 15 But, most of all …
- 16. 16
- 19. 19 PowerShell Version 4 … or better
- 21. Console The command line interface Microsoft.PowerShell_profile.ps1 ISE Integrated Scripting Environment Microsoft.PowerShellISE_profile.ps1 Console + ISE profile.ps1 Profiles make life easier and happier Set up your profile
- 22. Current User: %USERPROFILE%DocumentsWindowsPowerShell All Users: %WINDIR%System32WindowsPowerShellv1.0 Profiles make life easier and happier Drop in your profile
- 23. Set-ExecutionPolicy Bypass Set-Location C:DropboxCode if ($psISE) { Start-Steroids Clear-Host Write-Host 'BEAST MODE (╯°□°)╯︵ ┻━┻' } Write yourself fun messages Self motivation for the win!
- 24. Set-ExecutionPolicy Bypass Set-Location C:DropboxCode if ($psISE) { Start-Steroids Clear-Host Write-Host 'BEAST MODE (╯°□°)╯︵ ┻━┻' } Write yourself fun messages Self motivation for the win!
- 27. 27 Everyone who knows something today… Didn’t know it yesterday
- 28. 28 Let’s dig into the code
- 29. Cmdlets for Calling a RESTful API • Invoke-WebRequest – Returns the entire response – Status, headers, body content, etc. • Invoke-RestMethod – Returns only the content from the response 29
- 30. Endpoints (and Resources) • Endpoints are expressed as URIs – Uniform Resource Identifier – Example endpoint: https://the.device.url/system/version – Used to access a resource • Should be published somewhere – If not, harass the vendor 30
- 31. 31
- 32. Methods • Actions taken upon a resource – GET – PUT – POST – DELETE – PATCH 32
- 33. Methods • Actions taken upon a resource – GET data from a resource – PUT to create resources – POST to update a resource – DELETE to remove a resource – PATCH to update parts of a resource 33
- 34. Authentication • Verify your identity – Basic auth (fairly common) – Oauth – Oauth2 34
- 35. Authentication • Did you know? – Basic auth uses Base64 encoding + SSL – Encoding = reversible – Thus, name and password are plain text • Encryption is provided by SSL – SSL is “optional” but … it really isn’t – Don’t call endpoints with HTTP! 35
- 36. Sample Basic Auth Code for PowerShell $auth = [System.Convert]::ToBase64String([System.Text.Encoding]: :UTF8.GetBytes($Username + “:” + $Password)) $header = @{“Authorization”=“Basic $auth”} 36
- 37. 37 Cmdlet Format / Usage
- 38. 38 Invoke-WebRequest ` -Uri something.urlvmlist ` -Method Get ` -Headers $header Cmdlet
- 39. 39 Invoke-WebRequest ` -Uri something.urlvmlist ` -Method Get ` -Headers $header Resource / Endpoint
- 40. 40 Invoke-WebRequest ` -Uri something.urlvmlist ` -Method Get ` -Headers $header Method
- 41. 41 Invoke-WebRequest ` -Uri something.urlvmlist ` -Method Get ` -Headers $headerAuthentication
- 45. 45
- 46. 46
- 47. 47 What can I do with this? Protecting Applications with Rubrik
- 50. 50 Policy{SLA
- 51. 51 Recovery Point Objective (RPO) Availability Duration (Retention) When to Archive (RTO) Replication Schedule (DR) {SLA
- 52. 52
- 53. Associate Policy to vSphere Objects 53 vCenter Server VM VM VM VM VM VM VM VM Silver SLA Gold SLA Bronze SLA
- 54. 54 End-to-End Data Management Primary Data Center DR Site/Offsite VM VM VM VM VM VM Hypervisor Production Servers SAN VM VM VM VM VM VM Hypervisor DR Servers Rubrik Backup Software + Dedupe Storage Rubrik Replication & DR Offsite + Long Term Archive
- 55. 55 Free Code as Examples
- 56. Community PowerShell Module GitHub PowerShell-Module Repository – https://github.com/rubrikinc/PowerShell-Module PowerShell Gallery (NuGet) – https://www.powershellgallery.com/packages/Rubrik – Install-Module -Name Rubrik 56
- 57. vRealize Orchestrator (vRO) Package GitHub vRO-Workflow Repository – https://github.com/rubrikinc/vRO-Workflow – Visit the Wiki for a full walkthrough! 57