knownIssues/Test-SdnKINetworkInterfacePlacement.ps1
|
# Copyright (c) Microsoft Corporation. # Licensed under the MIT License. function Test-SdnKINetworkInterfacePlacement { <# .SYNOPSIS Validates the placement of Network Controller Network Interface API placement compared to Hypervisor. .PARAMETER NcUri Specifies the Uniform Resource Identifier (URI) of the network controller that all Representational State Transfer (REST) clients use to connect to that controller. .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-SdnKINetworkInterfacePlacement .EXAMPLE PS> Test-SdnKINetworkInterfacePlacement -Credential (Get-Credential) .EXAMPLE PS> Test-SdnKINetworkInterfacePlacement -Credential (Get-Credential) -NcRestCredential (Get-Credential) #> [CmdletBinding()] param ( [Parameter(Mandatory = $false)] [Uri]$NcUri = $Global:SdnDiagnostics.EnvironmentInfo.NcUrl, [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 ) try { "Validate placement of network interfaces between Network Controller and Hypervisor" | Trace-Output if($null -eq $NcUri){ throw New-Object System.NullReferenceException("Please specify NcUri parameter or execute Get-SdnInfrastructureInfo to populate environment details") } # if NcRestCredential parameter not defined, check to see if global cache is populated if(!$PSBoundParameters.ContainsKey('NcRestCredential')){ if($Global:SdnDiagnostics.NcRestCredential){ $NcRestCredential = $Global:SdnDiagnostics.NcRestCredential } } # if Credential parameter not defined, check to see if global cache is populated if(!$PSBoundParameters.ContainsKey('Credential')){ if($Global:SdnDiagnostics.Credential){ $Credential = $Global:SdnDiagnostics.Credential } } $issueDetected = $false $arrayList = [System.Collections.ArrayList]::new() $servers = Get-SdnServer -NcUri $NcUri.AbsoluteUri -ManagementAddressOnly -Credential $NcRestCredential $networkInterfaces = Get-SdnResource -NcUri $ncUri.AbsoluteUri -ResourceType:NetworkInterfaces -Credential $NcRestCredential $networkAdapters = Get-SdnVMNetworkAdapter -ComputerName $servers -Credential $Credential -AsJob -Timeout 600 -PassThru $driftedNetworkInterfaces = Test-NetworkInterfaceLocation -NetworkControllerNetworkInterfaces $networkInterfaces -VMNetworkAdapters $networkAdapters if($driftedNetworkInterfaces){ # we want to focus on instances where network controller api does not have a valid server reference to where the mac address resides # this may be false positve if the VM had live migrated recently and nchostagent has not updated network controller if($driftedNetworkInterfaces.nc_host -icontains 'NullServerReference'){ foreach($result in $driftedNetworkInterfaces){ "SDN API is not aware that interface {0} associated with virtual machine {1} exists on {2}`n`tThis may be a transient exception that can be safely ignored if no issues reported with virtual machine." ` -f $result.macAddress, $result.vmName, $result.hyperv_host | Trace-Output -Level:Warning } } else { # in this scenario, the serverref and hypervisor server values are mismatched indicating # we have a hard drift between network controller and dataplane, which would result in stale/outdated policies foreach($result in $driftedNetworkInterfaces){ "{0}: Network Controller believes {1} exists on {2} while hypervisor is reporting it exists on {3}" ` -f $result.macAddress, $result.vmName, $result.nc_host, $result.hyperv_host | Trace-Output -Level:Error [void]$arrayList.Add($result) $issueDetected = $true } } } return [PSCustomObject]@{ Result = $issueDetected Properties = $arrayList } } catch { "{0}`n{1}" -f $_.Exception, $_.ScriptStackTrace | Trace-Output -Level:Error } } |