Get-XenHostMetrics
Gets the HostMetrics objects in the pool.
Syntax
Get-XenHostMetrics [[-Ref] <XenRef[Host_metrics]>] [-BestEffort]
[-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenHostMetrics [-Uuid] <guid> [-BestEffort] [-SessionOpaqueRef <string>]
[<CommonParameters>]
Description
Retrieves the HostMetrics objects in the pool. With no parameters the cmdlet returns the whole collection; use -Uuid or -Ref to select one.
HostMetrics: The metrics associated with a host.
Parameters
-BestEffort
If set, the cmdlet continues processing further objects instead of throwing a terminating error when an operation fails for one object.
| Attribute | Value |
|---|---|
| Type | SwitchParameter |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Ref
The HostMetrics object to operate on, specified by its opaque reference.
| Attribute | Value |
|---|---|
| Type | XenRef[Host_metrics] |
| Required | False |
| Position | 0 |
| Accepts pipeline input | True (ByPropertyName) |
| Aliases | opaque_ref |
-SessionOpaqueRef
The session object on which to run the cmdlet. This overrides the default session and lets you target a specific open XenServer connection.
| Attribute | Value |
|---|---|
| Type | string |
| Required | False |
| Position | Named |
| Accepts pipeline input | False |
-Uuid
The UUID of the HostMetrics to operate on.
| Attribute | Value |
|---|---|
| Type | guid |
| Required | True |
| Position | 0 |
| Accepts pipeline input | True (ByPropertyName) |
Inputs
-
XenRef[Host_metrics] -
guid
Outputs
-
Host_metrics[]
Examples
Example 1: List every HostMetrics
PS> Get-XenHostMetrics
Retrieves every HostMetrics object in the pool. With no parameters the cmdlet fetches the whole collection.
Example 2: Retrieve one HostMetrics by uuid
PS> Get-XenHostMetrics -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Retrieves a single HostMetrics. -Uuid is the way to be sure of exactly one object.
Example 3: Retrieve one HostMetrics by reference
PS> Get-XenHostMetrics -Ref OpaqueRef:f433bf7b-2b0c-5f53-7018-7d195addb3ca
Retrieves a single HostMetrics. -Ref takes the opaque reference, which is what the API itself uses and what the records hold.
Related links
-
Class: HostMetrics
-
Using the XenServer PowerShell module