Get-HCXService Command | Vmware PowerCLI Reference

Get-HCXService

This cmdlet retrieves PSObject objects that represent a proxy to an HCX API service and can be used to invoke the operations of the HCX API service.Every service proxy has a top-level Help property that contains documentation about the service's methods, parameters, constants, and so on. The Help object is hierarchical and mirrors the rest of the service's methods, parameters, constants, and so on. You can use the Help object for easy creation of parameters that the service methods accept through a method named "Create".The "Create" method is available for the following objects: - A parameter.-Elements of a parameter that is of type List, Set, or Optional. - Key and Value of a parameter of type Map.- Fields of a parameter of type Structure.

Syntax

Get-HCXService
[-Name < String[] > ]
[-Server < CisServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional Name String[] named
Specifies a name for the service type ID that you want to retrieve.
optional Server CisServer[] named
Specifies the HCX 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 the Connect-HCXServer cmdlet.

Output

System.Management.Automation.PSObject

Examples

Example 1

Get-HCXService -Name 'com.vmware.hcx.migration.migration'

Retrieves the binding for the specified service.

Related Commands

HCXService

This cmdlet retrieves PSObject objects that represent a proxy to an HCX API service.