Get-OMResource
This cmdlet retrieves VMware Aria Operations resource objects.
Syntax
-Id
< String[] >
[-ProgressAction
< ActionPreference > ]
[-Server
< OMServer[] > ]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required
|
Id | String[] | named |
|
Filters the resource objects by ID. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | Server | OMServer[] | named |
|
Specifies the VMware Aria Operations server from which you want to retrieve alerts. The value can be the connection object returned by the Connect-OMServer cmdlet or the object's name, which can be the IP or DNS address of the server machine. |
-Entity
< VIObjectCore[] >
[-ProgressAction
< ActionPreference > ]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required
|
Entity | VIObjectCore[] | named |
|
Specifies the solution object whose respective VMware Aria Operations resource counterpart to retrieve. The supported object types from the vCenter Server solution are Cluster Compute Resource, Datacenter, Datastore, Datastore Cluster, Folder, Host System, Resource Pool, vCenter Server, Virtual Machine, vSphere Distributed Port Group, and vSphere Distributed Switch. |
| optional | ProgressAction | ActionPreference | named |
|
[-AdapterKind
< String[] > ]
[-Name
< String[] > ]
[-Orphaned
]
[-ProgressAction
< ActionPreference > ]
[-ResourceKind
< String[] > ]
[-Server
< OMServer[] > ]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional | AdapterKind | String[] | named |
|
Filters the resource objects by the type of adapter that manages them. If AdapterKind is not specified, resource objects from all adapter types are retrieved. |
| optional | Name | String[] | named |
|
Filters the resource objects by name. |
| optional | Orphaned | SwitchParameter | named |
|
If specified, retrieves only resources whose State property is empty. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | ResourceKind | String[] | named |
|
Filters the resource objects by the type of the resource. If ResourceKind is not specified, resource objects of all types are retrieved. |
| optional | Server | OMServer[] | named |
|
Specifies the VMware Aria Operations server from which you want to retrieve alerts. The value can be the connection object returned by the Connect-OMServer cmdlet or the object's name, which can be the IP or DNS address of the server machine. |
Output
VMware.VimAutomation.vROps.Types.V1.OMResourceExamples
Example 1
$vCenterCluster = Get-Cluster 'MyCluster' $clusterResource = Get-OMResource -Entity $vCenterCluster
Retrieves the VMware Aria Operations resource object that is counterpart of the vCenter Server cluster object.
Example 2
Get-OMResource -Name 'MyResource'
Retrieves resource objects by name.
Example 3
Get-OMResource -AdapterKind VMWARE -ResourceKind HostSystem
Retrieves all VMware Aria Operations resource objects that represent vCenter Server instances.
Example 4
$omresource = Get-OMResource -Name 'MyResource' $omresource.ResourceStatus
Retrieves the resource status for all adapters monitoring the 'MyResource' resource object.
Related Commands
OMResource
This cmdlet retrieves VMware Aria Operations resource objects.