Get-RASVM

NAME

Get-RASVM

SYNOPSIS

Retrieves VM list from a Provider in real-time.

SYNTAX

Get-RASVM [-ProviderId] <uint> [[-Id] <string>] [<CommonParameters>]

Get-RASVM [-SiteId <uint>] [<CommonParameters>]

DESCRIPTION

Retrieves virtual machine information from Provider servers.

It returns an array of objects of type VM, each containing properties of a virtual machine.

To see the complete list of object properties, use the Format-List cmdlet (see examples).

Note: the returned object contains only the major properties of a Virtual Machine; it does not include all of the settings supported in RAS.

PARAMETERS

-SiteId <uint> The site ID from which to retrieve VM information.

If the parameter is omitted, the site ID of the Licensing Server will be used.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ProviderId <uint> The name of the Provider server.

The name can be either FQDN or IP address, but you have to enter the actual name this server has in the RAS farm.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <string> The virtual machine UUID (universally unique identifier). UUID is assigned to a virtual machine by the hypervisor.

        Required?                    false

        Position?                    1

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

        This cmdlet supports the common parameters: Verbose, Debug,

        ErrorAction, ErrorVariable, WarningAction, WarningVariable,

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

        about_CommonParameters documentation.

INPUTS

-none-

OUTPUTS

EXAMPLES

---------- EXAMPLE 1 ----------

Get-RASVM 2 | Format-List

Retrieves a list of virtual machines from the specified Provider in the Licensing Server site.

To get the info from a specific site, use the -SiteId parameter.

The Format-List cmdlet formats the display output to include the complete list of returned VM properties. ---------- EXAMPLE 2 ----------

Get-RASVM -ProviderId 2 -SiteId 2

Retrieves a list of virtual machines from the specified Provider in the specified site. ---------- EXAMPLE 3 ----------

Get-RASVM | Format-List

Retrieves a list of all available virtual machines from the Licensing Server site.

To get the info from a specific site, specify the -SiteId parameter.

The Format-List cmdlet formats the display output to include the complete list of VM returned properties. ---------- EXAMPLE 4 ----------

Get-RASVM -ProviderId 2 -Id 42311235-09c5-ca15-337d-b9723015edf0

Retrieves information about a virtual machine specified by ID from the specified Provider server.

PreviousGet-RASVersion NextGet-RASWinDeviceGroup

Last updated 12 days ago