Get-CIVM

Syntax

• default
• byId

Get-CIVM

[-Name  <String[]>]
[-Org  <Org[]>]
[-OrgVdc  <OrgVdc[]>]
[-OrgVdcNetwork  <OrgNetworkBase[]>]
[-Server  <CIServer[]>]
[-Status  <CIVAppStatus[]>]
[-VApp  <CIVApp[]>]
[CommonParameters]

---

Parameters

Required	Parameter Name	Type	Position	Features	Description
optional	Name	String[]	named	wildcards	Specifies the name of the cloud virtual machines you want to retrieve.
optional	Org	Org[]	named	wildcards pipeline	Specifies from which organizations you want to retrieve virtual machines.
optional	OrgVdc	OrgVdc[]	named	wildcards pipeline	Specifies the organization vDCs for which you want to retrieve virtual machines.
optional	OrgVdcNetwork	OrgNetworkBase[]	named	pipeline	Specifies the organization vDC networks to which the virtual machines are connected.
optional	Server	CIServer[]	named	wildcards	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	Status	CIVAppStatus[]	named	wildcards	Specifies the status of the virtual machines you want to retrieve.
optional	VApp	CIVApp[]	named	wildcards pipeline	Specifies the vApps to which the virtual machines you want to retrieve belong.

Get-CIVM

-Id  <String[]>
[-Server  <CIServer[]>]
[CommonParameters]

---

Parameters

Required	Parameter Name	Type	Position	Features	Description
required	Id	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	Server	CIServer[]	named	wildcards	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

Get-CIVM

Gets all visible virtual machines for the current user.

Example 2

Get-CIVM -Name "MyVM"

Gets a single virtual machine by its name.

Example 3

Get-CIVApp -Name "*DB*"

Gets all virtual machines that match a defined string by name.

Example 4

Get-CIVM -ID $myVMId

Gets a virtual machine with a given ID.

Example 5

Get-CIVM -Org "MyOrganization"

Gets all visible virtual machines within an organization.

Example 6

Get-CIVM -OrgNetwork "OrgNetwork1"

Gets all visible virtual machines within an organization network.

Example 7

Get-OrgNetwork -Name "OrgNetwork1" | Get-CIVM

Gets all visible virtual machines within an organization network (pipeline).

Example 8

Get-CIVM -OrgVdc "MyOrgVDC1"

Gets all visible virtual machines within an organization's virtual datacenter.

Example 9

Get-OrgVdc -Name "OrgVdc1" | Get-CIVM

Get all visible virtual machines within an organization's virtual datacenter by using a pipeline syntax.

Example 10

Get-CIVM -VApp "MyVApp"

Gets virtual machines running a particular VApp.

Example 11

Get-CIVApp "MyVApp" | Get-CIVM

Gets virtual machines running a particular VApp (pipeline).

Example 12

Get-CIVM -Status "PoweredOn", "Suspended"

Gets virtual machines by status (all powered on and suspended VMs).

Related Commands