Update documentation

jakkulabs · Dec 26, 2017 · 233ccf8 · 233ccf8
1 parent e7dc2c6
commit 233ccf8
Show file tree

Hide file tree

Showing 5 changed files with 184 additions and 48 deletions.
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -1,4 +1,27 @@
-# Version 2.2.0
+# Version 3.0.0
+## Breaking Changes
+**WARNING: This release contains breaking changes**
+* The minmum supported PowerShell Versions have been raised to the following:
+  * Windows PowerShell: 5.1
+  * PowerShell Core: 6.0.0-rc**
+
+## Features
+* Feature - Add ability to select SSL Protocol (#159)
+* Feature - Single PSM1 file to speed up load times
+* Feature - Add -Wait Parameter to Request-vRAResourceAction (@Thitho007)
+
+## Fixes
+* Fixed #134 - Issue with double quotes in some functions
+* Fixed #135 - Some private functions are being exported
+* Fixed #137 - Help examples for Get-vRAResource are incorrect
+* Fixed #148 - Request-vRAResourceAction Example Correction
+* Fixed #149 - Support Reservation Type change from 'vSphere' to 'vSphere (vCenter)' in vRA 7.3
+* Fixed #151 - Get-vRAReservationPolicy
+* Fixed #153 - New-vRAReserveration Error
+* Fixed #130 - Unable to connect after removing SSLv3/TLSv1 ciphers from vRA Appliance
+
+# Version 2.2.0
+
 ## Features
 * Feature - Remove Network Path from reservation #43
 * Feature - Add -Debug capability for New / Set functions #78
@@ -7,9 +30,11 @@
 * Feature - Add function to invoke data collection #127
 
 ## Fixes
-* Fixed #124 - xRequires does not work as expected when executed in a Begin block
-
-# Version 2.1.0
+* Fixed #124 - xRequires does not work as expected when executed in a Begin block
+
+
+# Version 2.1.0
+
 ## Breaking changes
 * Functions that take a Password parameter now require a SecureString #106
   * **Connect-vRAServer** - Now requires a **SecureString** for the Password parameter if you are using a Username/Password combination
@@ -39,8 +64,9 @@
 * Introduces stricter checks in our CI process. The analyze task will now fail on warnings
 * Introduces Pester tests for function help
   * All functions are now required to have at least a synopsis, description, one or more example section(s) and every parameter must have a description.
-* Lots of other fun improvements to our CI and build process - See [here for more information](http://powervra.readthedocs.io/en/latest/build/)
-
+* Lots of other fun improvements to our CI and build process - See [here for more information](http://powervra.readthedocs.io/en/latest/build/)
+
+
 ## Version 2.0.0
 
 * PowerShell Core v6.0.0-alpha.14 Support
@@ -55,5 +81,5 @@
 * Introduction of CHANGELOG.md
 * Pester Test improvements
 * Build improvementss
-* Bugfixes and improvements
-
+* Bugfixes and improvements
+
diff --git a/docs/functions/Connect-vRAServer.md b/docs/functions/Connect-vRAServer.md
@@ -8,12 +8,13 @@ Connect to a vRA Server
 ### Username (Default)
 ```
 Connect-vRAServer -Server <String> [-Tenant <String>] -Username <String> -Password <SecureString>
- [-IgnoreCertRequirements]
+ [-IgnoreCertRequirements] [-SslProtocol <String>]
 ```
 
 ### Credential
 ```
 Connect-vRAServer -Server <String> [-Tenant <String>] -Credential <PSCredential> [-IgnoreCertRequirements]
+ [-SslProtocol <String>]
 ```
 
 ## DESCRIPTION
@@ -125,6 +126,24 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -SslProtocol
+Alternative Ssl protocol to use from the default
+Requires vRA 7.x and above
+Windows PowerShell: Ssl3, Tls, Tls11, Tls12
+PowerShell Core: Tls, Tls11, Tls12
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases: 
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ## INPUTS
 
 ### System.String

diff --git a/docs/functions/Remove-vRAReservationStorage.md b/docs/functions/Remove-vRAReservationStorage.md
@@ -0,0 +1,99 @@
+# Remove-vRAReservationStorage
+
+## SYNOPSIS
+Remove a storage from a reservation
+
+## SYNTAX
+
+```
+Remove-vRAReservationStorage [-Id] <String> [-StoragePath] <String> [-WhatIf] [-Confirm]
+```
+
+## DESCRIPTION
+Remove a storage from a reservation
+
+## EXAMPLES
+
+### -------------------------- EXAMPLE 1 --------------------------
+```
+Get-vRAReservation -Name Reservation01 | Remove-vRAReservationStorage -StoragePath Datastore01
+```
+
+### -------------------------- EXAMPLE 2 --------------------------
+```
+Remove-vRAReservationStorage -Id 8731ceb3-01cd-4dd6-834e-49a9aa8057d8 -StoragePath Datastore01
+```
+
+## PARAMETERS
+
+### -Id
+The id of the reservation
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases: 
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: True (ByPropertyName, ByValue)
+Accept wildcard characters: False
+```
+
+### -StoragePath
+The storage path
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases: 
+
+Required: True
+Position: 2
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -WhatIf
+Shows what would happen if the cmdlet runs.
+The cmdlet is not run.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: wi
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Confirm
+Prompts you for confirmation before running the cmdlet.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: cf
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+## INPUTS
+
+### System.String
+
+## OUTPUTS
+
+## NOTES
+
+## RELATED LINKS
+
diff --git a/docs/index.md b/docs/index.md
@@ -9,68 +9,59 @@ Note: this module is not in any way developed or supported by anyone officially
 
 ### vRealize Automation
 
-* 6.2.4**
-* 7.0
-* 7.0.1
-* 7.1
+|||||||
+| --- | --- | --- | --- | --- | --- |
+|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
-
-#### Desktop
-
-* 4.0
-* 5.0
-* 5.1
+* Support for 6.2.4 is limited given API restrictions. Functions which don't support 6.2.4 will exit early and cleanly.
+* Support for 7.2 and 7.3 has only received minor testing and updates so far
 
-#### Core
+### PowerShell Editions
 
-* 6.0.0-rc**
+|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](https://github.com/PowerShell/PowerShell/blob/master/README.md#get-powershell).
+To get up and running with PowerShell Core follow the instructions for your operating system [here](https://github.com/PowerShell/PowerShell/blob/master/README.md#get-powershell).
 
 ## Download
 
-PowerShell v5 & v6 users: You grab the latest version of the module from the PowerShell Gallery by running the following command:
-
-```
-Install-Module -Name PowervRA
-```
-
-PowerShell v4 users: Try this handy one liner to download and install the module:
-
-```
-(new-object Net.WebClient).DownloadString("https://raw.githubusercontent.com/jakkulabs/PowervRA/master/Get-PowervRA.ps1") | iex
-```
-
-## Docker
-
-As of version 2.0.0 we now have our own [docker image](https://hub.docker.com/r/jakkulabs/powervra/).
-
-Getting started is easy, just run the following commands:
+PowerShell v5.1 & v6 users: You grab the latest version of the module from the PowerShell Gallery by running the following command:
 
 ```
-docker pull jakkulabs/powervra
-docker run --rm -it jakkulabs/powervra
+Install-Module -Name PowervRA -Scope CurrentUser
 ```
 
-For more information see [this readme](docker/README.md).
-
 ## Quick Start
 
 Once you have installed and imported PowervRA, use Connect-vRAServer to connect to your vRA instance:
 
-```
+```PowerShell
 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:
 
-```
+```PowerShell
 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
+
+```PowerShell
+# --- 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.:
@@ -79,4 +70,4 @@ Documentation for each command can be viewed with Get-Help, e.g.:
 Get-Help Get-vRAEntitlement
 ```
 
-Alternatively check out our [Read the Docs site](https://powervra.readthedocs.org/en/latest/ "Title")
+Alternatively check out our [Read the Docs site](https://powervra.readthedocs.org/en/latest/)
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -104,6 +104,7 @@ pages:
     - Remove-vRAReservation : functions/Remove-vRAReservation.md
     - Remove-vRAReservationNetwork : functions/Remove-vRAReservationNetwork.md
     - Remove-vRAReservationPolicy : functions/Remove-vRAReservationPolicy.md
+    - Remove-vRAReservationStorage : functions/Remove-vRAReservationStorage.md
     - Remove-vRARoutedNetworkProfile : functions/Remove-vRARoutedNetworkProfile.md
     - Remove-vRAService : functions/Remove-vRAService.md
     - Remove-vRAStorageReservationPolicy : functions/Remove-vRAStorageReservationPolicy.md