Files
PSProxmoxVE/docs/cmdlets/Get-PveVmGuestOsInfo.md
T
Clint Branham f6a2f843db docs: update cmdlet help via platyPS merge, fix generate-help.ps1
- generate-help.ps1: rewritten to use Update-MarkdownHelp (merge) by
  default, preserving hand-written descriptions and examples. Only
  New-MarkdownHelp on genuinely new cmdlets. -Force flag for full regen.
- docs/cmdlets: parameter metadata updated via platyPS merge, CRLF
  normalized to LF
- Removed stale Send-PveIso.md (cmdlet renamed to Send-PveFile)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-23 17:41:04 -05:00

2.0 KiB

external help file, Module Name, online version, schema
external help file Module Name online version schema
PSProxmoxVE.dll-Help.xml PSProxmoxVE 2.0.0

Get-PveVmGuestOsInfo

SYNOPSIS

Gets OS information from the QEMU guest agent.

SYNTAX

Get-PveVmGuestOsInfo [-Node] <String> [-VmId] <Int32> [-Session <PveSession>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Queries the QEMU guest agent running inside the specified VM for its operating system information, including OS name, kernel version, and machine type. The guest agent must be installed and running inside the VM.

EXAMPLES

Example 1

PS C:\> Get-PveVmGuestOsInfo -Node "pve1" -VmId 100

Returns OS information for VM 100.

PARAMETERS

-Node

The PVE node name.

Type: String
Parameter Sets: (All)
Aliases:

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

-Session

{{ Fill Session Description }}

Type: PveSession
Parameter Sets: (All)
Aliases:

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

-VmId

The VM identifier.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
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

System.Int32

OUTPUTS

PSProxmoxVE.Core.Models.Vms.PveGuestOsInfo

NOTES