ZertoApiWrapper.psd1
|
# # Module manifest for module 'ZertoApiWrapper' # # Generated by: Wes Carroll # # Generated on: 04/10/2020 # @{ # Script module or binary module file associated with this manifest. RootModule = 'ZertoApiWrapper.psm1' # Version number of this module. ModuleVersion = '1.4.0.20200410' # Supported PSEditions # CompatiblePSEditions = @() # ID used to uniquely identify this module GUID = '4c0b9e17-141b-4dd5-8549-fb21cccaa325' # Author of this module Author = 'Wes Carroll' # Company or vendor of this module CompanyName = 'Zerto' # Copyright statement for this module Copyright = '(c) 2020 Wes Carroll. All rights reserved.' # Description of the functionality provided by this module Description = 'Windows PowerShell and PowerShell Core API Wrapper Module for Zerto Virtual Manager' # Minimum version of the PowerShell engine required by this module PowerShellVersion = '5.1.0' # Name of the PowerShell host required by this module # PowerShellHostName = '' # Minimum version of the PowerShell host required by this module # PowerShellHostVersion = '' # Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only. # DotNetFrameworkVersion = '' # Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only. # ClrVersion = '' # Processor architecture (None, X86, Amd64) required by this module # ProcessorArchitecture = '' # Modules that must be imported into the global environment prior to importing this module # RequiredModules = @() # Assemblies that must be loaded prior to importing this module # RequiredAssemblies = @() # Script files (.ps1) that are run in the caller's environment prior to importing this module. # ScriptsToProcess = @() # Type files (.ps1xml) to be loaded when importing this module # TypesToProcess = @() # Format files (.ps1xml) to be loaded when importing this module # FormatsToProcess = @() # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess # NestedModules = @() # Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export. FunctionsToExport = 'Add-ZertoPeerSite', 'Checkpoint-ZertoVpg', 'Connect-ZertoAnalytics', 'Connect-ZertoServer', 'Copy-ZertoVpg', 'Disconnect-ZertoServer', 'Edit-ZertoVra', 'Export-ZertoVmNicSetting', 'Export-ZertoVpg', 'Get-ZAAlert', 'Get-ZADatastore', 'Get-ZAEvent', 'Get-ZAJournalAverageHistory', 'Get-ZAJournalAverageSize', 'Get-ZAJournalBreach', 'Get-ZAJournalHistoryStat', 'Get-ZAJournalSiteAverageHistory', 'Get-ZAJournalSiteAverageSize', 'Get-ZAJournalSiteHistoryStat', 'Get-ZAJournalSiteHistorySummary', 'Get-ZAJournalSiteSizeStat', 'Get-ZAJournalStatusProportion', 'Get-ZAJournalStorageStat', 'Get-ZAJournalSummary', 'Get-ZALicense', 'Get-ZAMonitoring', 'Get-ZANetworkSiteAverageIOPS', 'Get-ZANetworkSiteAveragePerformance', 'Get-ZANetworkSiteStat', 'Get-ZANetworkSiteSummary', 'Get-ZANetworkVpgAverageIOPS', 'Get-ZANetworkVpgAveragePerformance', 'Get-ZANetworkVpgStat', 'Get-ZANetworkVpgSummary', 'Get-ZAPlannerJournalSizeReport', 'Get-ZAPlannerNetworkPerformanceReport', 'Get-ZAPlannerSite', 'Get-ZAPlannerStatsReport', 'Get-ZAPlannerWanReport', 'Get-ZAPlannerZcasReport', 'Get-ZAProtectedVm', 'Get-ZAProtectedVmReport', 'Get-ZARPOAccountAverage', 'Get-ZARPOAverage', 'Get-ZARPOBreach', 'Get-ZARPOStat', 'Get-ZARPOStatusProportion', 'Get-ZARPOSummary', 'Get-ZASite', 'Get-ZASitePair', 'Get-ZASiteTopology', 'Get-ZATask', 'Get-ZAVolume', 'Get-ZAVpg', 'Get-ZAzOrg', 'Get-ZertoAlert', 'Get-ZertoDatastore', 'Get-ZertoEvent', 'Get-ZertoLicense', 'Get-ZertoLocalSite', 'Get-ZertoPeerSite', 'Get-ZertoProtectedVm', 'Get-ZertoRecoveryReport', 'Get-ZertoResourcesReport', 'Get-ZertoServiceProfile', 'Get-ZertoTask', 'Get-ZertoUnprotectedVm', 'Get-ZertoVirtualizationSite', 'Get-ZertoVolume', 'Get-ZertoVpg', 'Get-ZertoVpgSetting', 'Get-ZertoVra', 'Get-ZertoZorg', 'Get-ZertoZsspSession', 'Import-ZertoVmNicSetting', 'Import-ZertoVpg', 'Install-ZertoVra', 'Invoke-ZARestRequest', 'Invoke-ZertoEvacuateVra', 'Invoke-ZertoFailover', 'Invoke-ZertoFailoverCommit', 'Invoke-ZertoFailoverRollback', 'Invoke-ZertoForceSync', 'Invoke-ZertoMove', 'Invoke-ZertoMoveCommit', 'Invoke-ZertoMoveRollback', 'Invoke-ZertoRestRequest', 'New-ZertoPairingToken', 'New-ZertoVpg', 'New-ZertoVpgSettingsIdentifier', 'Remove-ZertoPeerSite', 'Remove-ZertoVpg', 'Remove-ZertoVpgSettingsIdentifier', 'Resume-ZertoVpg', 'Save-ZertoVpgSetting', 'Set-ZertoAlert', 'Set-ZertoLicense', 'Set-ZertoUserCredential', 'Start-ZertoCloneVpg', 'Start-ZertoFailoverTest', 'Stop-ZertoCloneVpg', 'Stop-ZertoFailoverTest', 'Suspend-ZertoVpg', 'Uninstall-ZertoVra' # Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export. CmdletsToExport = @() # Variables to export from this module # VariablesToExport = @() # Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export. AliasesToExport = @() # DSC resources to export from this module # DscResourcesToExport = @() # List of all modules packaged with this module # ModuleList = @() # List of all files packaged with this module # FileList = @() # Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell. PrivateData = @{ PSData = @{ # Tags applied to this module. These help with module discovery in online galleries. Tags = 'Zerto', 'Automation' # A URL to the license for this module. LicenseUri = 'https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/LICENSE' # A URL to the main website for this project. ProjectUri = 'https://github.com/ZertoPublic/ZertoApiWrapper' # A URL to an icon representing this module. # IconUri = '' # ReleaseNotes of this module ReleaseNotes = '# 1.4.0.20200410 ### Zerto Virtual Manager * Addressed a reported [issue](https://github.com/ZertoPublic/ZertoApiWrapper/issues/60) in the `Get-ZertoRecoveryReport` function where the `-VpgIdentifier` parameter was not working. This parameter is not accepted by the API as a valid filter and is ignored. This parameter has been removed from the function. * Addressed a reported [issue](https://github.com/ZertoPublic/ZertoApiWrapper/issues/61) where the `Export-ZertoVpgNicSetting` function would not properly execute when run against a VM with no NICs attached. * In reviewing the `Export-ZertoVpgNicSetting`, a review of the `Import-ZertoVpgNicSetting` was completed and it was determined to update the import logic based on various test cases. Along with this, it is now possible to reset the NIC settings to the default state with the `Import-ZertoVpgNicSetting` command. Please review the [Import-ZertoVpgNicSetting help](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Import-ZertoVmNicSetting.md) to review the updated options and import logic. * Refactored the `Checkpoint-ZertoVpg` command to allow pipeline input (ByValue and ByProperty) for the VpgName parameter. * Corrected a parameter typo in the `Get-ZertoVpgSetting` function. The misspelt parameter was added as an alias to ensure any existing scripts using the parameter continue to function. * Refactored the `Get-ZertoVpg` command to remove repetitive commands and variables that are no longer required. * Moved `Invoke-ZertoRestRequest` and `Invoke-ZARestRequest` to be public functions. As there become more and more scenarios where there are not prebuilt functions to accomplish complex specialized tasks, it became apparent that these functions could be leveraged to make the experience and workflow easier. * Updated the `Install-ZertoVra` logic to ensure that the target datastore is available on the target host. There isn''t currently any method to validate the target network, but if that becomes available in a later version of the API, the function will be updated. * Updated the `Install-ZertoVra` function to allow for installation of the VRA using the host password method. Please review the [Install-ZertoVra](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Install-ZertoVra.md) documentation for syntax and examples. * Updated the `Edit-ZertoVra` function to allow for modification of the associated ESX host password if the need arises. Please review the [Edit-ZertoVra](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Edit-ZertoVra.md) documentation for syntax and examples. * Added a new function, `Set-ZertoUserCredential`, to allow the updating of the username and password used to connect the Zerto Virtual Manager to the paired hypervisor. Please see the [Set-ZertoUserCredential](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Set-ZertoUserCredential.md) help for additional information. * With the release of [Zerto 8.0](https://www.zerto.com/zerto-8-0-general-availability/) some additional API endpoints have become available. * Updated `Get-ZertoVirtualizationSite` to add the `-repository` parameter to enable returning information for LTR repositories. * Updated `Get-ZertoVpgSetting` to add the `-ltr` parameter to enable returning information for current LTR settings for the selected VPG. ### Zerto Analytics * Added several functions for the newly added [Zerto Analytics](https://analytics.zerto.com) Planner. * `Get-ZAPlannerSite` Help can be found here: [Get-ZAPlannerSite](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAPlannerSite.md) * `Get-ZAPlannerStatsReport` Help can be found here: [Get-ZAPlannerStatsReport](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAPlannerStatsReport.md) * `Get-ZAPlannerJournalSizeReport` Help can be found here: [Get-ZAPlannerJournalSizeReport](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAPlannerJournalSizeReport.md) * `Get-ZAPlannerNetworkPerformanceReport` Help can be found here: [Get-ZAPlannerNetworkPerformanceReport](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAPlannerNetworkPerformanceReport.md) * `Get-ZAPlannerWanReport` Help can be found here: [Get-ZAPlannerWanReport](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAPlannerWanReport.md) * `Get-ZAPlannerZcasReport` Help can be found here: [Get-ZAPlannerZcasReport](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAPlannerZcasReport.md) * Created `Get-ZAProtectedVm` and `Get-ZAProtectedVmReport` functions to leverage the newly released Zerto Analytics APIs for this data. Help files can be found here: [Get-ZAProtectedVm](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAProtectedVm.md) and [Get-ZAProtectedVmReport](https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZAProtectedVmReport.md) ' # Prerelease string of this module # Prerelease = '' # Flag to indicate whether the module requires explicit user acceptance for install/update/save # RequireLicenseAcceptance = $false # External dependent modules of this module # ExternalModuleDependencies = @() } # End of PSData hashtable } # End of PrivateData hashtable # HelpInfo URI of this module # HelpInfoURI = '' # Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix. # DefaultCommandPrefix = '' } |