Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thecodeteam/viprshell

ViPR PowerShell Module
https://github.com/thecodeteam/viprshell

Last synced: about 2 months ago
JSON representation

ViPR PowerShell Module

Awesome Lists containing this project

README 

        
# ViPRShell 



ViPRShell wraps ViPR REST API calls into PowerShell functions. This is currently intended for Snapshot workflows, but is being extended. You can use the module to retrieve information about 

projects, tenants, volumes, snapshots, hosts, and exports; Create orders for snapshots, exporting snapshots to hosts, mounting snapshots to hosts, and deleting snapshots; Get and set volume and snapshot tags.  



## Installation



Place all contents into your [PowerShell Module folder](https://msdn.microsoft.com/en-us/library/dd878350%28v=vs.85%29.aspx), or use [Import-Module](https://technet.microsoft.com/en-us/library/hh849725.aspx)

It is expected to see Warnings when importing the module, as some non-standard verbs were used in this module to better represent the functionality of certain functions. 

##Usage

This module leverages a ViPR feature called proxy tokens to execute commands. The first thing that will need to be executed once the module is installed is is 'New-ViPRProxyToken'. This will create a token file containing the proxy token. 

You will then need to use the "proxyuser" account to authenticate to ViPR using its credentials and the proxy token created for your desired execution account (using New-ViprProxyUserAuthToken). For scripting, New-ViPRProxyToken will

only need to be ran once per host per ViPR user that will be executing ViPR calls. New-ViprProxyUserAuthToken will need to be executed at least once every 8 hours to authenticate the "proxyuser" account. For more information on proxy tokens and ViPR,

please see [this article](http://www.emc.com/techpubs/vipr/run_rest_api_script_proxy_user-4.htm).



Below is a list of commands that can currently be leveraged by using this module. For help regarding each command, import the module and leverage the 'Get-Help' functionality of PowerShell.

For example, "Get-Help Get-ViPRHost -All" will return a description of the command, the parameters and information about each parameter, as well as examples. 

```

Export-ViPRSnapshot-Order

```

```

Get-ViPRCatalogService

```

```

Get-ViprExportGroup

```

```

Get-ViPRHost

```

```

Get-ViPROrder

```

```

Get-ViPROrderStatus

```

```

Get-ViPRProject

```

```

Get-ViPRSnapshot

```

```

Get-ViPRSnapshots

```

```

Get-ViPRSnapshotTags

```

```

Get-ViPRTenant

```

```

Get-ViPRVolume

```

```

Get-ViPRVolumes

```

```

Get-ViPRVolumeTags

```

```

Mount-ViPRWindowsVolume-Order

```

```

New-ViPRProxyToken

```

```

New-ViprProxyUserAuthToken

```

```

New-ViPRSnapshot-Order

```

```

Remove-ViprSnapshot-Order

```

```

Set-ViPRSnapshotTag

```

```

Set-ViPRVolumeTag

```

```

Unexport-ViPRSnapshot-Order

```

```

Unmount-ViPRWindowsVolume-Order

```

```

Search-ViPRHost

```

```

Search-ViPRFilesystem

```

```

New-ViprFilesystem

```

```

New-ViprSMBShare

```

```

Search-ViprVirtualArray

```

```

Search-ViprFileVirtualPool

```

```

Search-ViprProject

```

```

Get-ViprTask

```

```

Get-ViprTaskStatus

```



##Support

Please file bugs and issues on the Github issues page for this project. This is to help keep track and document everything related to this repo. For general discussions and further support you can join the [EMC {code} Community slack channel](http://community.emccode.com/). Lastly, for questions asked on [Stackoverflow.com](https://stackoverflow.com) please tag them with **EMC**. The code and documentation are released with no warranties or SLAs and are intended to be supported through a community driven process. 



##Contributing

Create a fork of the project into your own repository. Make all your necessary changes and create a pull request with a description on what was added or removed and details explaining the changes in lines of code. If approved, project owners will merge it. You can also contribute by reporting issues/bugs. 



##Licensing

The MIT License (MIT)



Copyright (c) 2015 Brandon Kvarda



Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:



The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.



THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.