| // Licensed to the Apache Software Foundation (ASF) under one |
| // or more contributor license agreements. See the NOTICE file |
| // distributed with this work for additional information |
| // regarding copyright ownership. The ASF licenses this file |
| // to you under the Apache License, Version 2.0 (the |
| // "License"); you may not use this file except in compliance |
| // with the License. You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, |
| // software distributed under the License is distributed on an |
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| // KIND, either express or implied. See the License for the |
| // specific language governing permissions and limitations |
| // under the License. |
| package org.apache.cloudstack.api.command.admin.systemvm; |
| |
| |
| import org.apache.cloudstack.acl.SecurityChecker.AccessType; |
| import org.apache.cloudstack.api.ACL; |
| import org.apache.cloudstack.api.APICommand; |
| import org.apache.cloudstack.api.ApiCommandResourceType; |
| import org.apache.cloudstack.api.ApiConstants; |
| import org.apache.cloudstack.api.ApiErrorCode; |
| import org.apache.cloudstack.api.BaseAsyncCmd; |
| import org.apache.cloudstack.api.Parameter; |
| import org.apache.cloudstack.api.ServerApiException; |
| import org.apache.cloudstack.api.response.SystemVmResponse; |
| import org.apache.cloudstack.context.CallContext; |
| |
| import com.cloud.event.EventTypes; |
| import com.cloud.user.Account; |
| import com.cloud.vm.VirtualMachine; |
| |
| @APICommand(name = "startSystemVm", responseObject = SystemVmResponse.class, description = "Starts a system virtual machine.", entityType = {VirtualMachine.class}, |
| requestHasSensitiveInfo = false, responseHasSensitiveInfo = false) |
| public class StartSystemVMCmd extends BaseAsyncCmd { |
| |
| |
| ///////////////////////////////////////////////////// |
| //////////////// API parameters ///////////////////// |
| ///////////////////////////////////////////////////// |
| @ACL(accessType = AccessType.OperateEntry) |
| @Parameter(name = ApiConstants.ID, |
| type = CommandType.UUID, |
| entityType = SystemVmResponse.class, |
| required = true, |
| description = "The ID of the system virtual machine") |
| private Long id; |
| |
| ///////////////////////////////////////////////////// |
| /////////////////// Accessors /////////////////////// |
| ///////////////////////////////////////////////////// |
| |
| public Long getId() { |
| return id; |
| } |
| |
| ///////////////////////////////////////////////////// |
| /////////////// API Implementation/////////////////// |
| ///////////////////////////////////////////////////// |
| |
| public static String getResultObjectName() { |
| return "systemvm"; |
| } |
| |
| @Override |
| public long getEntityOwnerId() { |
| Account account = CallContext.current().getCallingAccount(); |
| if (account != null) { |
| return account.getId(); |
| } |
| |
| return Account.ACCOUNT_ID_SYSTEM; // no account info given, parent this command to SYSTEM so ERROR events are tracked |
| } |
| |
| @Override |
| public String getEventType() { |
| VirtualMachine.Type type = _mgr.findSystemVMTypeById(getId()); |
| if (type == VirtualMachine.Type.ConsoleProxy) { |
| return EventTypes.EVENT_PROXY_START; |
| } else { |
| return EventTypes.EVENT_SSVM_START; |
| } |
| } |
| |
| @Override |
| public String getEventDescription() { |
| return "starting system vm: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()); |
| } |
| |
| @Override |
| public ApiCommandResourceType getApiResourceType() { |
| return ApiCommandResourceType.SystemVm; |
| } |
| |
| @Override |
| public Long getApiResourceId() { |
| return getId(); |
| } |
| |
| @Override |
| public void execute() { |
| CallContext.current().setEventDetails("Vm Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getId())); |
| VirtualMachine instance = _mgr.startSystemVM(getId()); |
| if (instance != null) { |
| SystemVmResponse response = _responseGenerator.createSystemVmResponse(instance); |
| response.setResponseName(getCommandName()); |
| setResponseObject(response); |
| } else { |
| throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Fail to start system vm"); |
| } |
| } |
| } |