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

Commenting and Helpmessages.

Browse Source
This commit is contained in:
Wes Carroll
2019-02-24 14:09:18 -05:00
parent 0e19b92901
commit 04dba27f0c
2 changed files with 20 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ZertoApiWrapper/Public/Install-ZertoVra.ps1
+16 -10
View File
@@ -1,37 +1,41 @@
function Install-ZertoVra { function Install-ZertoVra {
[cmdletbinding( SupportsShouldProcess = $true )] [cmdletbinding( SupportsShouldProcess = $true )]
param( param(
[Parameter( Mandatory = $true )] [Parameter( Mandatory = $true, HelpMessage = "Host name where the VRA is to be installed." )]
[string]$hostName, [string]$hostName,
[Parameter( Mandatory = $true )] [Parameter( Mandatory = $true, HelpMessage = "Datastore name where the VRA is to be installed." )]
[string]$datastoreName, [string]$datastoreName,
[Parameter( Mandatory = $true )] [Parameter( Mandatory = $true, HelpMessage = "Network name the VRA is to be assigned." )]
[string]$networkName, [string]$networkName,
[Parameter( HelpMessage = "Initial amount of memory to assign to the VRA in GB. Minimum is 1, Maximum is 16" )] [Parameter( HelpMessage = "Initial amount of memory to assign to the VRA in GB. Default is 3, Minimum is 1, Maximum is 16" )]
[ValidateRange(1, 16)] [ValidateRange(1, 16)]
[int]$memoryInGB = 3, [int]$memoryInGB = 3,
[Parameter()] [Parameter( HelpMessage = "Bandwidth group to assign to the VRA. If unspecified will assign to the 'default_group'" )]
[string]$groupName, [string]$groupName,
[Parameter( ParameterSetName = "Dhcp", Mandatory = $true )] [Parameter( ParameterSetName = "Dhcp", Mandatory = $true, HelpMessage = "Assign a DHCP address to the VRA." )]
[switch]$Dhcp, [switch]$Dhcp,
[Parameter( ParameterSetName = "StaticIp", Mandatory = $true )] [Parameter( ParameterSetName = "StaticIp", Mandatory = $true, HelpMessage = "Static IP address to assign to the VRA." )]
[ValidateScript( {$_ -match [IPAddress]$_ })] [ValidateScript( {$_ -match [IPAddress]$_ })]
[string]$vraIpAddress, [string]$vraIpAddress,
[Parameter( ParameterSetName = "StaticIp", Mandatory = $true )] [Parameter( ParameterSetName = "StaticIp", Mandatory = $true, HelpMessage = "Default gateway to assign to the VRA" )]
[ValidateScript( {$_ -match [IPAddress]$_ })] [ValidateScript( {$_ -match [IPAddress]$_ })]
[string]$defaultGateway, [string]$defaultGateway,
[Parameter( ParameterSetName = "StaticIp", Mandatory = $true )] [Parameter( ParameterSetName = "StaticIp", Mandatory = $true, HelpMessage = "Subnetmask to be assigned to the VRA" )]
[ValidateScript( {$_ -match [IPAddress]$_ })] [ValidateScript( {$_ -match [IPAddress]$_ })]
[string]$subnetMask [string]$subnetMask
) )
#TODO - Test to see if VRA already exists! # Build the VRA Name.
$vraName = "Z-VRA-{0}" -f $hostName $vraName = "Z-VRA-{0}" -f $hostName
# If the VRA does not exist, proceed with the installation. If it does exist, bypass and
if ( -not (Get-ZertoVra -vraName $vraName) ) { if ( -not (Get-ZertoVra -vraName $vraName) ) {
# Get identifiers for each item provided by name.
$siteIdentifier = $script:zvmLocalInfo.SiteIdentifier $siteIdentifier = $script:zvmLocalInfo.SiteIdentifier
$hostIdentifier = Get-ZertoVirtualizationSite -siteIdentifier $siteIdentifier -hosts | Where-Object {$_.VirtualizationHostName -eq $hostName} | Select-Object hostIdentifier -ExpandProperty hostIdentifier $hostIdentifier = Get-ZertoVirtualizationSite -siteIdentifier $siteIdentifier -hosts | Where-Object {$_.VirtualizationHostName -eq $hostName} | Select-Object hostIdentifier -ExpandProperty hostIdentifier
$networkIdentifier = Get-ZertoVirtualizationSite -siteIdentifier $siteIdentifier -networks | Where-Object {$_.VirtualizationNetworkName -eq $networkName} | Select-Object NetworkIdentifier -ExpandProperty NetworkIdentifier $networkIdentifier = Get-ZertoVirtualizationSite -siteIdentifier $siteIdentifier -networks | Where-Object {$_.VirtualizationNetworkName -eq $networkName} | Select-Object NetworkIdentifier -ExpandProperty NetworkIdentifier
$datastoreIdentifier = Get-ZertoVirtualizationSite -siteIdentifier $siteIdentifier -datastores | Where-Object {$_.DatastoreName -eq $datastoreName} | Select-Object DatastoreIdentifier -ExpandProperty DatastoreIdentifier $datastoreIdentifier = Get-ZertoVirtualizationSite -siteIdentifier $siteIdentifier -datastores | Where-Object {$_.DatastoreName -eq $datastoreName} | Select-Object DatastoreIdentifier -ExpandProperty DatastoreIdentifier
# Build the JSON object through an Ordered Hashtable.
$vraBasic = [ordered]@{} $vraBasic = [ordered]@{}
$vraBasic['DatastoreIdentifier'] = $datastoreIdentifier.toString() $vraBasic['DatastoreIdentifier'] = $datastoreIdentifier.toString()
if ($PSBoundParameters.ContainsKey('groupName')) { if ($PSBoundParameters.ContainsKey('groupName')) {
@@ -51,6 +55,8 @@ function Install-ZertoVra {
$vraBasicNetwork['VraIPConfigurationTypeApi'] = "Dhcp" $vraBasicNetwork['VraIPConfigurationTypeApi'] = "Dhcp"
} }
$vraBasic['VraNetworkDataApi'] = $vraBasicNetwork $vraBasic['VraNetworkDataApi'] = $vraBasicNetwork
# Leverage WhatIf functionality to see what might happen, if WhatIf is not specified, attempt to install.
if ($PSCmdlet.ShouldProcess("Preforming operation 'Install-Vra' on Host $hostName with the following data \n $($vraBasic | convertto-json)")) { if ($PSCmdlet.ShouldProcess("Preforming operation 'Install-Vra' on Host $hostName with the following data \n $($vraBasic | convertto-json)")) {
Invoke-ZertoRestRequest -uri "vras" -method POST -body $($vraBasic | ConvertTo-Json) Invoke-ZertoRestRequest -uri "vras" -method POST -body $($vraBasic | ConvertTo-Json)
} }
ZertoApiWrapper/Public/Uninstall-ZertoVra.ps1
+4 -1
View File
@@ -1,7 +1,10 @@
function Uninstall-ZertoVra { function Uninstall-ZertoVra {
[cmdletbinding()] [cmdletbinding()]
param( param(
[Parameter( Mandatory = $true )] [Parameter(
Mandatory = $true,
HelpMessage = "Host Name attached to the VRA to be removed."
)]
[string[]]$hostName [string[]]$hostName
) )