Merge pull request #702 from rubrikinc/5.2-release

5.2 documentation release pull to Devel

Rubrik/Rubrik.psd1

@@ -3,7 +3,7 @@
 #
 # Generated by: Jaap Brasser
 #
-# Generated on: 2020/09/07
+# Generated on: 2020/11/17
 #
 
 @{
@@ -353,7 +353,7 @@
             # ReleaseNotes = ''
 
             # Prerelease string of this module
-            Prerelease = 'devel687'
+            # Prerelease = ''
 
             # Flag to indicate whether the module requires explicit user acceptance for install/update
             # RequireLicenseAcceptance = $false

azure-pipelines/scripts/docs.ps1

@@ -1,22 +1,28 @@
 # Import Module
 Import-Module .\Rubrik\Rubrik.psd1 -Force
+# $localpath = 'C:\temp\rubrik-sdk-for-powershell'
 
 # Create new markdown and XML help files
 Write-Output 'Building new function documentation'
 
-$MarkdownFiles = New-MarkdownHelp -Module Rubrik -OutputFolder "$env:LocalPath\docs\command-documentation\reference\" -Force | Measure-Object | Select-Object -ExpandProperty Count
-Write-Output "Created $MarkdownFiles markdown help files in '$env:LocalPath\docs\command-documentation\reference\'"
+$MarkdownFiles = New-MarkdownHelp -Module Rubrik -OutputFolder "$env:localpath\docs\command-documentation\reference\" -Force | Measure-Object | Select-Object -ExpandProperty Count
+Write-Output "Created $MarkdownFiles markdown help files in '$env:localpath\docs\command-documentation\reference\'"
 
-$ExternalHelp = New-ExternalHelp -Path "$env:LocalPath\docs\command-documentation\reference\" -OutputPath "$env:LocalPath\Rubrik\en-US\" -Force
-Write-Output "Created $($ExternalHelp.Name) external help file in '$env:LocalPath\Rubrik\en-US\'"
+Get-ChildItem $env:localpath\docs\command-documentation\reference\ -Exclude .\README.md |
+Where-Object {$_.name -cne $_.name.tolower()} | ForEach-Object {
+    Rename-Item -Path "$env:localpath\docs\command-documentation\reference\$($_.Name)" -NewName $_.Name.ToLower()
+}
+
+$ExternalHelp = New-ExternalHelp -Path "$env:localpath\docs\command-documentation\reference\" -OutputPath "$env:localpath\Rubrik\en-US\" -Force
+Write-Output "Created $($ExternalHelp.Name) external help file in '$env:localpath\Rubrik\en-US\'"
 
 # Custom Generate Summary.md
 Write-Output 'Generate custom markdown SUMMARY.md'
 $MarkDown = "# Rubrik SDK for PowerShell`n`n"
 $MarkDown += "## User Documentation`n`n"
 
 # Documentation folder
-Get-ChildItem -LiteralPath "$env:LocalPath\docs\user-documentation" | ForEach-Object -Process {
+Get-ChildItem -LiteralPath "$env:localpath\docs\user-documentation" | ForEach-Object -Process {
     $Reference = switch ($_.BaseName) {
         'Requirements' {'Requirements'}
         'Installation' {'Installation'}
@@ -37,7 +43,7 @@ Get-ChildItem -LiteralPath "$env:LocalPath\docs\user-documentation" | ForEach-Ob
 $MarkDown += "## Command Documentation`n`n"
 
 # Workflow folder
-Get-ChildItem -LiteralPath "$env:LocalPath\docs\command-documentation\workflow" | ForEach-Object -Begin {
+Get-ChildItem -LiteralPath "$env:localpath\docs\command-documentation\workflow" | ForEach-Object -Begin {
     $MarkDown += "* [Workflow](command-documentation/workflow/readme.md)`n"
 } -Process {
     $Reference = switch ($_.BaseName) {
@@ -50,15 +56,22 @@ Get-ChildItem -LiteralPath "$env:LocalPath\docs\command-documentation\workflow"
         $MarkDown += "    * [$Reference]($uri)`n"
     }
 } -End {
-    $MarkDown += "`n"
+    # $MarkDown += "`n"
 }
 
 # Reference folder
-Get-ChildItem -LiteralPath "$env:LocalPath\docs\command-documentation\reference" | ForEach-Object -Begin {
+Get-ChildItem -LiteralPath "$env:localpath\docs\command-documentation\reference" | ForEach-Object -Begin {
     $MarkDown += "* [Reference](command-documentation/reference/readme.md)`n"
 } -Process {
     $Reference = switch ($_.BaseName) {
-        default {$_}
+        default {
+            try {
+                $CurrentTry = $_
+                ((Get-Content $env:localpath\Rubrik\Public\$_.ps1 -ErrorAction Stop) -match "function $_" -split '\s')[1]
+            } catch {
+                $CurrentTry
+            }
+        }
     }
     $uri = "command-documentation/$($_.Directory.BaseName)/$($_.Name)"
 
@@ -68,7 +81,7 @@ Get-ChildItem -LiteralPath "$env:LocalPath\docs\command-documentation\reference"
 }
 
 # Write Markdown to file
-Set-Content -Value $MarkDown -Path "$env:LocalPath\docs\SUMMARY.md"
+Set-Content -Value $MarkDown -Path "$env:localpath\docs\SUMMARY.md"
 
 # End message
 Write-Output 'Completed GitBook documentation generation'

docs/SUMMARY.md

@@ -30,6 +30,7 @@
     * [Get-RubrikArchive](command-documentation/reference/get-rubrikarchive.md)
     * [Get-RubrikAvailabilityGroup](command-documentation/reference/get-rubrikavailabilitygroup.md)
     * [Get-RubrikBackupServiceDeployment](command-documentation/reference/get-rubrikbackupservicedeployment.md)
+    * [Get-RubrikBlackout](command-documentation/reference/get-rubrikblackout.md)
     * [Get-RubrikBootStrap](command-documentation/reference/get-rubrikbootstrap.md)
     * [Get-RubrikClusterInfo](command-documentation/reference/get-rubrikclusterinfo.md)
     * [Get-RubrikClusterNetworkInterface](command-documentation/reference/get-rubrikclusternetworkinterface.md)
@@ -104,6 +105,10 @@
     * [Get-RubrikVCDTemplateExportOption](command-documentation/reference/get-rubrikvcdtemplateexportoption.md)
     * [Get-RubrikVCenter](command-documentation/reference/get-rubrikvcenter.md)
     * [Get-RubrikVersion](command-documentation/reference/get-rubrikversion.md)
+    * [Get-RubrikVgfAutoUpgrade](command-documentation/reference/get-rubrikvgfautoupgrade.md)
+    * [Get-RubrikVgfClusterStorage](command-documentation/reference/get-rubrikvgfclusterstorage.md)
+    * [Get-RubrikVgfReport](command-documentation/reference/get-rubrikvgfreport.md)
+    * [Get-RubrikVgfUpgradeReport](command-documentation/reference/get-rubrikvgfupgradereport.md)
     * [Get-RubrikVM](command-documentation/reference/get-rubrikvm.md)
     * [Get-RubrikVMSnapshot](command-documentation/reference/get-rubrikvmsnapshot.md)
     * [Get-RubrikVMwareCluster](command-documentation/reference/get-rubrikvmwarecluster.md)
@@ -114,6 +119,7 @@
     * [Get-RubrikVolumeGroupMount](command-documentation/reference/get-rubrikvolumegroupmount.md)
     * [Invoke-RubrikGraphQLCall](command-documentation/reference/invoke-rubrikgraphqlcall.md)
     * [Invoke-RubrikRESTCall](command-documentation/reference/invoke-rubrikrestcall.md)
+    * [Invoke-RubrikVgfUpgrade](command-documentation/reference/invoke-rubrikvgfupgrade.md)
     * [Move-RubrikMountVMDK](command-documentation/reference/move-rubrikmountvmdk.md)
     * [New-RubrikAPIToken](command-documentation/reference/new-rubrikapitoken.md)
     * [New-RubrikBootStrap](command-documentation/reference/new-rubrikbootstrap.md)
@@ -191,6 +197,7 @@
     * [Set-RubrikNutanixVM](command-documentation/reference/set-rubriknutanixvm.md)
     * [Set-RubrikOrgAuthorization](command-documentation/reference/set-rubrikorgauthorization.md)
     * [Set-RubrikProxySetting](command-documentation/reference/set-rubrikproxysetting.md)
+    * [Set-RubrikReport](command-documentation/reference/set-rubrikreport.md)
     * [Set-RubrikSetting](command-documentation/reference/set-rubriksetting.md)
     * [Set-RubrikSLA](command-documentation/reference/set-rubriksla.md)
     * [Set-RubrikSQLInstance](command-documentation/reference/set-rubriksqlinstance.md)
@@ -199,6 +206,7 @@
     * [Set-RubrikUserRole](command-documentation/reference/set-rubrikuserrole.md)
     * [Set-RubrikVCD](command-documentation/reference/set-rubrikvcd.md)
     * [Set-RubrikVCenter](command-documentation/reference/set-rubrikvcenter.md)
+    * [Set-RubrikVgfAutoUpgrade](command-documentation/reference/set-rubrikvgfautoupgrade.md)
     * [Set-RubrikVM](command-documentation/reference/set-rubrikvm.md)
     * [Set-RubrikVolumeFilterDriver](command-documentation/reference/set-rubrikvolumefilterdriver.md)
     * [Start-RubrikDownload](command-documentation/reference/start-rubrikdownload.md)
@@ -211,4 +219,4 @@
     * [Update-RubrikNutanixCluster](command-documentation/reference/update-rubriknutanixcluster.md)
     * [Update-RubrikVCD](command-documentation/reference/update-rubrikvcd.md)
     * [Update-RubrikVCenter](command-documentation/reference/update-rubrikvcenter.md)
-    * [Update-RubrikVMwareVM](command-documentation/reference/update-rubrikvmwarevm.md)
+    * [Update-RubrikVMwareVM](command-documentation/reference/update-rubrikvmwarevm.md)

docs/command-documentation/reference/get-rubrikblackout.md

@@ -0,0 +1,78 @@
+---
+external help file: Rubrik-help.xml
+Module Name: Rubrik
+online version: https://rubrik.gitbook.io/rubrik-sdk-for-powershell/command-documentation/reference/get-rubrikblackout
+schema: 2.0.0
+---
+
+# Get-RubrikBlackout
+
+## SYNOPSIS
+The Get-RubrikBlackout cmdlet will retrieve cluster blackout windows information
+
+## SYNTAX
+
+```
+Get-RubrikBlackout [[-Server] <String>] [[-api] <String>] [<CommonParameters>]
+```
+
+## DESCRIPTION
+The Get-RubrikBlackout cmdlet will retrieve cluster blackout windows information
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+Get-RubrikBlackout
+```
+
+This will return whether or not Global Blackout is active on the currently connected cluster
+
+## PARAMETERS
+
+### -Server
+Rubrik server IP or FQDN
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 1
+Default value: $global:RubrikConnection.server
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -api
+API version
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 2
+Default value: $global:RubrikConnection.api
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+## OUTPUTS
+
+## NOTES
+Written by Jaap Brasser for community usage
+Twitter: @jaap_brasser
+GitHub: jaapbrasser
+
+## RELATED LINKS
+
+[https://rubrik.gitbook.io/rubrik-sdk-for-powershell/command-documentation/reference/get-rubrikblackout](https://rubrik.gitbook.io/rubrik-sdk-for-powershell/command-documentation/reference/get-rubrikblackout)
+

docs/command-documentation/reference/get-rubrikdatabasemount.md

@@ -14,8 +14,8 @@ Connects to Rubrik and retrieves details on mounts for a SQL Server Database
 
 ```
 Get-RubrikDatabaseMount [-Id <String>] [-SourceDatabaseId <String>] [-SourceDatabaseName <String>]
- [-TargetInstanceId <String>] [[-MountedDatabaseName] <String>] [-Server <String>] [-api <String>]
- [<CommonParameters>]
+ [-TargetInstanceId <String>] [[-MountedDatabaseName] <String>] [-DetailedObject] [-Server <String>]
+ [-api <String>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -33,26 +33,33 @@ This will return details on all mounted databases.
 
 ### EXAMPLE 2
 ```
+Get-RubrikDatabaseMount -DetailedObject
+```
+
+This will return mounted databases with the full detailed objects.
+
+### EXAMPLE 3
+```
 Get-RubrikDatabaseMount -id '11111111-2222-3333-4444-555555555555'
 ```
 
 This will return details on mount id "11111111-2222-3333-4444-555555555555".
 
-### EXAMPLE 3
+### EXAMPLE 4
 ```
 Get-RubrikDatabaseMount -source_database_id (Get-RubrikDatabase -HostName FOO -Instance MSSQLSERVER -Database BAR).id
 ```
 
 This will return details for any mounts found using the id value from a database named BAR on the FOO default instance.
 
-### EXAMPLE 4
+### EXAMPLE 5
 ```
 Get-RubrikDatabaseMount -source_database_name BAR
 ```
 
 This returns any mounts where the source database is named BAR.
 
-### EXAMPLE 5
+### EXAMPLE 6
 ```
 Get-RubrikDatabaseMount -mounted_database_name BAR_LM
 ```
@@ -136,6 +143,22 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -DetailedObject
+DetailedObject will retrieved the detailed DatabaseMount object, the default behavior of the API is to only retrieve a subset of the full DatabaseMount object unless we query directly by ID.
+Using this parameter does affect performance as more data will be retrieved and more API-queries will be performed.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -Server
 Rubrik server IP or FQDN