PowerCLI Reference

Get-HCXService

Synopsis

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

Syntax

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

Related Commands

Detailed Description

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.

Parameters

Name	Type	Description	Required?	Pipeline Input	Default Value
Name	String[]	Specifies a name for the service type ID that you want to retrieve.	false	False
Server	CisServer[]	Specifies the HCX servers 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.	false	False

Return Type

System.Management.Automation.PSObject

Notes

Examples

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

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

Retrieves the binding for the specified service.