| // 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.outofbandmanagement; |
| |
| import com.cloud.event.EventTypes; |
| import com.cloud.exception.ConcurrentOperationException; |
| import com.cloud.exception.InsufficientCapacityException; |
| import com.cloud.exception.NetworkRuleConflictException; |
| import com.cloud.exception.ResourceAllocationException; |
| import com.cloud.exception.ResourceUnavailableException; |
| import com.cloud.host.Host; |
| import org.apache.cloudstack.acl.RoleType; |
| import org.apache.cloudstack.api.APICommand; |
| import org.apache.cloudstack.api.ApiArgValidator; |
| import org.apache.cloudstack.api.ApiCommandJobType; |
| import org.apache.cloudstack.api.ApiConstants; |
| import org.apache.cloudstack.api.ApiErrorCode; |
| import org.apache.cloudstack.api.BaseAsyncCmd; |
| import org.apache.cloudstack.api.BaseCmd; |
| import org.apache.cloudstack.api.Parameter; |
| import org.apache.cloudstack.api.ServerApiException; |
| import org.apache.cloudstack.api.response.HostResponse; |
| import org.apache.cloudstack.api.response.OutOfBandManagementResponse; |
| import org.apache.cloudstack.context.CallContext; |
| import org.apache.cloudstack.outofbandmanagement.OutOfBandManagement.PowerOperation; |
| import org.apache.cloudstack.outofbandmanagement.OutOfBandManagementService; |
| |
| import javax.inject.Inject; |
| |
| @APICommand(name = IssueOutOfBandManagementPowerActionCmd.APINAME, description = "Initiates the specified power action to the host's out-of-band management interface", |
| responseObject = OutOfBandManagementResponse.class, requestHasSensitiveInfo = false, responseHasSensitiveInfo = false, |
| since = "4.9.0", authorized = {RoleType.Admin}) |
| public class IssueOutOfBandManagementPowerActionCmd extends BaseAsyncCmd { |
| public static final String APINAME = "issueOutOfBandManagementPowerAction"; |
| |
| @Inject |
| private OutOfBandManagementService outOfBandManagementService; |
| |
| ///////////////////////////////////////////////////// |
| //////////////// API parameters ///////////////////// |
| ///////////////////////////////////////////////////// |
| |
| @Parameter(name = ApiConstants.HOST_ID, type = CommandType.UUID, entityType = HostResponse.class, required = true, |
| validations = {ApiArgValidator.PositiveNumber}, description = "the ID of the host") |
| private Long hostId; |
| |
| @Parameter(name = ApiConstants.TIMEOUT, type = CommandType.LONG, description = "optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting") |
| private Long actionTimeout; |
| |
| @Parameter(name = ApiConstants.ACTION, type = CommandType.STRING, required = true, |
| validations = {ApiArgValidator.NotNullOrEmpty}, description = "out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS") |
| private String powerAction; |
| |
| ///////////////////////////////////////////////////// |
| /////////////// API Implementation/////////////////// |
| ///////////////////////////////////////////////////// |
| |
| @Override |
| public void execute() throws ResourceUnavailableException, InsufficientCapacityException, ServerApiException, ConcurrentOperationException, ResourceAllocationException, NetworkRuleConflictException { |
| final Host host = _resourceService.getHost(getHostId()); |
| if (host == null) { |
| throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "Unable to find host by ID: " + getHostId()); |
| } |
| final PowerOperation powerOperation = PowerOperation.valueOf(getPowerAction()); |
| |
| CallContext.current().setEventDetails("Host Id: " + host.getId() + " Action: " + powerOperation.toString()); |
| CallContext.current().putContextParameter(Host.class, host.getUuid()); |
| |
| final OutOfBandManagementResponse response = outOfBandManagementService.executePowerOperation(host, powerOperation, getActionTimeout()); |
| response.setResponseName(getCommandName()); |
| setResponseObject(response); |
| } |
| |
| @Override |
| public String getCommandName() { |
| return APINAME.toLowerCase() + BaseCmd.RESPONSE_SUFFIX; |
| } |
| |
| @Override |
| public long getEntityOwnerId() { |
| return CallContext.current().getCallingAccountId(); |
| } |
| |
| public Long getHostId() { |
| return hostId; |
| } |
| |
| public Long getActionTimeout() { |
| return actionTimeout; |
| } |
| |
| public String getPowerAction() { |
| return powerAction; |
| } |
| |
| @Override |
| public String getEventType() { |
| return EventTypes.EVENT_HOST_OUTOFBAND_MANAGEMENT_ACTION; |
| } |
| |
| @Override |
| public String getEventDescription() { |
| return "issue out-out-band management power action: " + getPowerAction() + " on host: " + getHostId(); |
| } |
| |
| @Override |
| public ApiCommandJobType getInstanceType() { |
| return ApiCommandJobType.Host; |
| } |
| } |