zerto/ZertoApiWrapper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Continue writing help messages and comments.

Browse Source
This commit is contained in:
Wes Carroll
2019-02-23 23:15:47 -05:00
parent 22d7bc0de6
commit 80469aafa2
8 changed files with 204 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ZertoApiWrapper/Public/Get-ZertoProtectedVm.ps1
+51 -11
View File
@@ -1,27 +1,63 @@
function Get-ZertoProtectedVm {
[cmdletbinding( DefaultParameterSetName = "main" )]
param (
[Parameter( ParameterSetName = "vmIdentifier", Mandatory = $true, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true )]
[Parameter(
ParameterSetName = "vmIdentifier",
Mandatory = $true,
ValueFromPipeline = $true,
ValueFromPipelineByPropertyName = $true,
HelpMessage = "vmIdentifier(s) for which to return information"
)]
[string[]]$vmIdentifier,
[Parameter( ParameterSetName = "filter" )]
[Parameter(
ParameterSetName = "filter",
HelpMessage = "The name of the VPG which protects the virtual machine."
)]
[string]$vpgName,
[Parameter( ParameterSetName = "filter" )]
[Parameter(
ParameterSetName = "filter",
HelpMessage = "The name of the virtual machine."
)]
[string]$vmName,
[Parameter( ParameterSetName = "filter" )]
[Parameter(
ParameterSetName = "filter",
HelpMessage = "The status of the VPG. Please see Zerto API documentation for possible values."
)]
[string]$status,
[Parameter( ParameterSetName = "filter" )]
[Parameter(
ParameterSetName = "filter",
HelpMessage = "The substatus of the VPG, for example the VPG is in a bitmap sync. For the description of substatuses, refer to the Zerto Virtual Manager Administration Guide. Please see Zerto API documentation for possible values."
)]
[string]$substatus,
[Parameter( ParameterSetName = "filter" )]
[Parameter(
ParameterSetName = "filter",
HelpMessage = "The ZORG for this VPG."
)]
[string]$organizationName,
[Parameter( ParameterSetName = "filter" )]
[Parameter(
ParameterSetName = "filter",
HelpMessage = "The priority specified for the VPG. Possible values are: '0' or 'Low', '1' or 'Medium', '2' or 'High'"
)]
[string]$priority,
[Parameter( ParameterSetName = "filter" )]
[Parameter(
ParameterSetName = "filter",
HelpMessage = "The protected site type. Please see Zerto API documentation for possible values."
)]
[string]$protectedSiteType,
[Parameter( ParameterSetName = "filter" )]
[Parameter(
ParameterSetName = "filter",
HelpMessage = "The recovery site type. Please see Zerto API documentation for possible values."
)]
[string]$recoverySiteType,
[Parameter( ParameterSetName = "filter" )]
[Parameter(
ParameterSetName = "filter",
HelpMessage = "The identifier of the protected site where the VPG virtual machines are protected."
)]
[string]$protectedSiteIdentifier,
[Parameter( ParameterSetName = "filter" )]
[Parameter(
ParameterSetName = "filter",
HelpMessage = "The identifier of the recovery site where the VPG virtual machines are recovered."
)]
[string]$recoverySiteIdentifier
)
@@ -31,12 +67,15 @@ function Get-ZertoProtectedVm {
}
process {
# Select the operation based on the ParameterSetName
switch ( $PSCmdlet.ParameterSetName ) {
# Return all protected VMs if no parameters are requested
"main" {
$returnObject = Invoke-ZertoRestRequest -uri $baseUri
$returnObject.Add($results) | Out-Null
}
# Return information based on the vmIdentifer(s) provided.
"vmIdentifier" {
$returnObject = foreach ( $id in $vmIdentifier ) {
$uri = "{0}/{1}" -f $baseUri, $id
@@ -44,6 +83,7 @@ function Get-ZertoProtectedVm {
}
}
# If a search is requested, build the query string and return values.
"filter" {
$filter = Get-ZertoApiFilter -filterTable $PSBoundParameters
$uri = "{0}{1}" -f $baseUri, $filter