> ## 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 Proxmox

> Capturing Proxmox clusters with nodes, virtual machines, Linux containers and bridges.

The *Proxmox* scan module captures Proxmox clusters with their nodes, virtual
machines, Linux containers and bridges. It requires a connected
[gateway](/docs/en/scan/gateway-install).

## Captured data

The scan creates assets of these types:

| Type | Groups |
| - | - |
| *Proxmox* | General (Configuration, Status), Storage & Backup (Storage Overview, Backup Overview, Replications), Access Control (Permission Assignments, Authentication Sources, Permission Profiles, User Accounts, API Tokens, User Groups), Software-Defined Networking (Controller, Zones, Networks, IPAM, DNS), Security & Access (ACME, Firewall), High Availability (HA Groups, HA Rules, HA Management, HA State), Resource Allocation (Directory Mappings, PCI Device Mappings, USB Device Mappings), Advanced Features (Pools, Ceph) |
| *Proxmox Node* | Configuration (Version Information, Status), Hardware & Storage (Hardware, Disks, Networks), Enterprise Features (Ceph, Certificates, Subscription) |
| *Proxmox VM* | General (Configuration, Snapshots, Firewall Rules), VM Agent (Operating System, Time Zone, Users, Agent Version, Disk Details, Network Interfaces) |
| *Proxmox Linux Container* | General (Configuration, Snapshots, Firewall Rules) |
| *Proxmox Bridge* | Configuration (Options) |

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 Proxmox cluster per row, as an address or hostname.

The *Credentials* column must be filled, with an entry of the type
*User Account*. Enter the user name with its realm, such as `docusnap@pam`. An
entry in *Credentials for all targets* applies to every row without an
assignment of its own.

## Prerequisites

The scan connects to the cluster over HTTPS.

### Ports and protocols

| Protocol | Port | Transport |
| - | - | - |
| HTTPS | 8006 | TCP |

### Permissions

* The account is a user with a realm, such as `docusnap@pam`, and has read
  permissions on the cluster.

### Network requirements

* The firewall allows the port.
* If a proxy sits in between, it may need exceptions.
* One node of the cluster is reachable.

If the gateway cannot reach the cluster, scan it with the
`Discovery-Proxmox.exe` scan script from a computer that reaches the
cluster—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.