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

Start commenting code and help messages

Browse Source
This commit is contained in:
Wes Carroll
2019-02-22 22:17:47 -05:00
parent 9fd116b36f
commit 5e2e4a0c1b
6 changed files with 124 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ZertoApiWrapper/Public/Get-ZertoAlert.ps1
+63 -13
View File
@@ -1,31 +1,76 @@
function Get-ZertoAlert {
[cmdletbinding( defaultParameterSetName = "main" )]
param(
[Parameter( ParameterSetName = "alertId", Mandatory = $true, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true )]
[Parameter(
ParameterSetName = "alertId",
Mandatory = $true,
ValueFromPipeline = $true,
ValueFromPipelineByPropertyName = $true ,
HelpMessage = "AlertId or array of AlertIds to be queried"
)]
[string[]]$alertId,
[Parameter( ParameterSetName = "entities", Mandatory = $true )]
[Parameter(
ParameterSetName = "entities",
Mandatory = $true,
HelpMessage = "Switch to return the entities information from the API"
)]
[switch]$entities,
[Parameter( ParameterSetName = "helpIdentifiers", Mandatory = $true )]
[Parameter(
ParameterSetName = "helpIdentifiers",
Mandatory = $true,
HelpMessage = "Switch to get the Help Identifiers information from the API"
)]
[switch]$helpIdentifiers,
[Parameter( ParameterSetName = "levels", Mandatory = $true )]
[Parameter(
ParameterSetName = "levels",
Mandatory = $true,
HelpMessage = "Switch to return Alert Levels information from the API"
)]
[switch]$levels,
[Parameter( ParameterSetName = "filter" )]
[Parameter(
ParameterSetName = "filter",
HelpMessage = "Returns Alerts after the Start Date. Provide the string in the format of 'yyyy-MM-ddTHH:mm:ss.fff'"
)]
[string]$startDate,
[Parameter( ParameterSetName = "filter" )]
[Parameter(
ParameterSetName = "filter",
HelpMessage = "Returns Alerts before the End Date. Provide the string in the format of 'yyyy-MM-ddTHH:mm:ss.fff'"
)]
[string]$endDate,
[Parameter( ParameterSetName = "filter" )]
[Parameter(
ParameterSetName = "filter",
HelpMessage "Returns alerts for the specified vraIdentifier"
)]
[string]$vpgIdentifier,
[Parameter( ParameterSetName = "filter" )]
[Parameter(
ParameterSetName = "filter",
HelpMessage = "Returns alerts for the specified siteIdentifier"
)]
[string]$siteIdentifier,
[Parameter( ParameterSetName = "filter" )]
[Parameter(
ParameterSetName = "filter",
HelpMessage = "Returns alerts for the specified zorgIdentifier"
)]
[string]$zorgIdentifier,
[Parameter( ParameterSetName = "filter" )]
[Parameter(
ParameterSetName = "filter",
HelpMessage = "Returns alerts for the specified level"
)]
[string]$level,
[Parameter( ParameterSetName = "filter" )]
[Parameter(
ParameterSetName = "filter",
HelpMessage = "Returns alerts for the specified helpIdentifier"
)]
[string]$helpIdentifier,
[Parameter( ParameterSetName = "filter" )]
[Parameter(
ParameterSetName = "filter",
HelpMessage = "Returns alerts for the specified entity"
)]
[string]$entity,
[Parameter( ParameterSetName = "filter" )]
[Parameter(
ParameterSetName = "filter",
HelpMessage = "Returns alerts that are dismissed"
)]
[switch]$isDismissed
)
@@ -35,12 +80,15 @@ function Get-ZertoAlert {
}
process {
# Select the operation based on the ParameterSetName
switch ( $PSCmdlet.ParameterSetName ) {
# If called without any parameters, return all alerts
"main" {
$uri = "{0}" -f $baseUri
$returnObject = Invoke-ZertoRestRequest -uri $uri
}
# If called with the alertId ParameterSetName, build an object that contains all alerts for alertIds specified
"alertId" {
$returnObject = foreach ( $id in $alertId ) {
$uri = "{0}/{1}" -f $baseUri, $alertId
@@ -48,12 +96,14 @@ function Get-ZertoAlert {
}
}
# If called with the filter ParameterSetName, get a filter string and get results from API.
"filter" {
$filter = Get-ZertoApiFilter -filterTable $PSBoundParameters
$uri = "{0}{1}" -f $baseUri, $filter
$returnObject = Invoke-ZertoRestRequest -uri $uri
}
# If any other ParameterSetName is called, build URI based on ParameterSetName and submit
default {
$uri = "{0}/{1}" -f $baseUri, $PSCmdlet.ParameterSetName.ToLower()
$returnObject = Invoke-ZertoRestRequest -uri $uri