Functions/Public/iaas-proxy-provider/Set-vRARoutedNetworkProfile.ps1
|
function Set-vRARoutedNetworkProfile { <# .SYNOPSIS Set a vRA network profile .DESCRIPTION Set a vRA network profiles .PARAMETER Id The network profile id .PARAMETER Name The network profile name .PARAMETER Description The network profile description .PARAMETER PrimaryDNSAddress The address of the primary DNS server .PARAMETER SecondaryDNSAddress The address of the secondary DNS server .PARAMETER DNSSuffix The DNS suffix .PARAMETER DNSSearchSuffix The DNS search suffix .PARAMETER PrimaryWinsAddress The address of the primary wins server .PARAMETER SecondaryWinsAddress The address of the secondary wins server .INPUTS System.String. .OUTPUTS System.Management.Automation.PSObject .EXAMPLE Get-vRARoutedNetworkProfile -Name "Network-Routed" | Set-vRARoutedNetworkProfile -Name "Network-Routed-Updated" -Description "Updated Description" .EXAMPLE Set-vRARoutedNetworkProfile -Id 1ada4023-8a02-4349-90bd-732f25001852 -Description "Updated Description" #> [CmdletBinding(SupportsShouldProcess,ConfirmImpact="High")][OutputType('System.Management.Automation.PSObject')] Param ( [Parameter(Mandatory=$true, ValueFromPipelineByPropertyName=$true)] [String]$Id, [Parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [String]$Name, [Parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [String]$Description, [Parameter(Mandatory=$false)] [ValidateScript({$_ -match [IPAddress]$_ })] [String]$PrimaryDNSAddress, [Parameter(Mandatory=$false)] [ValidateScript({$_ -match [IPAddress]$_ })] [String]$SecondaryDNSAddress, [Parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [String]$DNSSuffix, [Parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [String]$DNSSearchSuffix, [Parameter(Mandatory=$false)] [ValidateScript({$_ -match [IPAddress]$_ })] [String]$PrimaryWinsAddress, [Parameter(Mandatory=$false)] [ValidateScript({$_ -match [IPAddress]$_ })] [String]$SecondaryWinsAddress ) Begin { xRequires -Version 7.1 } Process { try { # --- Get the network profile $URI = "/iaas-proxy-provider/api/network/profiles/$($Id)" $NetworkProfile = Invoke-vRARestMethod -Method GET -URI $URI if ($NetworkProfile.profileType -ne "ROUTED") { throw "Network Profile $($NetworkProfile.id) is not of type ROUTED" } # --- Set Properties if ($PSBoundParameters.ContainsKey("Name")) { Write-Verbose -Message "Updating Name: $($NetworkProfile.name) >> $($Name)" $NetworkProfile.name = $Name } if ($PSBoundParameters.ContainsKey("Description")) { Write-Verbose -Message "Updating Description: $($NetworkProfile.description) >> $($Description)" $NetworkProfile.description = $Description } if ($PSBoundParameters.ContainsKey("PrimaryDNSAddress")) { Write-Verbose -Message "Updating Primary DNS Address: $($NetworkProfile.primaryDNSAddress) >> $($PrimaryDNSAddress)" $NetworkProfile.primaryDNSAddress = $PrimaryDNSAddress } if ($PSBoundParameters.ContainsKey("SecondaryDNSAddress")) { Write-Verbose -Message "Updating Secondary DNS Address: $($NetworkProfile.secondaryDNSAddress) >> $($SecondaryDNSAddress)" $NetworkProfile.secondaryDNSAddress = $SecondaryDNSAddress } if ($PSBoundParameters.ContainsKey("DNSSuffix")) { Write-Verbose -Message "Updating DNS Suffix: $($NetworkProfile.dnsSuffix) >> $($DNSSuffix)" $NetworkProfile.dnsSuffix = $DNSSuffix } if ($PSBoundParameters.ContainsKey("DNSSearchSuffix")) { Write-Verbose -Message "Updating DNS Search Address: $($NetworkProfile.dnsSearchSuffix) >> $($DNSSearchSuffix)" $NetworkProfile.dnsSearchSuffix = $DNSSearchSuffix } if ($PSBoundParameters.ContainsKey("PrimaryWinsAddress")) { Write-Verbose -Message "Updating Primary WINS Address: $($NetworkProfile.primaryWinsAddress) >> $($PrimaryWinsAddress)" $NetworkProfile.primaryWinsAddress = $PrimaryWinsAddress } if ($PSBoundParameters.ContainsKey("SecondaryWinsAddress")) { Write-Verbose -Message "Updating Secondary WINS Address: $($NetworkProfile.secondaryWinsAddress) >> $($SecondaryWinsAddress)" $NetworkProfile.secondaryWinsAddress = $SecondaryWinsAddress } $NetworkProfileTemplate = $NetworkProfile | ConvertTo-Json -Depth 100 if ($PSCmdlet.ShouldProcess($Id)){ $URI = "/iaas-proxy-provider/api/network/profiles/$($Id)" # --- Run vRA REST Request Invoke-vRARestMethod -Method PUT -URI $URI -Body $NetworkProfileTemplate -Verbose:$VerbosePreference | Out-Null # --- Output the Successful Result Get-vRARoutedNetworkProfile -Id $Id -Verbose:$VerbosePreference } } catch [Exception]{ throw } } End { } } |