knownIssues/Test-SdnKnownIssue.ps1
|
# Copyright (c) Microsoft Corporation. # Licensed under the MIT License. function Test-SdnKnownIssue { <# .SYNOPSIS Executes a series of detection scripts to isolate well known issues that may cause impact to workloads running on the SDN fabric. .PARAMETER NetworkController Specifies the name or IP address of the network controller node on which this cmdlet operates. The parameter is optional if running on network controller node. .PARAMETER Credential Specifies a user account that has permission to perform this action. The default is the current user. .PARAMETER NcRestCredential Specifies a user account that has permission to access the northbound NC API interface. The default is the current user. .EXAMPLE PS> Test-SdnKnownIssue .EXAMPLE PS> Test-SdnKnownIssue -NetworkController 'NC01' -Credential (Get-Credential) -NcRestCredential (Get-Credential) #> [CmdletBinding()] param ( [Parameter(Mandatory = $false)] [System.String]$NetworkController = $(HostName), [Parameter(Mandatory = $false)] [System.Management.Automation.PSCredential] [System.Management.Automation.Credential()] $Credential = [System.Management.Automation.PSCredential]::Empty, [Parameter(Mandatory = $false)] [System.Management.Automation.PSCredential] [System.Management.Automation.Credential()] $NcRestCredential = [System.Management.Automation.PSCredential]::Empty, [Parameter(Mandatory = $false)] [ArgumentCompleter({ $possibleValues = Get-ChildItem -Path $PSScriptRoot -Recurse | Where-Object { $_.Extension -eq '.ps1' -and $_.BaseName -ilike "Test-SdnKI*" } | Select-Object -ExpandProperty BaseName return $possibleValues | ForEach-Object { $_ } })] [System.String]$Test ) try { $arrayList = [System.Collections.ArrayList]::new() if ($PSBoundParameters.ContainsKey('Credential')) { $Global:SdnDiagnostics.Credential = $Credential } if ($PSBoundParameters.ContainsKey('NcRestCredential')) { $Global:SdnDiagnostics.NcRestCredential = $NcRestCredential } if (-NOT ($PSBoundParameters.ContainsKey('NetworkController'))) { $config = Get-SdnRoleConfiguration -Role 'NetworkController' $confirmFeatures = Confirm-RequiredFeaturesInstalled -Name $config.windowsFeature if (-NOT ($confirmFeatures)) { "The current machine is not a NetworkController, run this on NetworkController or use -NetworkController parameter to specify one" | Trace-Output -Level:Warning return # don't throw exception, since this is a controlled scenario and we do not need stack exception tracing } } $environmentInfo = Get-SdnInfrastructureInfo -NetworkController $NetworkController -Credential $Credential -NcRestCredential $NcRestCredential if ($null -eq $environmentInfo) { throw New-Object System.NullReferenceException("Unable to retrieve environment details") } if ($PSBoundParameters.ContainsKey('Test')) { $knownIssueScripts = Get-ChildItem -Path $PSScriptRoot -Recurse | Where-Object { $_.BaseName -ieq $Test } } else { $knownIssueScripts = Get-ChildItem -Path $PSScriptRoot -Recurse | Where-Object { $_.Extension -eq '.ps1' -and $_.BaseName -ilike "Test-SdnKI*" } } if ($null -eq $knownIssueScripts) { throw New-Object System.NullReferenceException("No known issue scripts found") } "Located {0} known issue scripts" -f $healthValidationScripts.Count | Trace-Output -Level:Verbose foreach ($script in $knownIssueScripts) { $functions = Get-FunctionFromFile -FilePath $script.FullName -Verb 'Test' if ($functions) { foreach ($function in $functions) { "Executing {0}" -f $function | Trace-Output -Level:Verbose $result = Invoke-Expression -Command $function $object = [PSCustomObject]@{ Name = $function Result = $result.Result Properties = $result.Properties } [void]$arrayList.Add($object) } } } $Global:SdnDiagnostics.Credential = $null $Global:SdnDiagnostics.NcRestCredential = $null $Global:SdnDiagnostics.Cache.KnownIssues = $arrayList "Results for known issues have been saved to {0} for further analysis. Use Get-SdnKnownIssue to examine the results." -f '$Global:SdnDiagnostics.Cache.KnownIssues' | Trace-Output return $Global:SdnDiagnostics.Cache.KnownIssues } catch { $Global:SdnDiagnostics.Credential = $null $Global:SdnDiagnostics.NcRestCredential = $null "{0}`n{1}" -f $_.Exception, $_.ScriptStackTrace | Trace-Output -Level:Error } } |