Merge pull request #39 from ZertoPublic/NicExportImport
Bulk NIC Information Export and Import
This commit is contained in:
Wes Carroll
GitHub
+4
-2
@@ -2,8 +2,10 @@
|
||||
|
||||
### Zerto Virtual Manager
|
||||
|
||||
*
|
||||
* Added two functions to aid in bulk updating of NIC information for protected VMs. ([Issue 38](https://github.com/ZertoPublic/ZertoApiWrapper/issues/38))
|
||||
* [Export-ZertoVmNicSetting](https://github.com/ZertoPublic/ZertoApiWrapper/blob/Master/docs/Export-ZertoVmNicSettings.md)
|
||||
* [Import-ZertoVmNicSetting](https://github.com/ZertoPublic/ZertoApiWrapper/blob/Master/docs/Import-ZertoVmNicSettings.md)
|
||||
|
||||
### Zerto Analytics
|
||||
|
||||
* Fixed an issue where the Zerto Analytics Rest Request function was not checking for the token before attempting a connection.
|
||||
* Fixed an [issue](https://github.com/ZertoPublic/ZertoApiWrapper/issues/36) where the Zerto Analytics Rest Request function was not checking for the token before attempting a connection.
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
#Requires -Modules Pester
|
||||
#Region - Test Setup
|
||||
$moduleFileName = "ZertoApiWrapper.psd1"
|
||||
$here = (Split-Path -Parent $MyInvocation.MyCommand.Path).Replace("Tests", "ZertoApiWrapper")
|
||||
$sut = (Split-Path -Leaf $MyInvocation.MyCommand.Path).Replace(".Tests.", ".")
|
||||
$file = Get-ChildItem "$here\$sut"
|
||||
$modulePath = $here -replace "Public", ""
|
||||
$moduleFile = Get-ChildItem "$modulePath\$moduleFileName"
|
||||
Get-Module -Name ZertoApiWrapper | Remove-Module -Force
|
||||
Import-Module $moduleFile -Force
|
||||
#EndRegion
|
||||
|
||||
Describe $file.BaseName -Tag 'Unit' {
|
||||
|
||||
It "is valid Powershell (Has no script errors)" {
|
||||
$contents = Get-Content -Path $file -ErrorAction Stop
|
||||
$errors = $null
|
||||
$null = [System.Management.Automation.PSParser]::Tokenize($contents, [ref]$errors)
|
||||
$errors | Should -HaveCount 0
|
||||
}
|
||||
|
||||
Context "$($file.BaseName)::Parameter Unit Tests" {
|
||||
It "has a mantatory string parameter for the output file" {
|
||||
Get-Command $file.BaseName | Should -HaveParameter OutputFile -Type String -Mandatory
|
||||
}
|
||||
|
||||
It "has a non-mandatory string array parameter for vpgName(s) to export" {
|
||||
Get-Command $file.BaseName | Should -HaveParameter vpgName -Type String[]
|
||||
Get-Command $file.BaseName | Should -HaveParameter vpgName -Not -Mandatory
|
||||
}
|
||||
|
||||
It "Output File does not take null or empty string" {
|
||||
{ Export-ZertoVpg -outputFile "" } | Should -Throw
|
||||
{ Export-ZertoVpg -outputFile $null } | Should -Throw
|
||||
}
|
||||
|
||||
It "Vpg Name parameter does not take null or empty string" {
|
||||
{ Export-ZertoVpg -outputFile ".\ExportedInfo.csv" -vpgName = "" } | Should -Throw
|
||||
{ Export-ZertoVpg -outputFile ".\ExportedInfo.csv" -vpgName = $null } | Should -Throw
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,39 @@
|
||||
#Requires -Modules Pester
|
||||
$moduleFileName = "ZertoApiWrapper.psd1"
|
||||
$here = (Split-Path -Parent $MyInvocation.MyCommand.Path).Replace("Tests", "ZertoApiWrapper")
|
||||
$sut = (Split-Path -Leaf $MyInvocation.MyCommand.Path).Replace(".Tests.", ".")
|
||||
$file = Get-ChildItem "$here\$sut"
|
||||
$modulePath = $here -replace "Public", ""
|
||||
$moduleFile = Get-ChildItem "$modulePath\$moduleFileName"
|
||||
Get-Module -Name ZertoApiWrapper | Remove-Module -Force
|
||||
Import-Module $moduleFile -Force
|
||||
|
||||
Describe $file.BaseName -Tag 'Unit' {
|
||||
|
||||
It "is valid Powershell (Has no script errors)" {
|
||||
$contents = Get-Content -Path $file -ErrorAction Stop
|
||||
$errors = $null
|
||||
$null = [System.Management.Automation.PSParser]::Tokenize($contents, [ref]$errors)
|
||||
$errors | Should -HaveCount 0
|
||||
}
|
||||
|
||||
Context "$($file.BaseName)::Parameter Unit Tests" {
|
||||
|
||||
It "Has a mandatory string array parameter for the settings file to import" {
|
||||
Get-Command $file.BaseName | Should -HaveParameter InputFile
|
||||
Get-Command $file.BaseName | Should -HaveParameter InputFile -Mandatory
|
||||
Get-Command $file.BaseName | Should -HaveParameter InputFile -Type String
|
||||
}
|
||||
|
||||
It "Will not accecpt a Null or Empty string for the settings file" {
|
||||
{ Import-ZertoVpg -InputFile $null } | Should -Throw
|
||||
{ Import-ZertoVpg -InputFile "" } | Should -Throw
|
||||
{ Import-ZertoVpg -InputFile @() } | Should -Throw
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
Context "$($file.BaseName)::Function Unit Tests" {
|
||||
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
#Requires -Modules Pester
|
||||
$moduleFileName = "ZertoApiWrapper.psd1"
|
||||
$here = (Split-Path -Parent $MyInvocation.MyCommand.Path).Replace("Tests", "ZertoApiWrapper")
|
||||
$sut = (Split-Path -Leaf $MyInvocation.MyCommand.Path).Replace(".Tests.", ".")
|
||||
$file = Get-ChildItem "$here\$sut"
|
||||
$modulePath = $here -replace "Public", ""
|
||||
$moduleFile = Get-ChildItem "$modulePath\$moduleFileName"
|
||||
Get-Module -Name ZertoApiWrapper | Remove-Module -Force
|
||||
Import-Module $moduleFile -Force
|
||||
|
||||
Describe $file.BaseName -Tag 'Unit' {
|
||||
|
||||
It "is valid Powershell (Has no script errors)" {
|
||||
$contents = Get-Content -Path $file -ErrorAction Stop
|
||||
$errors = $null
|
||||
$null = [System.Management.Automation.PSParser]::Tokenize($contents, [ref]$errors)
|
||||
$errors | Should -HaveCount 0
|
||||
}
|
||||
}
|
||||
@@ -1,6 +1,6 @@
|
||||
#Requires -Modules 'InvokeBuild'
|
||||
|
||||
$version = "{0}.{1}" -f $(Get-Content .\version.txt), $(get-date -format 'yyyyMMdd')
|
||||
$version = "{0}.{1}" -f $(Get-Content .\version.txt), $(Get-Date -format 'yyyyMMdd')
|
||||
|
||||
task . CreateArtifacts
|
||||
|
||||
@@ -59,9 +59,9 @@ task AnalyzeBuiltFiles CheckPSScriptAnalyzerInstalled, CreatePsm1ForRelease, {
|
||||
|
||||
task FileTests CheckPesterInstalled, {
|
||||
$testResultsFile = "$BuildRoot\Tests\TestResults.xml"
|
||||
$script:results = Invoke-Pester -Script "$BuildRoot" -Tag Unit -OutputFile $testResultsFile -PassThru
|
||||
$script:results = Invoke-Pester -Script "$BuildRoot" -Tag Unit -OutputFile $testResultsFile -PassThru -Show Fails
|
||||
$FailureMessage = '{0} Unit test(s) failed. Aborting build' -f $results.FailedCount
|
||||
assert ($results.FailedCount -eq 0) $FailureMessage
|
||||
Assert ($results.FailedCount -eq 0) $FailureMessage
|
||||
}
|
||||
|
||||
$buildMamlParams = @{
|
||||
@@ -77,15 +77,15 @@ task BuildMamlHelp CheckPlatyPSInstalled, {
|
||||
}
|
||||
|
||||
task UpdateMarkdownHelp CheckPlatyPSInstalled, {
|
||||
remove-module ZertoApiWrapper -force -ErrorAction SilentlyContinue
|
||||
Remove-Module ZertoApiWrapper -force -ErrorAction SilentlyContinue
|
||||
Import-Module .\ZertoApiWrapper\ZertoApiWrapper.psm1 -Force
|
||||
Update-MarkDownHelp -Path docs -AlphabeticParamsOrder
|
||||
Update-MarkdownHelp -Path docs -AlphabeticParamsOrder
|
||||
}
|
||||
|
||||
task UpdateMarkdownHelpModule CheckPlatyPSInstalled, {
|
||||
remove-module ZertoApiWrapper -force -ErrorAction SilentlyContinue
|
||||
Remove-Module ZertoApiWrapper -force -ErrorAction SilentlyContinue
|
||||
Import-Module .\ZertoApiWrapper\ZertoApiWrapper.psm1 -Force
|
||||
Update-MarkDownHelpModule -Path docs -AlphabeticParamsOrder
|
||||
Update-MarkdownHelpModule -Path docs -AlphabeticParamsOrder
|
||||
}
|
||||
|
||||
task CreatePsd1ForRelease CleanTemp, {
|
||||
|
||||
@@ -0,0 +1,85 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Export-ZertoVmNicSetting {
|
||||
[CmdletBinding()]
|
||||
param (
|
||||
# Vpg(s) to export. If no VPG was named, all data will be exported.
|
||||
[Parameter(
|
||||
Helpmessage = "VPG(s) to export"
|
||||
)]
|
||||
[ValidateNotNullOrEmpty()]
|
||||
[string[]]
|
||||
$VpgName,
|
||||
# Output file information
|
||||
[Parameter(
|
||||
Helpmessage = "File to export the data to. This MUST be a CSV. If a CSV filename is not specified, the file will be forced into a CSV",
|
||||
Mandatory
|
||||
)]
|
||||
[ValidateNotNullOrEmpty()]
|
||||
[string]
|
||||
$OutputFile
|
||||
)
|
||||
|
||||
begin {
|
||||
}
|
||||
|
||||
process {
|
||||
if (($OutputFile.Split('.')[-1]) -ne 'csv') {
|
||||
$OutputFile += '.csv'
|
||||
}
|
||||
if ( "VpgName" -in $PSBoundParameters.Keys ) {
|
||||
$vpgs = Get-ZertoVpg | Where-Object { $_.VpgName -in $VpgName }
|
||||
foreach ($group in $VpgName) {
|
||||
if ($group -notin $vpgs.VpgName) {
|
||||
Write-Error "$group VPG not found. Skipping." -ErrorAction Continue
|
||||
}
|
||||
}
|
||||
} else {
|
||||
$vpgs = Get-ZertoVpg
|
||||
}
|
||||
$nicSettings = foreach ($group in $vpgs) {
|
||||
$protectedVms = Get-ZertoProtectedVm -vpgName ($group.vpgname)
|
||||
$vmMap = @{ }
|
||||
foreach ($vm in $protectedVms) {
|
||||
$vmMap["$($vm.vmIdentifier)"] = $vm.vmName
|
||||
}
|
||||
$settingsId = New-ZertoVpgSettingsIdentifier -vpgIdentifier $group.vpgIdentifier
|
||||
$vmSettings = Get-ZertoVpgSetting -vpgSettingsIdentifier $settingsId -vms
|
||||
$networks = Get-ZertoVirtualizationSite -siteIdentifier $group.RecoverySite.identifier -networks
|
||||
$null = Remove-ZertoVpgSettingsIdentifier -vpgSettingsIdentifier $settingsId
|
||||
$networkMap = @{ }
|
||||
foreach ($network in $networks) {
|
||||
$networkMap[$network.NetworkIdentifier] = $network.VirtualizationNetworkName
|
||||
}
|
||||
foreach ($vm in $vmSettings) {
|
||||
$nicInfo = [PSCustomObject]@{
|
||||
VPGName = $group.VPGName
|
||||
VMName = $vmMap[$($vm.vmIdentifier)]
|
||||
NicIdentifier = $vm.nics.NicIdentifier
|
||||
LiveNetwork = $networkMap[$vm.nics.failover.Hypervisor.NetworkIdentifier]
|
||||
LiveShouldReplaceMac = $vm.nics.failover.Hypervisor.ShouldReplaceMacAddress
|
||||
LiveIsDHCP = $vm.Nics.failover.Hypervisor.IpConfig.IsDhcp
|
||||
LiveIpAddress = $vm.nics.failover.Hypervisor.IpConfig.StaticIp
|
||||
LiveIpSubnetMask = $vm.nics.failover.Hypervisor.IpConfig.SubnetMask
|
||||
LiveIpDefaultGateway = $vm.nics.failover.Hypervisor.IpConfig.Gateway
|
||||
LivePrimaryDns = $vm.nics.failover.Hypervisor.IpConfig.PrimaryDns
|
||||
LiveSecondayDns = $vm.nics.failover.Hypervisor.IpConfig.SecondaryDns
|
||||
LiveDnsSuffix = $vm.nics.failover.Hypervisor.DnsSuffix
|
||||
TestNetwork = $networkMap[$vm.nics.failoverTest.Hypervisor.NetworkIdentifier]
|
||||
TestShouldReplaceMac = $vm.nics.failoverTest.Hypervisor.ShouldReplaceMacAddress
|
||||
TestIsDHCP = $vm.Nics.failoverTest.Hypervisor.IpConfig.IsDhcp
|
||||
TestIpAddress = $vm.nics.failoverTest.Hypervisor.IpConfig.StaticIp
|
||||
TestIpSubnetMask = $vm.nics.failoverTest.Hypervisor.IpConfig.SubnetMask
|
||||
TestIpDefaultGateway = $vm.nics.failoverTest.Hypervisor.IpConfig.Gateway
|
||||
TestPrimaryDns = $vm.nics.failoverTest.Hypervisor.IpConfig.PrimaryDns
|
||||
TestSecondayDns = $vm.nics.failoverTest.Hypervisor.IpConfig.SecondaryDns
|
||||
TestDnsSuffix = $vm.nics.failoverTest.Hypervisor.DnsSuffix
|
||||
}
|
||||
$nicInfo
|
||||
}
|
||||
}
|
||||
$nicSettings | Export-Csv -Path $OutputFile
|
||||
}
|
||||
|
||||
end {
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,125 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Import-ZertoVmNicSetting {
|
||||
[CmdletBinding(SupportsShouldProcess)]
|
||||
param(
|
||||
# File to process for import
|
||||
[Parameter(Helpmessage = "CSV file containing the required VM NIC settings", Mandatory)]
|
||||
[ValidateNotNullOrEmpty()]
|
||||
[string]
|
||||
$InputFile
|
||||
)
|
||||
|
||||
begin {
|
||||
}
|
||||
|
||||
process {
|
||||
if (-not (Test-Path $InputFile)) {
|
||||
Write-Error "Unable to find $InputFile. Please check the name and path and try again." -ErrorAction Stop
|
||||
} elseif ((Get-Item $InputFile).Extension -notmatch '.csv') {
|
||||
Write-Error "$InputFile does not have a 'csv' extension. Please check the name and path and try again." -ErrorAction Stop
|
||||
}
|
||||
$ExpectedHeaders = "VPGName", "VMName", "NicIdentifier", "LiveNetwork", "LiveShouldReplaceMac", "LiveIsDHCP", "LiveIpAddress", "LiveIpSubnetMask", "LiveIpDefaultGateway", "LivePrimaryDns", "LiveSecondayDns", "LiveDnsSuffix", "TestNetwork", "TestShouldReplaceMac", "TestIsDHCP", "TestIpAddress", "TestIpSubnetMask", "TestIpDefaultGateway", "TestPrimaryDns", "TestSecondayDns", "TestDnsSuffix"
|
||||
$HeaderLine = ((Get-Content -Path $InputFile -First 1).Replace('"', '')).Split(',')
|
||||
foreach ($header in $ExpectedHeaders) {
|
||||
if ($header -notin $HeaderLine) {
|
||||
Write-Error "$InputFile is malformed. Please ensure all headers are present." -ErrorAction Stop
|
||||
}
|
||||
}
|
||||
$ImportData = Import-Csv -Path $InputFile
|
||||
$VpgsToUpdate = $ImportData.VPGName | Select-Object -Unique
|
||||
foreach ($Vpg in $VpgsToUpdate) {
|
||||
$VpgInfo = Get-ZertoVpg -vpgName $Vpg
|
||||
$VpgIdentifier = $VpgInfo.VpgIdentifier
|
||||
$RecoveryNetworks = Get-ZertoVirtualizationSite -siteIdentifier $VpgInfo.RecoverySite.Identifier -networks
|
||||
$NetworkMap = @{ }
|
||||
foreach ($Network in $RecoveryNetworks) {
|
||||
$NetworkMap[$Network.VirtualizationNetworkName] = $Network.NetworkIdentifier
|
||||
}
|
||||
$VpgVms = Get-ZertoProtectedVm -vpgName $Vpg
|
||||
$VmMap = @{ }
|
||||
foreach ($Vm in $VpgVms) {
|
||||
$VmMap[$Vm.vmName] = $Vm.vmIdentifier
|
||||
}
|
||||
$VpgSettingsId = New-ZertoVpgSettingsIdentifier -vpgIdentifier $VpgIdentifier
|
||||
$VmsToUpdate = $ImportData | Where-Object { $_.VPGName -eq $Vpg }
|
||||
foreach ($vm in $VmsToUpdate) {
|
||||
if ([string]::IsNullOrWhiteSpace($vm.VpgName) -or
|
||||
[string]::IsNullOrWhiteSpace($Vm.VMName) -or
|
||||
[string]::IsNullOrWhiteSpace($Vm.NicIdentifier) -or
|
||||
[string]::IsNullOrWhiteSpace($Vm.LiveNetwork) -or
|
||||
[string]::IsNullOrWhiteSpace($Vm.LiveShouldReplaceMac) -or
|
||||
[string]::IsNullOrWhiteSpace($Vm.TestNetwork) -or
|
||||
[string]::IsNullOrWhiteSpace($Vm.TestShouldReplaceMac)) {
|
||||
Write-Error "$($Vm.VMName) does not contain all the required data. Please check the CSV entry for this item and try again." -ErrorAction Continue
|
||||
} else {
|
||||
$uri = "vpgSettings/{0}/vms/{1}" -f $vpgSettingsId, $vmMap[$vm.VMName]
|
||||
$VmNicSettings = Get-ZertoVpgSetting -vpgSettingsIdentifier $vpgSettingsId -vmIdentifier $vmMap[$vm.VMName]
|
||||
foreach ($nic in $VmNicSettings.nics) {
|
||||
if ($nic.NicIdentifier -eq $vm.NicIdentifier) {
|
||||
$nic.failover.Hypervisor.NetworkIdentifier = $NetworkMap[$vm.LiveNetwork]
|
||||
$nic.failover.Hypervisor.ShouldReplaceMacAddress = $vm.LiveShouldReplaceMac
|
||||
if ($null -eq $nic.failover.Hypervisor.IpConfig -and ($null -ne $vm.LiveIsDHCP -or $null -ne $vm.LiveIpAddress)) {
|
||||
$IpConfig = [PSCustomObject]@{
|
||||
IsDhcp = $vm.LiveIsDHCP
|
||||
StaticIp = $vm.LiveIpAddress
|
||||
SubnetMask = $vm.LiveIpSubnetMask
|
||||
Gateway = $vm.LiveIpDefaultGateway
|
||||
PrimaryDns = $vm.LivePrimaryDns
|
||||
SecondaryDns = $vm.LiveSecondayDns
|
||||
}
|
||||
$nic.failover.Hypervisor.IpConfig = $IpConfig
|
||||
} elseif ($null -eq $nic.failover.Hypervisor.IpConfig -and $null -eq $vm.LiveIsDHCP -and $null -eq $vm.LiveIpAddress) {
|
||||
$nic.failover.Hypervisor.IpConfig = $null
|
||||
} else {
|
||||
$nic.failover.Hypervisor.IpConfig.IsDhcp = $vm.LiveIsDHCP
|
||||
$nic.failover.Hypervisor.IpConfig.StaticIp = $vm.LiveIpAddress
|
||||
$nic.failover.Hypervisor.IpConfig.SubnetMask = $vm.LiveIpSubnetMask
|
||||
$nic.failover.Hypervisor.IpConfig.Gateway = $vm.LiveIpDefaultGateway
|
||||
$nic.failover.Hypervisor.IpConfig.PrimaryDns = $vm.LivePrimaryDns
|
||||
$nic.failover.Hypervisor.IpConfig.SecondaryDns = $vm.LiveSecondayDns
|
||||
}
|
||||
$nic.failover.Hypervisor.DnsSuffix = $vm.LiveDnsSuffix
|
||||
$nic.failoverTest.Hypervisor.NetworkIdentifier = $NetworkMap[$vm.TestNetwork]
|
||||
$nic.failoverTest.Hypervisor.ShouldReplaceMacAddress = $vm.TestShouldReplaceMac
|
||||
if ($null -eq $nic.failoverTest.Hypervisor.IpConfig -and ($null -ne $vm.TestIsDHCP -or $null -ne $vm.TestIpAddress)) {
|
||||
$IpConfig = [PsCustomObject]@{
|
||||
IsDhcp = $vm.TestIsDHCP
|
||||
StaticIp = $vm.TestIpAddress
|
||||
SubnetMask = $vm.TestIpSubnetMask
|
||||
Gateway = $vm.TestIpDefaultGateway
|
||||
PrimaryDns = $vm.TestPrimaryDns
|
||||
SecondaryDns = $vm.TestSecondayDns
|
||||
}
|
||||
$nic.failoverTest.Hypervisor.IpConfig = $IpConfig
|
||||
} elseif ($null -eq $nic.failoverTest.Hypervisor.IpConfig -and $null -eq $vm.TestIsDHCP -and $null -eq $vm.TestIpAddress) {
|
||||
$nic.failoverTest.Hypervisor.IpConfig = $null
|
||||
} else {
|
||||
$nic.failoverTest.Hypervisor.IpConfig.IsDhcp = $vm.TestIsDHCP
|
||||
$nic.failoverTest.Hypervisor.IpConfig.StaticIp = $vm.TestIpAddress
|
||||
$nic.failoverTest.Hypervisor.IpConfig.SubnetMask = $vm.TestIpSubnetMask
|
||||
$nic.failoverTest.Hypervisor.IpConfig.Gateway = $vm.TestIpDefaultGateway
|
||||
$nic.failoverTest.Hypervisor.IpConfig.PrimaryDns = $vm.TestPrimaryDns
|
||||
$nic.failoverTest.Hypervisor.IpConfig.SecondaryDns = $vm.TestSecondayDns
|
||||
}
|
||||
$nic.failoverTest.Hypervisor.DnsSuffix = $vm.TestDnsSuffix
|
||||
}
|
||||
}
|
||||
Write-Verbose "Putting Updated Config for VM: $($vm.vmname) in Vpg: $Vpg"
|
||||
if ($PSCmdlet.ShouldProcess($vm.NicIdentifier, "Updating Nic")) {
|
||||
Invoke-ZertoRestRequest -uri $uri -Method "PUT" -Body ($VmNicSettings | ConvertTo-Json -Depth 10) > $null
|
||||
}
|
||||
}
|
||||
}
|
||||
Write-Verbose "Saving updated configuration for VPG: $Vpg"
|
||||
if ($PSCmdlet.ShouldProcess($Vpg, "Saving Changes")) {
|
||||
Save-ZertoVpgSetting -vpgSettingsIdentifier $vpgSettingsId
|
||||
}
|
||||
Write-Verbose "Waiting 5 Seconds for Next VPG Update"
|
||||
Start-Sleep 5
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
end {
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,26 @@
|
||||
<# .ExternalHelp ./en-us/ZertoApiWrapper-help.xml #>
|
||||
function Remove-ZertoVpgSettingsIdentifier {
|
||||
[CmdletBinding(SupportsShouldProcess = $true)]
|
||||
param (
|
||||
# Settings Identifier to Remove
|
||||
[Parameter(HelpMessage = "VpgSettingsIdentifier to Delete", Mandatory)]
|
||||
[ValidateNotNullOrEmpty()]
|
||||
[string[]]
|
||||
$vpgSettingsIdentifier
|
||||
)
|
||||
|
||||
begin {
|
||||
}
|
||||
|
||||
process {
|
||||
foreach ($id in $vpgSettingsIdentifier) {
|
||||
if ($PSCmdlet.ShouldProcess($id)) {
|
||||
$uri = "vpgSettings/{0}" -f $id
|
||||
Invoke-ZertoRestRequest -uri $uri -method "DELETE"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
end {
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,79 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/Master/docs/Export-ZertoVmNicSettings.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Export-ZertoVmNicSetting
|
||||
|
||||
## SYNOPSIS
|
||||
Queries VPGs and associated Virtual Machines to export all protected virtual machine NIC settings to a Comma Separated Value (CSV) file.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Export-ZertoVmNicSetting [[-VpgName] <String[]>] [-OutputFile] <String> [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Queries VPGs and associated Virtual Machines to export all protected virtual machine NIC settings to a Comma Separated Value (CSV) file. This file can be used with the Import-ZertoVmNicSetting function to bulk update.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Export-ZertoVmNicSetting -OutputFile "C:\ZertoInfo\VMNicSettings.csv"
|
||||
```
|
||||
|
||||
Exports VM Nic Settings for ALL Virtual Protection Groups to a file located at "C:\ZertoInfo\VMNicSettings.csv"
|
||||
|
||||
### Example 2
|
||||
```powershell
|
||||
PS C:\> Export-ZertoVmNicSetting -OutputFile "C:\ZertoInfo\VMNicSettings.csv" -VpgName "Exchange", "Support Forum"
|
||||
```
|
||||
|
||||
Exports VM Nic Settings for Exchange and Support Forum Virtual Protection Groups to a file located at "C:\ZertoInfo\VMNicSettings.csv"
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -OutputFile
|
||||
Output file information
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 2
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -VpgName
|
||||
Vpg(s) to export. If no VPG was named, all data will be exported.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: 1
|
||||
Default value: None
|
||||
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
|
||||
|
||||
## RELATED LINKS
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZertpZsspSession.md
|
||||
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZertoZsspSession.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
|
||||
@@ -0,0 +1,60 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Get-ZertoZsspSession.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Import-ZertoVmNicSetting
|
||||
|
||||
## SYNOPSIS
|
||||
Using a CSV file, will import updated Live and Test network settings for protected virtual machines.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Import-ZertoVmNicSetting [-InputFile] <String> [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
Using a CSV file, will import updated Live and Test network settings for protected virtual machines. This function will read the provided CSV file and only update VMs defined in the file.
|
||||
|
||||
It should be noted, due to current API limitations once a NIC is defined to update to either a Static IP address or use a DHCP address, it is not possible to remove that configuration via the API. Should you require this functionality, you will need to manually update via the GUI to set the option to "No"
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Import-ZertoVmNicSetting -InputFile 'C:\ZertoScripts\UpdatedNicInformation.csv'
|
||||
```
|
||||
|
||||
Imports the data in the CSV located at 'C:\ZertoScripts\UpdatedNicInformation.csv' and updates each VM and each NIC as defined in the CSV file.
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -InputFile
|
||||
File to process for import
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 1
|
||||
Default value: None
|
||||
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
|
||||
|
||||
## RELATED LINKS
|
||||
[Zerto Virtual Manager REST API VpgSettings end point documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/index.html#page/RestfulAPIs%2FStatusAPIs.5.110.html%23)
|
||||
@@ -0,0 +1,90 @@
|
||||
---
|
||||
external help file: ZertoApiWrapper-help.xml
|
||||
Module Name: ZertoApiWrapper
|
||||
online version: https://github.com/ZertoPublic/ZertoApiWrapper/blob/master/docs/Resume-ZertoVpgSettingsIdentifier.md
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Remove-ZertoVpgSettingsIdentifier
|
||||
|
||||
## SYNOPSIS
|
||||
When a new VpgSettingsIdentifier is created, all the settings sit in memory for 30 minutes after the last change. This operation will delete the settings from memory and discard any changes. This is akin to clicking cancel on the VPG Edit Wizard screen.
|
||||
|
||||
## SYNTAX
|
||||
|
||||
```
|
||||
Remove-ZertoVpgSettingsIdentifier [-vpgSettingsIdentifier] <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
When a new VpgSettingsIdentifier is created, all the settings sit in memory for 30 minutes after the last change. This operation will delete the settings from memory and discard any changes. This is akin to clicking cancel on the VPG Edit Wizard screen.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> Remove-ZertoVpgSettingsIdentifier -vpgSettingsIdentifier "1234-7890-5678"
|
||||
```
|
||||
|
||||
Removes VPG Settings Identifier "1234-7890-5678" from the Zerto Virtual Manager without applying any settings that may have changed.
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -vpgSettingsIdentifier
|
||||
Settings Identifier to Remove
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: True
|
||||
Position: 1
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Confirm
|
||||
Prompts you for confirmation before running the cmdlet.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: (All)
|
||||
Aliases: cf
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -WhatIf
|
||||
Shows what would happen if the cmdlet runs.
|
||||
The cmdlet is not run.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: (All)
|
||||
Aliases: wi
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
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
|
||||
|
||||
## RELATED LINKS
|
||||
|
||||
[Zerto Rest API VPG Settings End Point Documentation](http://s3.amazonaws.com/zertodownload_docs/Latest/Zerto%20Virtual%20Replication%20Zerto%20Virtual%20Manager%20%28ZVM%29%20-%20vSphere%20Online%20Help/index.html#page/RestfulAPIs%2FStatusAPIs.5.118.html%23)
|
||||
Reference in New Issue
Block a user