Functions/CSP/Portal/Disable-B1HostLocalAccess.ps1
|
function Disable-B1HostLocalAccess { <# .SYNOPSIS Disabled the Bootstrap UI Local Access for the given NIOS-X Host .DESCRIPTION This function is used to disable the Bootstrap UI Local Access for the given NIOS-X Host .PARAMETER B1Host The name of the NIOS-X Host to disable local access for .PARAMETER UseDefaultCredentials Using the -UseDefaultCredentials parameter will attempt to use the default credentials (admin + last 8 characters of serial number) .PARAMETER Credentials The -Credentials parameter allows entering the Local Access credentials required to disable it .PARAMETER Wait Using the -Wait parameter will wait and check if the local access is disabled successfully. This can be manually checked using Get-B1HostLocalAccess .PARAMETER OPH The NIOS-X Host object to submit a disable local access request for. This accepts pipeline input from Get-B1Host .PARAMETER Force Perform the operation without prompting for confirmation. By default, this function will always prompt for confirmation unless -Confirm:$false or -Force is specified, or $ConfirmPreference is set to None. .EXAMPLE PS> Get-B1Host my-host-1 | Disable-B1HostLocalAccess -UseDefaultCredentials -Wait Local access disable request successfully sent for: my-host-1 Checking local access disabled state.. Local Access Disabled Successfully. .EXAMPLE PS> Disable-B1HostLocalAccess -B1Host my-host-1 -UseDefaultCredentials Local access disable request successfully sent for: my-host-1 .FUNCTIONALITY NIOS-X .FUNCTIONALITY Bootstrap #> [CmdletBinding( SupportsShouldProcess, ConfirmImpact = 'High' )] param( [Parameter( ParameterSetName=("Default Credentials","B1Host"), Mandatory=$true )] [Parameter( ParameterSetName=("Typed Credentials","B1Host"), Mandatory=$true )] [String]$B1Host, [Parameter( ParameterSetName=("Default Credentials","B1Host"), Mandatory=$true )] [Parameter( ParameterSetName=("Default Credentials","Pipeline"), Mandatory=$true )] [Switch]$UseDefaultCredentials, [Parameter( ParameterSetName=("Typed Credentials","B1Host"), Mandatory=$true )] [Parameter( ParameterSetName=("Typed Credentials","Pipeline"), Mandatory=$true )] [PSCredential]$Credentials, [Switch]$Wait, [Parameter( ValueFromPipeline = $true, ParameterSetName=("Typed Credentials","Pipeline"), Mandatory=$true )] [Parameter( ValueFromPipeline = $true, ParameterSetName=("Default Credentials","Pipeline"), Mandatory=$true )] [PSCustomObject[]]$OPH, [Switch]$Force ) process { $ConfirmPreference = Confirm-ShouldProcess $PSBoundParameters $ProcessStart = Get-Date if ($OPH) { if (($OPH.id.split('/')[1]) -ne "host") { Write-Error "Error. Unsupported pipeline object. The input must be of type: host" break } else { $OPHID = $OPH.ophid } } else { $OPH = Get-B1Host -Name $B1Host -Strict if (!($OPH)) { Write-Error "Unable to find NIOS-X Host: $($B1Host)" break } else { $OPHID = $OPH.ophid } } if ($UseDefaultCredentials) { $HostSerial = ($OPH | Select-Object -ExpandProperty tags).'host/serial_number' if ($HostSerial) { Switch -Wildcard ($HostSerial) { "VMware-*" { $HostSerial = $HostSerial.Replace(' ','') $HostPassword = $HostSerial.Substring($HostSerial.length -8) } default { $HostPassword = $HostSerial.Substring($HostSerial.length -8) } } [PSCustomObject]$LocalAccessCredentials = @{ 'Username' = 'admin' 'Password' = $HostPassword } } else { Write-Error 'Unable to determine default credentials' } } else { if (!($Credentials)) { $Credentials = Get-Credential } [PSCustomObject]$LocalAccessCredentials = @{ 'Username' = $Credentials.GetNetworkCredential().Username 'Password' = $Credentials.GetNetworkCredential().Password } } if ($LocalAccessCredentials.Username -and $LocalAccessCredentials.Password) { $JSONData = @{ "username" = $LocalAccessCredentials.Username "password" = $LocalAccessCredentials.Password } | ConvertTo-Json if($PSCmdlet.ShouldProcess("Disable Local Access on: $($OPH.display_name)","Disable Local Access on: $($OPH.display_name)",$MyInvocation.MyCommand)){ $Results = Invoke-CSP -Method POST -Uri "$(Get-B1CspUrl)/bootstrap-app/v1/host/$($OPHID)/disable_local_access" -Data $($JSONData) if ($Results.Count -eq 1) { Write-Host "Local access disable request successfully sent for: $($OPH.display_name)" -ForegroundColor Green if ($Wait) { $Count = 0 while ($Count -lt 60) { Write-Host "Checking local access disabled state.." -ForegroundColor Yellow $B1HostLocalAccess = $OPH | Get-B1HostLocalAccess if ($B1HostLocalAccess.enabled -ne "True") { Write-Host "Local Access disabled Successfully." -ForegroundColor Green return $null } else { $AuditLog = Get-B1AuditLog -Action "LocalAccessDisabled" -Start $ProcessStart -ErrorAction SilentlyContinue if ($AuditLog) { $Entries = $AuditLog | Where-Object {($_.event_metadata.value | ConvertFrom-Json).ophid -eq "$($OPHID)"} $LatestEntry = $Entries | Sort-Object created_at -Desc | Select-Object -First 1 if ($LatestEntry.result -eq "Failed") { Write-Error $($LatestEntry.message) return $null } } } Wait-Event -Timeout 10 $Count += 10 } Write-Error "Error. Timed out waiting for Local Access to be disabled." } } else { Write-Error "Error. Failed to sent local access disable request for: $($OPH.display_name)" } } } } } |