Github user jburwell commented on a diff in the pull request:
https://github.com/apache/cloudstack/pull/1502#discussion_r62321148
--- Diff:
api/src/org/apache/cloudstack/api/command/admin/outofbandmanagement/IssueOutOfBandManagementPowerActionCmd.java
---
@@ -0,0 +1,128 @@
+// 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 com.google.common.base.Strings;
+import org.apache.cloudstack.acl.RoleType;
+import org.apache.cloudstack.api.APICommand;
+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.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 = "issueOutOfBandManagementPowerAction", description =
"Initiates the specified power action to the host's out-of-band management
interface",
+ responseObject = OutOfBandManagementResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false, authorized =
{RoleType.Admin})
+public class IssueOutOfBandManagementPowerActionCmd extends BaseAsyncCmd {
+ @Inject
+ private OutOfBandManagementService outOfBandManagementService;
+
+ /////////////////////////////////////////////////////
+ //////////////// API parameters /////////////////////
+ /////////////////////////////////////////////////////
+
+ @Parameter(name = ApiConstants.HOST_ID, type = CommandType.UUID,
entityType = HostResponse.class, required = true, 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, description = "out-of-band management power actions, valid
actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS")
+ private String outOfBandManagementPowerOperation;
+
+ /////////////////////////////////////////////////////
+ /////////////// API Implementation///////////////////
+ /////////////////////////////////////////////////////
+
+ @Override
+ public String getCommandName() {
+ return "issueoutofbandmanagementpoweractionresponse";
+ }
+
+ private void validateParams() {
+ if (getHostId() == null || getHostId() < 1L) {
+ throw new ServerApiException(ApiErrorCode.PARAM_ERROR,
"Invalid host ID: " + getHostId());
+ }
+ if (Strings.isNullOrEmpty(getOutOfBandManagementPowerOperation()))
{
+ throw new ServerApiException(ApiErrorCode.PARAM_ERROR,
"Invalid out-of-band management power action: " +
getOutOfBandManagementPowerOperation());
+ }
+ }
+
+ @Override
+ public void execute() throws ResourceUnavailableException,
InsufficientCapacityException, ServerApiException,
ConcurrentOperationException, ResourceAllocationException,
NetworkRuleConflictException {
+ validateParams();
+ Host host = _resourceService.getHost(getHostId());
+ if (host == null) {
+ throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "Unable
to find host by ID: " + getHostId());
+ }
+ PowerOperation powerOperation =
PowerOperation.valueOf(getOutOfBandManagementPowerOperation());
--- End diff --
@rhtyd the API itself is case-insensitive. Therefore, I am more concerned
that the user will received an unexpected error because we are not fulfilling
the contract. For this reason, it seems like we should be doing a case
intensive check here and in ``validateParams``.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
