PowerCLI Reference

Get-HCXJob

Synopsis

This cmdlet retrieves a list of the HCX job.

Syntax

Get-HCXJob [-Id <String[]>] [-Server <HcxServer[]>] [-Job <HCXJob[]>] [<CommonParameters>]

Related Commands

Detailed Description

This cmdlet retrieves a list of the HCX job.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
IdString[]Specifies the Id of the Job.


Note: When a list of values is specified for the Id parameter, the returned objects have a Uid that matches exactly one of the string values in the list.
falseFalse
JobHCXJob[]Specifies the Job.falseTrue (ByValue)
ServerHcxServer[]Specifies the HCX Server systems on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-HCXServer cmdlet.falseFalse

Return Type

VMware.VimAutomation.Hcx.Types.V1.HCXJob

Notes

Examples

-------------------------- Example 1 --------------------------

PS C:\> Get-HCXJob -Id "myJobId"

Retrieves the job details for the specified Id.


Copyright © VMware, Inc. All rights reserved.