Get-VsphereVmInfo

NAME Get-VsphereVmInfo



SYNOPSIS

Retrieves additional VM details such as Guest OS information or VM state.





SYNTAX

Get-VsphereVmInfo -InputObject <PSObject[]> -VmInfoType {VM Guest Info | VM Status} -Connection <Hashtable>

[<CommonParameters>]



Get-VsphereVmInfo -VmId <String[]> -VmInfoType {VM Guest Info | VM Status} -Connection <Hashtable>

[<CommonParameters>]





DESCRIPTION

Retrieves additional VM details such as Guest OS information or VM state.





PARAMETERS

-InputObject <PSObject[]>

Object representing the VM for which additional information is to be retrieved. Use Get-VsphereObject to

retrieve input object.



Required? true

Position? named

Default value

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-VmInfoType <String>

Specifies the type of information to be retrieved. Accepted values are:

VM Guest Info

VM Status



Required? true

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Connection <Hashtable>

Specifies connection information to the vCenter server. For example:

@{ServerUrl='<vCenter Server URL>';User='<user>';Password='<password>';LicenseKey=<license

key>;SkipCertificateValidation=$false}



Required? true

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-VmId <String[]>

ID (managed object reference) of the VM.



Required? true

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.Management.Automation.PSObject[]







OUTPUTS

System.Management.Automation.PSObject

The list of outputs returned by the cmdlet varies based on the specified Info Type. Refer to the Integration

Module User Guide for details on each set of outputs.







RELATED LINKS