Functions/BloxOne/BloxOneDDI/New-B1AuthoritativeZone.ps1
|
function New-B1AuthoritativeZone { <# .SYNOPSIS Creates a new Authoritative Zone in BloxOneDDI .DESCRIPTION This function is used to create a new Authoritative Zone in BloxOneDDI .PARAMETER Type The type of authoritative zone to create (Primary / Secondary) .PARAMETER FQDN The FQDN of the zone to create .PARAMETER View The DNS View the zone will be created in .PARAMETER DNSHosts A list of DNS Hosts to assign to the zone .PARAMETER AuthNSGs A list of Authoritative DNS Server Groups to assign to the zone .PARAMETER DNSACL The DNS ACL to assign to the zone for zone transfers .PARAMETER Description The description for the new zone .PARAMETER NotifyExternalSecondaries Toggle whether to notify external secondary DNS Servers for this zone. .PARAMETER Compartment The name of the compartment to assign to this authoritative zone .PARAMETER Tags Any tags you want to apply to the authoritative zone .PARAMETER Force Perform the operation without prompting for confirmation. By default, this function will not prompt for confirmation unless $ConfirmPreference is set to Medium. .EXAMPLE PS> New-B1AuthoritativeZone -Type Primary -FQDN "mysubzone.mycompany.corp" -View "default" -AuthNSGs "Data Centre" -Description "My Subzone" .FUNCTIONALITY BloxOneDDI .FUNCTIONALITY DNS #> [CmdletBinding( SupportsShouldProcess, ConfirmImpact = 'Medium' )] param( [Parameter(Mandatory=$true)] [ValidateSet("Primary","Secondary")] [String]$Type, [Parameter(Mandatory=$true)] [String]$FQDN, [Parameter(Mandatory=$true)] [System.Object]$View, [System.Object]$DNSHosts, [System.Object]$AuthNSGs, [String]$DNSACL, [String]$Description, [ValidateSet("Enabled","Disabled")] [String]$NotifyExternalSecondaries, [String]$Compartment, [System.Object]$Tags, [Switch]$Force ) $ConfirmPreference = Confirm-ShouldProcess $PSBoundParameters if (Get-B1AuthoritativeZone -FQDN $FQDN -View $View -Strict) { Write-Host "The $FQDN Zone already exists in DNS." -ForegroundColor Red break } else { $ViewUUID = (Get-B1DNSView -Name $View -Strict).id switch($Type) { "Primary" { $PrimaryType = "cloud" } "Secondary" { $PrimaryType = "external" } } $splat = @{ "fqdn" = $FQDN "disabled" = $false "view" = $ViewUUID "primary_type" = $PrimaryType } if ($DNSHosts) { $B1Hosts = New-Object System.Collections.ArrayList foreach ($DNSHost in $DNSHosts) { $B1Hosts.Add(@{"host"=(Get-B1DNSHost -Name $DNSHost).id;}) | Out-Null } $splat | Add-Member -Name "internal_secondaries" -Value $B1Hosts -MemberType NoteProperty } if ($AuthNSGs) { $B1AuthNSGs = @() foreach ($AuthNSG in $AuthNSGs) { $B1AuthNSGs += (Get-B1AuthoritativeNSG -Name $AuthNSG -Strict).id } $splat | Add-Member -Name "nsgs" -Value $B1AuthNSGs -MemberType NoteProperty } if ($DNSACL) { $DNSACLID = (Get-B1DNSACL -Name $DNSACL).id if ($DNSACLID) { $UpdateACL = @(@{ "element" = "acl" "acl" = $DNSACLID }) $splat | Add-Member -Name "update_acl" -Value $UpdateACL -MemberType NoteProperty } else { Write-Host "Error. DNS ACL not found." -ForegroundColor Red break } } if ($NotifyExternalSecondaries) { $splat.notify = $(if ($NotifyExternalSecondaries -eq 'Enabled') { $true } else { $false }) } if ($Tags) { $splat.tags = $Tags } if ($Compartment) { $CompartmentID = (Get-B1Compartment -Name $Compartment -Strict).id if (!($CompartmentID)) { Write-Error "Unable to find compartment with name: $($Compartment)" return $null } else { $splat.compartment_id = $CompartmentID } } if ($Description) { $splat.comment = $Description } $splat = $splat | ConvertTo-Json if($PSCmdlet.ShouldProcess("Create new Authoritative Zone:`n$($splat)","Create new Authoritative Zone: $($FQDN)",$MyInvocation.MyCommand)){ $Result = Invoke-CSP -Method POST -Uri "$(Get-B1CSPUrl)/api/ddi/v1/dns/auth_zone" -Data $splat | Select-Object -ExpandProperty result -ErrorAction SilentlyContinue if ($Result) { Write-Host "Created Authorative DNS Zone $FQDN successfully." -ForegroundColor Green return $Result } else { Write-Host "Failed to create Authorative DNS Zone $FQDN." -ForegroundColor Red } } } } |