Get-VIApplianceService Command | Vmware PowerCLI Reference

Get-VIApplianceService

This cmdlet retrieves the vCenter appliance services. You can filter services by name and state.

Syntax

Get-VIApplianceService
-Id < String[] >
[-ProgressAction < ActionPreference > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Id String[] named
optional ProgressAction ActionPreference named
Get-VIApplianceService
[-Name < String[] > ]
[-ProgressAction < ActionPreference > ]
[-Server < VIServer > ]
[-State < ApplianceServiceState > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional Name String[] named
Specifies the names of the services to be returned.
optional ProgressAction ActionPreference named
optional Server VIServer named
Specifies the vCenter Server systems 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 server. For more information about default servers, see the description of the Connect-VIServer cmdlet.
optional State ApplianceServiceState named
Specifies the state of the services to be returned. The valid values are 'Started', 'Stopped', 'Starting' and 'Stopping'.

Output

ViApplianceServiceInfo

Examples

Example 1

Get-VIApplianceService

Retrieves all appliance services of the vCenter Server system you are currently connected to.

Example 2

Get-VIApplianceService -Name systemd* -State Started

Retrieves all started appliance services that include 'systemd*' in their name from the vCenter Server system you are currently connected to.

Example 3

Get-VIApplianceService -Id '/VIServer=vsphere.local\[email protected]:443/ViApplianceService=sshd/'

Retrieves the appliance service with the specified Id.

Related Commands

VIApplianceService

This cmdlet retrieves the vCenter appliance services.

This cmdlet restarts the specified appliance service(s).

This cmdlet starts the specified appliance service(s).

This cmdlet stops the specified appliance service(s).