Get-CIVM
This cmdlet retrieves virtual machines in the cloud and filters them by the provided parameters.
Syntax
[-Org <Org[]>]
[-OrgVdc <OrgVdc[]>]
[-OrgVdcNetwork <OrgNetworkBase[]>]
[-Server <CIServer[]>]
[-Status <CIVAppStatus[]>]
[-VApp <CIVApp[]>]
[CommonParameters]
Parameters
Required | Parameter Name | Type | Position | Features | Description |
---|---|---|---|---|---|
optional |
|
String[] | named |
|
Specifies the name of the cloud virtual machines you want to retrieve. | optional |
|
Org[] | named |
|
Specifies from which organizations you want to retrieve virtual machines. | optional |
|
OrgVdc[] | named |
|
Specifies the organization vDCs for which you want to retrieve virtual machines. | optional |
|
OrgNetworkBase[] | named |
|
Specifies the organization vDC networks to which the virtual machines are connected. | optional |
|
CIServer[] | named |
|
Specifies the cloud servers on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-CIServer. | optional |
|
CIVAppStatus[] | named |
|
Specifies the status of the virtual machines you want to retrieve. | optional |
|
CIVApp[] | named |
|
Specifies the vApps to which the virtual machines you want to retrieve belong. |
Parameters
Required | Parameter Name | Type | Position | Features | Description |
---|---|---|---|---|---|
required |
|
String[] | named |
|
Specifies the IDs of the cloud virtual machines you want to retrieve. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list. | optional |
|
CIServer[] | named |
|
Specifies the cloud servers on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-CIServer. |
Output
VMware.VimAutomation.Cloud.Types.V1.CIVM
Examples
Example 1
Gets all visible virtual machines for the current user.
Example 2
Gets a single virtual machine by its name.
Example 3
Gets all virtual machines that match a defined string by name.
Example 4
Gets a virtual machine with a given ID.
Example 5
Gets all visible virtual machines within an organization.
Example 6
Gets all visible virtual machines within an organization network.
Example 7
Gets all visible virtual machines within an organization network (pipeline).
Example 8
Gets all visible virtual machines within an organization's virtual datacenter.
Example 9
Get all visible virtual machines within an organization's virtual datacenter by using a pipeline syntax.
Example 10
Gets virtual machines running a particular VApp.
Example 11
Gets virtual machines running a particular VApp (pipeline).
Example 12
Gets virtual machines by status (all powered on and suspended VMs).
Related Commands
CIVM
CIVMGuest