Home

Welcome to the SdnDiagnostics wiki!

Description

SdnDiagnostics is a PowerShell module that is designed to simplify the diagnostic troubleshooting and data collection process related to Microsoft Software Defined Network.

Installation

SdnDiagnostics is published to the PowerShell Gallery as part of a GitHub Action when changes are pushed to main. To install the module on your system, use Install-Module -Name SdnDiagnostics.

• Note: It's recommended to use the latest version of PackageManagement. Update-Module -Name PackageManagement

Once you have installed SdnDiagnostics module to your workstation, you can import the module and seed out the SdnDiagnostics module to the appropriate nodes within the SDN fabric to ensure all nodes are running the same version of SdnDiagnostics.

Import-Module -Name SdnDiagnostics -Force

$environmentDetails = Get-SdnInfrastructureInfo -NetworkController 'NC01'
Install-SdnDiagnostics -ComputerName $environmentDetails.FabricNodes

Alternatively, a NuGet package is published every so often to NuGet.

Updates

As mentioned previously, the module published on the PowerShell Gallery updates whenever a push is performed on the main branch, so the module will be updated frequently to push code fixes or add new functionality. To check the latest package that is published on PowerShell Gallery, use Find-Module -Name SdnDiagnostics and compare with the results returned for Get-Module -Name SdnDiagnostics. To update the module, run:

Update-Module -Name SdnDiagnostics
Import-Module -Name SdnDiagnostics -Force

Once you have updated the SdnDiagnostics module, use the steps in installation to seed out the module to the rest of the nodes in the SDN fabric.

Accounts to run PowerShell

By default, the PowerShell commands in this module will run as the current logon user. Some of the commands accept the -Credential or -NcRestCredential parameter to specify different account. There are two type of accounts used by SDN to authorize access. See NC Security for more information.

• -Credential is used to specify account that have local admin privilege for the servers like NC, MUX, Gateway and SDN Host.
• -NcRestCredential is used to specify account that have access NC REST API. It is member of ClientSecurityGroup from Get-NetworkController

Example usage of the two credential can be found at Get-SdnInfrastructureInfo

Basic Troubleshooting

To help facilitate automated troubleshooting, there are several functions that do the bulk of the work.

• Get-SdnInfrastructureInfo: Connects to Network Controller to then learn about the underlying SDN fabric. This information is then stored into a global cache $Global:SdnDiagnostics.EnvironmentInfo that can be referenced later. Other functions will also leverage this cache as well to simplify the overall user experience. To see full list of parameters supported with the function, review https://github.com/microsoft/SdnDiagnostics/wiki/Get-SdnInfrastructureInfo.
• Debug-SdnFabricInfrastructure: Executes a series of validation tests to check the current state of the environment. To see full list of parameters supported with the function, review https://github.com/microsoft/SdnDiagnostics/wiki/Debug-SdnFabricInfrastructure.
  • Example:
• Test-SdnKnownIssue: Executes a series of checks to look for common issues. To see full list of parameters supported with the function, review https://github.com/microsoft/SdnDiagnostics/wiki/Test-SdnKnownIssue.
  • Example:
• Start-SdnDataCollection: Performs automated data collection by gathering the appropriate configuration details and logs for the role(s) or computers specified. To see a full list of the parameters supported with the function, review https://github.com/microsoft/SdnDiagnostics/wiki/Start-SdnDataCollection.
  • Example: