Skip to content

Latest commit

 

History

History
70 lines (59 loc) · 5.05 KB

README.md

File metadata and controls

70 lines (59 loc) · 5.05 KB
Raw

WindowsContainerNetworking-LoggingAndCleanupAide.ps1 - README

Basic Logs: Capture container host state for troubleshooting

To capture basic logs* to assist with container network troubleshooting, run this script without any arguments:

PS C:\> .\WindowsContainerNetworking-LoggingAndCleanupAide.ps1

Tracing: Capture logs for reproducible behavior

To capture logs for a specific, reproducible behavior/issue, run this script with the -CaptureTraces argument:

PS C:\> .\WindowsContainerNetworking-LoggingAndCleanupAide.ps1 -CaptureTraces

When the script is run with this option, it will prompt you to reproduce the behavior/issue that you would like to capture. After capturing the behavior, press any key to continue/end the script.

Host Cleanup: Stop/remove all Docker containers & user-defined container networks on your host

This script can be used to refresh the container-related network components on your host. To perform a host network cleanup, run this script with the -Cleanup option:

PS C:\> .\WindowsContainerNetworking-LoggingAndCleanupAide.ps1 -Cleanup

When run with this option, the script will:

  • Stop/remove all containers on the host, regardless of their state (i.e. runs docker rm -f <CONTAINER ID> for all containers)
  • Remove all container networks on the host (i.e. runs docker network rm -f <NETWORK ID> for all user-defined networks)

Extended Host Cleanup: Remove/reset container networking components on your host

In addition to the basic -Cleanup option, there is also the -ForceDeleteAllSwitches option. Use these options together to force an extended host cleanup.

WARNING: This option sparks a system cleanup that could negatively impact the configuration of virtual machines, and other components on your system that were created/configured outside of the context of Docker. Before using this option, read the details provided below to ensure you understand how it could impact your system.

PS C:\> .\WindowsContainerNetworking-LoggingAndCleanupAide.ps1 -Cleanup -ForceDeleteAllSwitches

When run with the -Cleanup and -ForceDeleteAllSwitches option, the script will:

  • Remove Switch registry keys on the host (HKLM:\SYSTEM\CurrentControlSet\Services\vmsmp\parameters\SwitchList)
  • Remove NIC registry keys on the host (HKLM:\SYSTEM\CurrentControlSet\Services\vmsmp\parameters\NicList)
  • Unbind ALL physical network adapters (Get-NetAdapter) from ANY Hyper-V Virtual Switch components to which they are attached (Disable-NetAdapterBinding -Name <ADAPTER NAME> -ComponentID vms_pp)
  • Remove the default 'nat' container network
  • If reboot is required, remove the HNS.data file (C:\ProgramData\Microsoft\Windows\HNS\HNS.data)
  • Stop/remove all containers on the host, regardless of their state (i.e. runs docker rm -f <CONTAINER ID> for all containers)
  • Remove all container networks on the host (i.e. runs docker network rm -f <NETWORK ID> for all user-defined networks)

System Assumptions/Requirements - READ BEFORE RUNNING SCRIPT

WARNING: This script requires that the host machine is not running in swarm mode. The script will make sure the host is in an inactive swarm state. If the host is in swarm mode, the script will provide an option to leave swarm mode.

This script assumes the following about your system. Ensure these requirements are met before running this script on your system:

  • Docker Engine is installed and running
  • Microsoft Hyper-V role is enabled
  • The Windows Containers feature is installed

*Info/logs collected for capturing container host state

Whether it is run without arguments, or with any of the arguments above, as part of its basic logging functionality this script captures:

  • The Host Network Service (HNS) event log (c:\Windows\System32\winevt\Logs\Microsoft-Windows-Host-Network-Service-Admin.evtx)
  • The System event log (c:\Windows\System32\winevt\Logs\System.evtx)
  • The HNS.data file (c:\ProgramData\Microsoft\Windows\HNS\HNS.data)
  • Information on the Virtual Filtering Platform (VFP), virtual switch extension which is running as a service on the host (Get-Service vfpext)
  • VFP policy information for all virtual switches
  • Docker version (docker -v)
  • Docker info (docker info)
  • Information on current TCP/IP, DHCP and DNS network configuration values on the host (ipconfig /allcompartments /all)
  • The virtual switches on this host (Get-VMSwitch)
  • The NAT objects on this host (Get-NetNat)
  • The static mappings configured on the host's NAT instances (Get-NetNatStaticMapping)
  • The network adapters on this host (Get-NetAdapter -IncludeHidden)
  • The bindings for the network adapters on this host (Get-NetAdapterBinding -IncludeHidden)
  • The status of the Windows NAT driver (Get-Service winnat)
  • The status of the Windows Firewall Service (Get-Service mpssvc)
  • The HNS registry settings (Get-ChildItem HKLM:\SYSTEM\CurrentControlSet\Services\hns)
  • The Hyper-V registry settings (Get-ChildItem HKLM:\SYSTEM\CurrentControlSet\Services\vmsmp)