Git Product home page Git Product logo

powervra's Introduction

Build status

Welcome to PowervRA

PowervRA is a PowerShell module built on top of the services exposed by the vRealize Automation 7 REST API.

Note: this module is not in any way developed or supported by anyone officially affiliated with VMware

Compatibility

vRealize Automation

6.2.4* 7.0 7.0.1 7.1 7.2 7.3
  • Support for 6.2.4 is limited given API restrictions. Functions which don't support 6.2.4 will exit early and cleanly.

PowerShell Editions

Edition Version
Desktop 5.1
Core 6.0.0-rc**

To get up and running with PowerShell Core follow the instructions for your operating system here.

Download

PowerShell v5.1 & v6 users: You grab the latest version of the module from the PowerShell Gallery by running the following command:

Install-Module -Name PowervRA -Scope CurrentUser

Quick Start

Once you have installed and imported PowervRA, use Connect-vRAServer to connect to your vRA instance:

Connect-vRAServer -Server vra.corp.local -Tenant tenant01 -Credential (Get-Credential)

If your instance has a self signed certificate you must use the IgnoreCertRequirements switch:

Connect-vRAServer -Server vra.corp.local -Tenant tenant01 -Credential (Get-Credential) -IgnoreCertRequirements

Running Locally

When developing, use the provided build script and import the module that is inside the Release directory.

You do not have to manually edit src\PowervRA.psd1 when adding new functions

# --- Run the build script
.\tools\build.ps1

# --- Import release module
Import-Module .\Release\PowervRA\PowervRA.psd1 -Force

The default build will run some quick tests to catch any errors before you push your changes.

Documentation

Documentation for each command can be viewed with Get-Help, e.g.:

Get-Help Get-vRAEntitlement

Alternatively check out our Read the Docs site

Updating the documentation

To update the documentation you first need to ensure that the local module manifest is updated with any new functions

.\tools\build.ps1 -Task UpdateModuleManifest

Once complete you can run the UpdateDocumentation task to create new markdown files and update any existing ones.

.\tools\build.ps1 -Task UpdateDocumentation

The changes can then be committed back to the repository. Once pushed, they will be reflected in ReadTheDocs.

powervra's People

Contributors

chelnak avatar jonathanmedd avatar sammcgeown avatar kclinden avatar otabut avatar blackcatdeployment avatar jmedd-ats avatar thitho007 avatar basvinken avatar skunkie avatar stevio54 avatar jimpallomeni avatar mponton avatar destroy-everything avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.