gsadmin/PSProxmox

Fork 0

mirror of https://github.com/Grace-Solutions/PSProxmox.git synced 2026-08-10 15:16:57 +00:00

Files

T

Alphaeus Mote c4bea36ece Add comprehensive documentation and examples

2025-04-28 14:59:49 -04:00

3.4 KiB

Raw Blame History

Get-ProxmoxVM

Gets virtual machines from Proxmox VE.

Syntax

Get-ProxmoxVM
   -Connection <ProxmoxConnection>
   [-Node <String>]
   [-VMID <Int32>]
   [-RawJson]
   [<CommonParameters>]

Description

The Get-ProxmoxVM cmdlet retrieves virtual machines from Proxmox VE. You can retrieve all VMs, VMs on a specific node, or a specific VM by ID.

Parameters

-Connection

The connection to the Proxmox VE server.

Type: ProxmoxConnection
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Node

The node to get VMs from. If not specified, VMs from all nodes will be returned.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-VMID

The ID of the VM to get. If not specified, all VMs will be returned.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-RawJson

Whether to return the raw JSON response instead of parsed objects.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

PSProxmox.Models.ProxmoxVM

System.String

Notes

This cmdlet requires a connection to a Proxmox VE server. Use Connect-ProxmoxServer to establish a connection.
If the -RawJson parameter is specified, the raw JSON response will be returned instead of parsed objects.
If the -VMID parameter is specified and the VM is not found, an error will be thrown.

Examples

Example 1: Get all VMs

$connection = Connect-ProxmoxServer -Server "proxmox.example.com" -Credential (Get-Credential)
$vms = Get-ProxmoxVM -Connection $connection

This example gets all VMs from all nodes.

Example 2: Get VMs on a specific node

$connection = Connect-ProxmoxServer -Server "proxmox.example.com" -Credential (Get-Credential)
$vms = Get-ProxmoxVM -Connection $connection -Node "pve1"

This example gets all VMs on the node "pve1".

Example 3: Get a specific VM by ID

$connection = Connect-ProxmoxServer -Server "proxmox.example.com" -Credential (Get-Credential)
$vm = Get-ProxmoxVM -Connection $connection -VMID 100

This example gets the VM with ID 100.

Example 4: Get the raw JSON response

$connection = Connect-ProxmoxServer -Server "proxmox.example.com" -Credential (Get-Credential)
$json = Get-ProxmoxVM -Connection $connection -RawJson

This example gets the raw JSON response for all VMs.

3.4 KiB Raw Blame History