This is an automated email from the ASF dual-hosted git repository.
dahn pushed a commit to branch 4.18
in repository https://gitbox.apache.org/repos/asf/cloudstack.git
The following commit(s) were added to refs/heads/4.18 by this push:
new cf249f64a3b api: Force-stop descriptions (#7866)
cf249f64a3b is described below
commit cf249f64a3b54b2e5f8ea09282efb1a4bd976bf8
Author: dahn <[email protected]>
AuthorDate: Wed Aug 16 08:31:32 2023 +0200
api: Force-stop descriptions (#7866)
---
.../cloudstack/api/command/admin/internallb/StopInternalLBVMCmd.java | 2 +-
.../org/apache/cloudstack/api/command/admin/router/StopRouterCmd.java | 2 +-
.../apache/cloudstack/api/command/admin/systemvm/StopSystemVmCmd.java | 2 +-
.../main/java/org/apache/cloudstack/api/command/user/vm/StopVMCmd.java | 3 ++-
.../src/main/java/com/cloud/api/commands/StopNetScalerVMCmd.java | 2 +-
5 files changed, 6 insertions(+), 5 deletions(-)
diff --git
a/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/StopInternalLBVMCmd.java
b/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/StopInternalLBVMCmd.java
index 1381f670527..76ad4d438d2 100644
---
a/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/StopInternalLBVMCmd.java
+++
b/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/StopInternalLBVMCmd.java
@@ -51,7 +51,7 @@ public class StopInternalLBVMCmd extends BaseAsyncCmd {
@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType =
DomainRouterResponse.class, required = true, description = "the ID of the
internal lb vm")
private Long id;
- @Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN,
required = false, description = "Force stop the VM. The caller knows the VM is
stopped.")
+ @Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN,
required = false, description = "Force stop the VM (vm is marked as Stopped
even when command fails to be send to the backend, otherwise a force poweroff
is attempted). To be used if the caller knows the VM is stopped and should be
marked as such.")
private Boolean forced;
// ///////////////////////////////////////////////////
diff --git
a/api/src/main/java/org/apache/cloudstack/api/command/admin/router/StopRouterCmd.java
b/api/src/main/java/org/apache/cloudstack/api/command/admin/router/StopRouterCmd.java
index b9e15661268..2da38d90426 100644
---
a/api/src/main/java/org/apache/cloudstack/api/command/admin/router/StopRouterCmd.java
+++
b/api/src/main/java/org/apache/cloudstack/api/command/admin/router/StopRouterCmd.java
@@ -49,7 +49,7 @@ public class StopRouterCmd extends BaseAsyncCmd {
@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType =
DomainRouterResponse.class, required = true, description = "the ID of the
router")
private Long id;
- @Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN,
required = false, description = "Force stop the VM. The caller knows the VM is
stopped.")
+ @Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN,
required = false, description = "Force stop the VM (vm is marked as Stopped
even when command fails to be send to the backend, otherwise a force poweroff
is attempted). To be used if the caller knows the VM is stopped and should be
marked as such.")
private Boolean forced;
// ///////////////////////////////////////////////////
diff --git
a/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/StopSystemVmCmd.java
b/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/StopSystemVmCmd.java
index 755c8e46205..4bb533ce5b6 100644
---
a/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/StopSystemVmCmd.java
+++
b/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/StopSystemVmCmd.java
@@ -54,7 +54,7 @@ public class StopSystemVmCmd extends BaseAsyncCmd {
description = "The ID of the system virtual machine")
private Long id;
- @Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN,
required = false, description = "Force stop the VM. The caller knows the VM is
stopped.")
+ @Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN,
required = false, description = "Force stop the VM (vm is marked as Stopped
even when command fails to be send to the backend, otherwise a force poweroff
is attempted). To be used if the caller knows the VM is stopped and should be
marked as such.")
private Boolean forced;
/////////////////////////////////////////////////////
diff --git
a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/StopVMCmd.java
b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/StopVMCmd.java
index 529e09a0753..113ba9ed25d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/StopVMCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/StopVMCmd.java
@@ -55,7 +55,8 @@ public class StopVMCmd extends BaseAsyncCmd implements
UserCmd {
private Long id;
@Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN,
required = false, description = "Force stop the VM "
- + "(vm is marked as Stopped even when command fails to be send to the
backend, otherwise a force poweroff is attempted). The caller knows the VM is
stopped.")
+ + "(vm is marked as Stopped even when command fails to be send to the
backend, otherwise a force poweroff is attempted)."
+ + " This option is to be used if the caller knows the VM is stopped
and should be marked as such.")
private Boolean forced;
// ///////////////////////////////////////////////////
diff --git
a/plugins/network-elements/netscaler/src/main/java/com/cloud/api/commands/StopNetScalerVMCmd.java
b/plugins/network-elements/netscaler/src/main/java/com/cloud/api/commands/StopNetScalerVMCmd.java
index 5d754168e49..288e867277a 100644
---
a/plugins/network-elements/netscaler/src/main/java/com/cloud/api/commands/StopNetScalerVMCmd.java
+++
b/plugins/network-elements/netscaler/src/main/java/com/cloud/api/commands/StopNetScalerVMCmd.java
@@ -56,7 +56,7 @@ public class StopNetScalerVMCmd extends BaseAsyncCmd {
@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType =
DomainRouterResponse.class, required = true, description = "the ID of the
NetScaler vm")
private Long id;
- @Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN,
required = false, description = "Force stop the VM. The caller knows the VM is
stopped.")
+ @Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN,
required = false, description = "Force stop the VM (vm is marked as Stopped
even when command fails to be send to the backend, otherwise a force poweroff
is attempted). To be used if the caller knows the VM is stopped and should be
marked as such.")
private Boolean forced;
// ///////////////////////////////////////////////////
