> ## Documentation Index
> Fetch the complete documentation index at: https://www.docusnap.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Scanning Hyper-V

> Capturing Hyper-V hosts with their host configuration, virtual switches and virtual machines.

The *Hyper-V* scan module captures Hyper-V hosts with their host configuration,
their virtual switches and their virtual machines. It requires a connected
[gateway](/docs/en/scan/gateway-install).

## Captured data

The scan creates assets of these types:

| Type | Groups |
| - | - |
| *Hyper-V Server* | Host Configuration (Hyper-V Host Settings, Virtual Switches, Cluster Configuration, Replication Service, OS Type Detection), Virtual Machines |
| *Hyper-V VM* | VM Settings (BIOS Boot Order, Checkpoints, Configuration, Security Settings), Services & Availability (Cluster Operations, Integration Services, OS Type Detection, Replica Service Configuration), Hardware Configuration (CPU Details, HD Details, Network Adapter Details, Storage Requirements) |
| *Hyper-V Switch* | the overview only |

How the detail pages of the types are structured is described in
[Virtualization](/docs/en/assets/virtualization).

## Setting up the job

The wizard follows the standard path *Basics* › *Targets* › *Schedule* ›
*Summary*—see [Creating a Scan Job](/docs/en/scan/create-inventory). The
*Targets* step is what sets this module apart.

Each row carries the columns *IP/Hostname* and *Credentials*. *IP/Hostname*
takes one Hyper-V host per row.

The *Credentials* column may stay empty. The scan then runs under the gateway's
service account, and that account needs the rights under
[Permissions](#permissions). An entry in *Credentials for all targets* applies
to every row without an assignment of its own.

## Prerequisites

### Ports and protocols

| Protocol | Port | Transport |
| - | - | - |
| NetBIOS Name Service, NetBIOS Datagram Service | 137, 138 | UDP |
| NetBIOS Session Service, SMB / CIFS over TCP | 139, 445 | TCP |
| RPC, dynamic ports | 49152–65535 | TCP/UDP |

### Permissions

* The account is a local administrator on the Hyper-V host, given as
  `DOMAIN\user` or `user@domain.local`.

### Network requirements

* The firewall allows the ports above.
* .NET Framework 4.6.1 or later is installed on the host.
* PowerShell version 3 or later can run on the host.
* The account has access to `C:\Windows\Temp` and to the host's `IPC$` share.

Scan Hyper-V hosts that the gateway cannot reach with the
`Discovery-HyperV.exe` scan script directly on the host—see
[Scanning by Script](/docs/en/scan/scan-by-script).

## Related

After it is created, the job appears among the jobs; how you watch and adjust
it is in [Managing Jobs](/docs/en/scan/manage-jobs). How you provide and run the
scan scripts and read in their results is in
[Scanning by Script](/docs/en/scan/scan-by-script).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.