Set-VamiServiceStatus

Synopsis

Starts, stops, or restarts a service on a vCenter Server instance.

Syntax

Set-VamiServiceStatus [-server] <String> [-user] <String> [-pass] <String> [-state] <String> [-nolog] [-service] <String> [<CommonParameters>]

Description

The Set-VamiServiceStatus cmdlet starts, stops, or restarts a specified management appliance service on a specified vCenter Server instance.

Examples

Example 1

Set-VamiServiceStatus -server sfo-m01-vc01.sfo.rainpole.io -user administrator@vsphere.local -pass VMw@re1! -service wcp -state "start"

This example connects to a vCenter Server instance and starts the wcp service.

Set-VamiServiceStatus -server sfo-m01-vc01.sfo.rainpole.io -user <administrator@vsphere.local>  -pass VMw@re1! -service wcp -nolog -state "restart"

This example connects to a vCenter Server instance and restarts the wcp service without log messages in the output.

Parameters

-server

The FQDN of the vCenter Server.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-user

The username to authenticate to vCenter Server.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-pass

The password to authenticate to vCenter Server.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-state

The state of the servcie. The values can be one amongst ("start", "stop", "restart").

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-nolog

The switch to supress selected log messages.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-service

The name of the service. The values can be one amongst ("analytics", "applmgmt", "certificateauthority", "certificatemanagement", "cis-license", "content-library", "eam", "envoy", "hvc", "imagebuilder", "infraprofile", "lookupsvc", "netdumper", "observability-vapi", "perfcharts", "pschealth", "rbd", "rhttpproxy", "sca", "sps", "statsmonitor", "sts", "topologysvc", "trustmanagement", "updatemgr", "vapi-endpoint", "vcha", "vlcm", "vmcam", "vmonapi", "vmware-postgres-archiver", "vmware-vpostgres", "vpxd", "vpxd-svcs", "vsan-health", "vsm", "vsphere-ui", "vstats", "vtsdb", "wcp").

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Common Parameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.