Functions/BloxOneDDI/Set-B1AddressBlock.ps1
|
function Set-B1AddressBlock { <# .SYNOPSIS Updates an existing address block in BloxOneDDI IPAM .DESCRIPTION This function is used to update an existing address block in BloxOneDDI IPAM .PARAMETER Subnet The network address of the address block you want to update .PARAMETER CIDR The CIDR suffix of the address block you want to update .PARAMETER Space The IPAM space where the address block is located .PARAMETER Name The new name for the address block .PARAMETER Description The new description for the address block .PARAMETER DHCPOptions A list of DHCP Options you want to update the address block with. This will overwrite existing options. .PARAMETER DDNSDomain The new DDNS Domain for the address block .PARAMETER DHCPLeaseSeconds The default DHCP Lease duration in seconds .PARAMETER Tags A list of tags to update on the address block. This will replace existing tags, so would normally be a combined list of existing and new tags .PARAMETER id The id of the address block to update. Accepts pipeline input .EXAMPLE ## Example usage when combined with Get-B1DHCPOptionCode $DHCPOptions = @() $DHCPOptions += @{"type"="option";"option_code"=(Get-B1DHCPOptionCode -Name "routers").id;"option_value"="10.10.100.1";} $DHCPOptions += @{"type"="option";"option_code"=(Get-B1DHCPOptionCode -Name "domain-name-servers").id;"option_value"="10.10.10.10,10.10.10.11";} PS> Set-B1AddressBlock -Subnet "10.10.100.0" -Name "Updated name" -Space "Global" -Description "Comment for description" -DHCPOptions $DHCPOptions .FUNCTIONALITY BloxOneDDI .FUNCTIONALITY IPAM #> param( [Parameter(ParameterSetName="noID",Mandatory=$true)] [String]$Subnet, [Parameter(ParameterSetName="noID",Mandatory=$true)] [ValidateRange(0,32)] [Int]$CIDR, [Parameter(ParameterSetName="noID",Mandatory=$true)] [String]$Space, [String]$Name, [System.Object]$DHCPOptions, [String]$Description, [String]$DHCPLeaseSeconds, [String]$DDNSDomain, [System.Object]$Tags, [Parameter( ValueFromPipelineByPropertyName = $true, ParameterSetName="ID", Mandatory=$true )] [String]$id ) process { if ($id) { $AddressBlock = Get-B1AddressBlock -id $id -IncludeInheritance } else { $AddressBlock = Get-B1AddressBlock -Subnet $Subnet -CIDR $CIDR -Space $Space -IncludeInheritance } if ($AddressBlock) { $AddressBlockUri = $AddressBlock.id $AddressBlockPatch = @{} if ($Name) {$AddressBlockPatch.name = $Name} if ($Description) {$AddressBlockPatch.comment = $Description} if ($DHCPOptions) {$AddressBlockPatch.dhcp_options = $DHCPOptions} if ($DHCPLeaseSeconds) { $AddressBlock.inheritance_sources.dhcp_config.lease_time.action = "override" $AddressBlock.dhcp_config.lease_time = $DHCPLeaseSeconds $AddressBlockPatch.inheritance_sources = $AddressBlock.inheritance_sources $AddressBlockPatch.dhcp_config = $AddressBlock.dhcp_config } if ($DDNSDomain) { $AddressBlockPatch."ddns_domain" = $DDNSDomain $DDNSupdateBlock = @{ ddns_update_block = @{ "action" = "override" "value" = @{} } } $AddressBlockPatch.inheritance_sources = $DDNSupdateBlock } if ($Tags) { $AddressBlockPatch.tags = $Tags } if ($AddressBlockPatch.Count -eq 0) { Write-Host "Nothing to update." -ForegroundColor Gray } else { $splat = $AddressBlockPatch | ConvertTo-Json -Depth 10 if ($Debug) {$splat} $Result = Query-CSP -Method PATCH -Uri "$AddressBlockUri" -Data $splat if (($Result | Select-Object -ExpandProperty result).id -eq $($AddressBlock.id)) { Write-Host "Updated Address Block $($AddressBlock.address)/$($AddressBlock.cidr) successfully." -ForegroundColor Green return $Result | Select-Object -ExpandProperty result } else { Write-Host "Failed to update Address Block $Subnet$id." -ForegroundColor Red break } } } else { Write-Host "The Address Block $Subnet/$CIDR$id does not exist." -ForegroundColor Red } } } |