Functions/Public/iaas-proxy-provider/New-vRANATNetworkProfile.ps1
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 |
function New-vRANATNetworkProfile { <# .SYNOPSIS Create a vRA nat network profile .DESCRIPTION Create a vRA nat network profile .PARAMETER Name The network profile Name .PARAMETER Description The network profile Description .PARAMETER SubnetMask The subnet mask of the network profile .PARAMETER GatewayAddress The gateway address of the network profile .PARAMETER ExternalNetworkProfile The external network profile that will be linked to that Routed or NAT network profile .PARAMETER UseExternalNetworkProfileSettings Use the settings from the selected external network profile .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 .PARAMETER IPRanges An array of ip address ranges .PARAMETER NatType The nat type. This can be One-to-One or One-to-Many .PARAMETER DHCPEnabled Enable DHCP for a NAT network profile. Nat type must be One-to-Many .PARAMETER DHCPStartAddress The start address of the dhcp range .PARAMETER DHCPEndAddress The end address of the dhcp range .PARAMETER DHCPLeaseTime The dhcp lease time in seconds. The default is 0. .INPUTS System.String System.Int System.Switch PSCustomObject .OUTPUTS System.Management.Automation.PSObject .EXAMPLE $DefinedRange1 = New-vRANetworkProfileIPRangeDefinition -Name "External-Range-01" -Description "Example 1" -StartIPv4Address "10.70.1.2" -EndIPv4Address "10.70.1.5" New-vRANATNetworkProfile -Name Network-NAT -Description "NAT" -SubnetMask "255.255.255.0" -GatewayAddress "10.70.1.1" -PrimaryDNSAddress "10.70.1.100" -SecondaryDNSAddress "10.70.1.101" -DNSSuffix "corp.local" -DNSSearchSuffix "corp.local" -NatType ONETOMANY -ExternalNetworkProfile "Network-External" -DHCPEnabled -DHCPStartAddress "10.70.1.20" -DHCPEndAddress "10.70.1.30" -IPRanges $DefinedRange1 #> [CmdletBinding(SupportsShouldProcess,ConfirmImpact="Low",DefaultParameterSetName="Standard")][OutputType('System.Management.Automation.PSObject')] Param ( [Parameter(Mandatory=$true)] [ValidateNotNullOrEmpty()] [String]$Name, [Parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [String]$Description, [Parameter(Mandatory=$true)] [ValidateScript({$_ -match [IPAddress]$_ })] [String]$SubnetMask, [Parameter(Mandatory=$false)] [ValidateScript({$_ -match [IPAddress]$_ })] [String]$GatewayAddress, [Parameter(Mandatory=$true)] [ValidateNotNullOrEmpty()] [String]$ExternalNetworkProfile, [Parameter(Mandatory=$false, ParameterSetName="UseExternalProfileSettings")] [ValidateNotNullOrEmpty()] [Switch]$UseExternalNetworkProfileSettings, [Parameter(Mandatory=$false, ParameterSetName="Standard")] [ValidateScript({$_ -match [IPAddress]$_ })] [String]$PrimaryDNSAddress, [Parameter(Mandatory=$false, ParameterSetName="Standard")] [ValidateScript({$_ -match [IPAddress]$_ })] [String]$SecondaryDNSAddress, [Parameter(Mandatory=$false, ParameterSetName="Standard")] [ValidateNotNullOrEmpty()] [String]$DNSSuffix, [Parameter(Mandatory=$false, ParameterSetName="Standard")] [ValidateNotNullOrEmpty()] [String]$DNSSearchSuffix, [Parameter(Mandatory=$false, ParameterSetName="Standard")] [ValidateScript({$_ -match [IPAddress]$_ })] [String]$PrimaryWinsAddress, [Parameter(Mandatory=$false, ParameterSetName="Standard")] [ValidateScript({$_ -match [IPAddress]$_ })] [String]$SecondaryWinsAddress, [Parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [PSCustomObject[]]$IPRanges, [Parameter(Mandatory=$true)] [ValidateSet("ONETOONE", "ONETOMANY")] [String]$NatType, [Parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [Switch]$DHCPEnabled, [Parameter(Mandatory=$false)] [ValidateScript({$_ -match [IPAddress]$_ })] [String]$DHCPStartAddress, [Parameter(Mandatory=$false)] [ValidateScript({$_ -match [IPAddress]$_ })] [String]$DHCPEndAddress, [Parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [Int]$DHCPLeaseTime = 0 ) xRequires -Version 7.1 try { $ExternalNetworkProfileObject = Get-vRAExternalNetworkProfile -Name $ExternalNetworkProfile -Verbose:$VerbosePreference if ($PSBoundParameters.ContainsKey("UseExternalNetworkProfileSettings")) { Write-Verbose -Message "Using External Network Profile Settings" if ($ExternalNetworkProfileObject.primaryDNSAddress) { $PrimaryDNSAddress = $ExternalNetworKProfileObject.primaryDNSAddress Write-Verbose -Message "Primary DNS Address: $($PrimaryDNSAddress)" } if ($ExternalNetworkProfileObject.secondaryDNSAddress) { $SecondaryDNSAddress = $ExternalNetworKProfileObject.secondaryDNSAddress Write-Verbose -Message "Secondary DNS Address: $($SecondaryDNSAddress)" } if ($ExternalNetworkProfileObject.dnsSuffix) { $DNSSuffix = $ExternalNetworKProfileObject.dnsSuffix Write-Verbose -Message "DNS Suffix: $($DNSSuffix)" } if ($ExternalNetworkProfileObject.dnsSearchSuffix) { $DNSSearchSuffix = $ExternalNetworKProfileObject.dnsSearchSuffix Write-Verbose -Message "DNS Search Suffix: $($DNSSearchSuffix)" } if ($ExternalNetworkProfileObject.primaryWinsAddress) { $PrimaryWinsAddress = $ExternalNetworKProfileObject.primaryWinsAddress Write-Verbose -Message "Primary Wins Address: $($PrimaryWinsAddress)" } if ($ExternalNetworkProfileObject.secondaryWinsAddress) { $SecondaryWinsAddress = $ExternalNetworKProfileObject.secondaryWinsAddress Write-Verbose -Message "Secondary Wins Address: $($SecondaryWinsAddress)" } } # --- Define the network profile $Template = @" { "@type": "NATNetworkProfile", "name": "$($Name)", "description": "$($Description)", "createdDate": null, "lastModifiedDate": null, "isHidden": false, "definedRanges": [], "reclaimedAddresses": null, "IPAMEndpointId": null, "IPAMEndpointName": null, "addressSpaceExternalId": null, "profileType": "NAT", "natType": "$($NatType)", "subnetMask": "$($SubnetMask)", "gatewayAddress": "$($GatewayAddress)", "primaryDnsAddress": "$($PrimaryDNSAddress)", "secondaryDnsAddress": "$($SecondaryDNSAddress)", "dnsSuffix": "$($DNSSuffix)", "dnsSearchSuffix": "$($DNSSearchSuffix)", "primaryWinsAddress": "$($PrimaryWinsAddress)", "secondaryWinsAddress": "$($SecondaryWinsAddress)", "externalNetworkProfileId": "$($ExternalNetworkProfileObject.id)", "externalNetworkProfileName": "$($ExternalNetworkProfileObject.name)" } "@ # --- Enable DHCP if ($DHCPEnabled -and $NatType -eq "ONETOMANY") { Write-Verbose -Message "DHCP has been enabled and nat type is set to One-to-Many" $DHCPConfigurationTemplate = @" { "dhcpStartIPAddress": "$($DHCPStartAddress)", "dhcpEndIPAddress": "$($DHCPEndAddress)", "dhcpLeaseTimeInSeconds": $($DHCPLeaseTime) } "@ # --- Add the dhcp configuration to the network profile object $Object = $Template | ConvertFrom-Json $DHCPConfiguration = $DHCPConfigurationTemplate | ConvertFrom-Json Add-Member -InputObject $Object -MemberType NoteProperty -Name "dhcpConfig" -Value $DHCPConfiguration # --- Convert the modified object back to json $Template = $Object | ConvertTo-Json -Depth 20 } if ($PSBoundParameters.ContainsKey("IPRanges")) { $Object = $Template | ConvertFrom-Json foreach ($IPRange in $IPRanges) { $Object.definedRanges += $IPRange } $Template = $Object | ConvertTo-Json -Depth 20 -Compress } if ($PSCmdlet.ShouldProcess($Name)){ $URI = "/iaas-proxy-provider/api/network/profiles" # --- Run vRA REST Request Invoke-vRARestMethod -Method POST -URI $URI -Body $Template -Verbose:$VerbosePreference | Out-Null # --- Output the Successful Result Get-vRANATNetworkProfile -Name $Name -Verbose:$VerbosePreference } } catch [Exception]{ throw } } |