Functions/BloxOneDDI/Set-B1Host.ps1
|
function Set-B1Host { <# .SYNOPSIS Updates an existing BloxOneDDI Host .DESCRIPTION This function is used to update an existing BloxOneDDI Host .PARAMETER Name The name of the BloxOneDDI host to update. If -IP is specified, the Name parameter will overwrite the existing display name. .PARAMETER IP The IP of the BloxOneDDI host to update. .PARAMETER TimeZone The TimeZone to set the BloxOneDDI host to, i.e "Europe/London" .PARAMETER Space The IPAM space where the BloxOneDDI host is located .PARAMETER Description The description to update the BloxOneDDI Host to .PARAMETER NoIPSpace This parameter is required when applying changes to BloxOneDDI Hosts which are not assigned to an IPAM Space .PARAMETER Tags A list of tags to apply to this BloxOneDDI Host. This will overwrite existing tags. .PARAMETER id The id of the host to update. Accepts pipeline input .Example Set-B1Host -Name "bloxoneddihost1.mydomain.corp" -IP "10.10.20.11" -TimeZone "Europe/London" -Space "Global" .FUNCTIONALITY BloxOneDDI .FUNCTIONALITY Host #> param( [Parameter(ParameterSetName="noID")] [String]$Name, [Parameter(ParameterSetName="noID")] [String]$IP, [String]$Space, [String]$TimeZone, [String]$Description, [Parameter(ParameterSetName="noID")] [switch]$NoIPSpace, [System.Object]$Tags, [Parameter( ValueFromPipelineByPropertyName = $true, ParameterSetName="ID", Mandatory=$true )] [String]$id ) process { if ($id) { $OnPremHost = Get-B1Host -id $id } else { if ($IP) { if ($NoIPSpace) { $OnPremHost = Get-B1Host -IP $IP -NoIPSpace:$NoIPSpace } else { $OnPremHost = Get-B1Host -IP $IP -Space $Space } if (!($OnPremHost)) { Write-Host "On-Prem Host $IP does not exist." -ForegroundColor Gray } } elseif ($Name) { if ($NoIPSpace) { $OnPremHost = Get-B1Host -Name $Name -NoIPSpace:$NoIPSpace -Strict } else { $OnPremHost = Get-B1Host -Name $Name -Space $Space -Strict } if (!($OnPremHost)) { Write-Host "On-Prem Host $Name does not exist." -ForegroundColor Gray } } } if ($OnPremHost) { if ($Name) { $OnPremHost.display_name = $Name } if ($TimeZone) {$OnPremHost.timezone = $TimeZone} if ($Space) { if ($OnPremHost.ip_space) { $OnPremHost.ip_space = (Get-B1Space -Name $Space -Strict).id } else { $OnPremHost | Add-Member -MemberType NoteProperty -Name "ip_space" -Value (Get-B1Space -Name $Space -Strict).id } } if ($Description) { if ($OnPremHost.description) { $OnPremHost.description = $Description } else { $OnPremHost | Add-Member -MemberType NoteProperty -Name "description" -Value $Description } } if ($Tags) { if ($OnPremHost.tags) { $OnPremHost.tags = $Tags } else { $OnPremHost | Add-Member -MemberType NoteProperty -Name "tags" -Value $Tags } } $hostID = $OnPremHost.id.replace("infra/host/","") $splat = $OnPremHost | Select-Object * -ExcludeProperty configs,created_at | ConvertTo-Json -Depth 10 -Compress if ($Debug) {$splat} $Results = Query-CSP -Method PUT -Uri "$(Get-B1CSPUrl)/api/infra/v1/hosts/$hostID" -Data $splat | Select-Object -ExpandProperty result -ErrorAction SilentlyContinue if ($($Results.id) -eq $($OnPremHost.id)) { Write-Host "Updated BloxOneDDI Host Configuration $($OnPremHost.display_name) successfuly." -ForegroundColor Green } else { Write-Host "Failed to update BloxOneDDI Host Configuration on $($OnPremHost.display_name)." -ForegroundColor Red } } } } |