diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 6fb8844e8ce..1c64df86cba 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -29,7 +29,7 @@ permissions:
jobs:
build:
if: github.repository == 'apache/cloudstack'
- runs-on: ubuntu-22.04
+ runs-on: ubuntu-24.04
strategy:
fail-fast: false
@@ -232,7 +232,25 @@ jobs:
- name: Install Build Dependencies
run: |
sudo apt-get update
- sudo apt-get install -y git uuid-runtime genisoimage netcat ipmitool build-essential libgcrypt20 libgpg-error-dev libgpg-error0 libopenipmi0 ipmitool libpython3-dev libssl-dev libffi-dev python3-openssl python3-dev python3-setuptools
+ sudo apt-get install -y git uuid-runtime genisoimage netcat-openbsd ipmitool build-essential libgcrypt20 libgpg-error-dev libgpg-error0 libopenipmi0 ipmitool libpython3-dev libssl-dev libffi-dev python3-openssl python3-dev python3-setuptools
+
+ - name: Setup IPMI Tool for CloudStack
+ run: |
+ # Create cloudstack-common directory if it doesn't exist
+ sudo mkdir -p /usr/share/cloudstack-common
+
+ # Copy ipmitool to cloudstack-common directory if it doesn't exist
+ if [ ! -f /usr/share/cloudstack-common/ipmitool ]; then
+ sudo cp /usr/bin/ipmitool /usr/share/cloudstack-common/ipmitool
+ sudo chmod 755 /usr/share/cloudstack-common/ipmitool
+ fi
+
+ # Create ipmitool-C3 wrapper script
+ sudo tee /usr/bin/ipmitool > /dev/null << 'EOF'
+ #!/bin/bash
+ /usr/share/cloudstack-common/ipmitool -C3 $@
+ EOF
+ sudo chmod 755 /usr/bin/ipmitool
- name: Install Python dependencies
run: |
@@ -271,7 +289,7 @@ jobs:
- name: Setup Simulator Prerequisites
run: |
sudo python3 -m pip install --upgrade netaddr mysql-connector-python
- python3 -m pip install --user --upgrade tools/marvin/dist/Marvin-*.tar.gz
+ python3 -m pip install --user --upgrade tools/marvin/dist/[mM]arvin-*.tar.gz
mvn -q -Pdeveloper -pl developer -Ddeploydb
mvn -q -Pdeveloper -pl developer -Ddeploydb-simulator
diff --git a/.github/workflows/ui.yml b/.github/workflows/ui.yml
index 56f757133b7..88d4a70e4c2 100644
--- a/.github/workflows/ui.yml
+++ b/.github/workflows/ui.yml
@@ -56,6 +56,7 @@ jobs:
npm run test:unit
- uses: codecov/codecov-action@v4
+ if: github.repository == 'apache/cloudstack'
with:
working-directory: ui
files: ./coverage/lcov.info
diff --git a/agent/pom.xml b/agent/pom.xml
index 1f9b5cfa096..92c836f10ef 100644
--- a/agent/pom.xml
+++ b/agent/pom.xml
@@ -24,7 +24,7 @@
org.apache.cloudstack
cloudstack
- 4.20.1.0-SNAPSHOT
+ 4.20.3.0-SNAPSHOT
diff --git a/agent/src/main/java/com/cloud/agent/Agent.java b/agent/src/main/java/com/cloud/agent/Agent.java
index 2e7b61fbd51..c01f025c6a8 100644
--- a/agent/src/main/java/com/cloud/agent/Agent.java
+++ b/agent/src/main/java/com/cloud/agent/Agent.java
@@ -93,7 +93,6 @@ import com.cloud.utils.nio.Link;
import com.cloud.utils.nio.NioClient;
import com.cloud.utils.nio.NioConnection;
import com.cloud.utils.nio.Task;
-import com.cloud.utils.script.OutputInterpreter;
import com.cloud.utils.script.Script;
/**
@@ -598,9 +597,9 @@ public class Agent implements HandlerFactory, IAgentControl, AgentStatusUpdater
}
protected String getAgentArch() {
- final Script command = new Script("/usr/bin/arch", 500, logger);
- final OutputInterpreter.OneLineParser parser = new OutputInterpreter.OneLineParser();
- return command.execute(parser);
+ String arch = Script.runSimpleBashScript(Script.getExecutableAbsolutePath("arch"), 2000);
+ logger.debug("Arch for agent: {} found: {}", _name, arch);
+ return arch;
}
@Override
@@ -1229,7 +1228,14 @@ public class Agent implements HandlerFactory, IAgentControl, AgentStatusUpdater
logger.error("Error parsing task", e);
}
} else if (task.getType() == Task.Type.DISCONNECT) {
- logger.debug("Executing disconnect task - {}", () -> getLinkLog(task.getLink()));
+ try {
+ // an issue has been found if reconnect immediately after disconnecting.
+ // wait 5 seconds before reconnecting
+ logger.debug("Wait for 5 secs before reconnecting, disconnect task - {}", () -> getLinkLog(task.getLink()));
+ Thread.sleep(5000);
+ } catch (InterruptedException e) {
+ }
+ logger.debug("Executing disconnect task - {} and reconnecting", () -> getLinkLog(task.getLink()));
reconnect(task.getLink());
} else if (task.getType() == Task.Type.OTHER) {
processOtherTask(task);
diff --git a/agent/src/main/java/com/cloud/agent/properties/AgentProperties.java b/agent/src/main/java/com/cloud/agent/properties/AgentProperties.java
index e5593f10460..c781c07c227 100644
--- a/agent/src/main/java/com/cloud/agent/properties/AgentProperties.java
+++ b/agent/src/main/java/com/cloud/agent/properties/AgentProperties.java
@@ -823,7 +823,7 @@ public class AgentProperties{
private T defaultValue;
private Class typeClass;
- Property(String name, T value) {
+ public Property(String name, T value) {
init(name, value);
}
diff --git a/agent/src/main/java/com/cloud/agent/resource/consoleproxy/ConsoleProxyResource.java b/agent/src/main/java/com/cloud/agent/resource/consoleproxy/ConsoleProxyResource.java
index ccd0d976e58..b0b1e487a26 100644
--- a/agent/src/main/java/com/cloud/agent/resource/consoleproxy/ConsoleProxyResource.java
+++ b/agent/src/main/java/com/cloud/agent/resource/consoleproxy/ConsoleProxyResource.java
@@ -175,12 +175,12 @@ public class ConsoleProxyResource extends ServerResourceBase implements ServerRe
try {
is.close();
} catch (final IOException e) {
- logger.warn("Exception when closing , console proxy address : {}", proxyManagementIp);
+ logger.warn("Exception when closing , console proxy address: {}", proxyManagementIp);
success = false;
}
}
} catch (final IOException e) {
- logger.warn("Unable to open console proxy command port url, console proxy address : {}", proxyManagementIp);
+ logger.warn("Unable to open console proxy command port url, console proxy address: {}", proxyManagementIp);
success = false;
}
diff --git a/api/pom.xml b/api/pom.xml
index 5b77b0b97b7..377b6e6e341 100644
--- a/api/pom.xml
+++ b/api/pom.xml
@@ -24,7 +24,7 @@
org.apache.cloudstack
cloudstack
- 4.20.1.0-SNAPSHOT
+ 4.20.3.0-SNAPSHOT
diff --git a/api/src/main/java/com/cloud/agent/api/storage/OVFHelper.java b/api/src/main/java/com/cloud/agent/api/storage/OVFHelper.java
index 6396e3deb72..ccb5362c853 100644
--- a/api/src/main/java/com/cloud/agent/api/storage/OVFHelper.java
+++ b/api/src/main/java/com/cloud/agent/api/storage/OVFHelper.java
@@ -278,8 +278,8 @@ public class OVFHelper {
if (StringUtils.isNotBlank(path)) {
File f = new File(path);
if (!f.exists() || f.isDirectory()) {
- logger.error("One of the attached disk or iso does not exists " + path);
- throw new InternalErrorException("One of the attached disk or iso as stated on OVF does not exists " + path);
+ logger.error("One of the attached disk or ISO does not exists " + path);
+ throw new InternalErrorException("One of the attached disk or ISO as stated on OVF does not exists " + path);
}
}
Long capacity = disk != null ? disk._capacity : file._size;
@@ -335,7 +335,7 @@ public class OVFHelper {
vd.add(od);
}
if (logger.isTraceEnabled()) {
- logger.trace(String.format("found %d disk definitions",vd.size()));
+ logger.trace(String.format("Found %d disk definitions", vd.size()));
}
return vd;
}
@@ -367,7 +367,7 @@ public class OVFHelper {
}
}
if (logger.isTraceEnabled()) {
- logger.trace(String.format("found %d file definitions in %s",vf.size(), ovfFile.getPath()));
+ logger.trace(String.format("Found %d file definitions in %s", vf.size(), ovfFile.getPath()));
}
return vf;
}
@@ -523,7 +523,7 @@ public class OVFHelper {
public List getNetPrerequisitesFromDocument(Document doc) throws InternalErrorException {
if (doc == null) {
if (logger.isTraceEnabled()) {
- logger.trace("no document to parse; returning no prerequisite networks");
+ logger.trace("No document to parse; returning no prerequisite Networks");
}
return Collections.emptyList();
}
@@ -541,7 +541,7 @@ public class OVFHelper {
final DocumentTraversal traversal = (DocumentTraversal) systemElement;
final NodeIterator iterator = traversal.createNodeIterator(systemElement, NodeFilter.SHOW_ELEMENT, null, true);
if (logger.isTraceEnabled()) {
- logger.trace(String.format("starting out with %d network-prerequisites, parsing hardware",nets.size()));
+ logger.trace(String.format("Starting out with %d network-prerequisites, parsing hardware",nets.size()));
}
int nicCount = 0;
for (Node n = iterator.nextNode(); n != null; n = iterator.nextNode()) {
@@ -551,7 +551,7 @@ public class OVFHelper {
String name = e.getTextContent(); // should be in our nets
if(nets.get(name) == null) {
if(logger.isInfoEnabled()) {
- logger.info(String.format("found a nic definition without a network definition byname %s, adding it to the list.", name));
+ logger.info(String.format("Found a NIC definition without a Network definition by name %s, adding it to the list.", name));
}
nets.put(name, new OVFNetworkTO());
}
@@ -562,7 +562,7 @@ public class OVFHelper {
}
}
if (logger.isTraceEnabled()) {
- logger.trace(String.format("ending up with %d network-prerequisites, parsed %d nics", nets.size(), nicCount));
+ logger.trace(String.format("Ending up with %d network-prerequisites, parsed %d NICs", nets.size(), nicCount));
}
}
@@ -631,7 +631,7 @@ public class OVFHelper {
nets.put(networkName,network);
}
if (logger.isTraceEnabled()) {
- logger.trace(String.format("found %d networks in template", nets.size()));
+ logger.trace(String.format("Found %d Networks in Template", nets.size()));
}
return nets;
}
diff --git a/api/src/main/java/com/cloud/api/commands/ListRecurringSnapshotScheduleCmd.java b/api/src/main/java/com/cloud/api/commands/ListRecurringSnapshotScheduleCmd.java
index d34c09c94fd..d8aa13710e2 100644
--- a/api/src/main/java/com/cloud/api/commands/ListRecurringSnapshotScheduleCmd.java
+++ b/api/src/main/java/com/cloud/api/commands/ListRecurringSnapshotScheduleCmd.java
@@ -35,10 +35,10 @@ public class ListRecurringSnapshotScheduleCmd extends BaseListCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.SNAPSHOT_POLICY_ID, type = CommandType.LONG, description = "lists recurring snapshots by snapshot policy ID")
+ @Parameter(name = ApiConstants.SNAPSHOT_POLICY_ID, type = CommandType.LONG, description = "Lists recurring Snapshots by Snapshot policy ID")
private Long snapshotPolicyId;
- @Parameter(name = ApiConstants.VOLUME_ID, type = CommandType.LONG, required = true, description = "list recurring snapshots by volume ID")
+ @Parameter(name = ApiConstants.VOLUME_ID, type = CommandType.LONG, required = true, description = "List recurring Snapshots by volume ID")
private Long volumeId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/com/cloud/host/Host.java b/api/src/main/java/com/cloud/host/Host.java
index 56b4ed75a31..a3b6ccadc01 100644
--- a/api/src/main/java/com/cloud/host/Host.java
+++ b/api/src/main/java/com/cloud/host/Host.java
@@ -53,9 +53,12 @@ public interface Host extends StateObject, Identity, Partition, HAResour
return strs;
}
}
- public static final String HOST_UEFI_ENABLE = "host.uefi.enable";
- public static final String HOST_VOLUME_ENCRYPTION = "host.volume.encryption";
- public static final String HOST_INSTANCE_CONVERSION = "host.instance.conversion";
+
+ String HOST_UEFI_ENABLE = "host.uefi.enable";
+ String HOST_VOLUME_ENCRYPTION = "host.volume.encryption";
+ String HOST_INSTANCE_CONVERSION = "host.instance.conversion";
+ String HOST_OVFTOOL_VERSION = "host.ovftool.version";
+ String HOST_VIRTV2V_VERSION = "host.virtv2v.version";
/**
* @return name of the machine.
diff --git a/api/src/main/java/com/cloud/hypervisor/Hypervisor.java b/api/src/main/java/com/cloud/hypervisor/Hypervisor.java
index 27ffef1c370..5739daf98f7 100644
--- a/api/src/main/java/com/cloud/hypervisor/Hypervisor.java
+++ b/api/src/main/java/com/cloud/hypervisor/Hypervisor.java
@@ -31,20 +31,22 @@ import java.util.stream.Collectors;
import static com.cloud.hypervisor.Hypervisor.HypervisorType.Functionality.DirectDownloadTemplate;
import static com.cloud.hypervisor.Hypervisor.HypervisorType.Functionality.RootDiskSizeOverride;
import static com.cloud.hypervisor.Hypervisor.HypervisorType.Functionality.VmStorageMigration;
+import static com.cloud.hypervisor.Hypervisor.HypervisorType.Functionality.VmStorageMigrationWithSnapshots;
public class Hypervisor {
public static class HypervisorType {
public enum Functionality {
DirectDownloadTemplate,
RootDiskSizeOverride,
- VmStorageMigration
+ VmStorageMigration,
+ VmStorageMigrationWithSnapshots
}
private static final Map hypervisorTypeMap = new LinkedHashMap<>();
public static final HypervisorType None = new HypervisorType("None"); //for storage hosts
public static final HypervisorType XenServer = new HypervisorType("XenServer", ImageFormat.VHD, EnumSet.of(RootDiskSizeOverride, VmStorageMigration));
public static final HypervisorType KVM = new HypervisorType("KVM", ImageFormat.QCOW2, EnumSet.of(DirectDownloadTemplate, RootDiskSizeOverride, VmStorageMigration));
- public static final HypervisorType VMware = new HypervisorType("VMware", ImageFormat.OVA, EnumSet.of(RootDiskSizeOverride, VmStorageMigration));
+ public static final HypervisorType VMware = new HypervisorType("VMware", ImageFormat.OVA, EnumSet.of(RootDiskSizeOverride, VmStorageMigration, VmStorageMigrationWithSnapshots));
public static final HypervisorType Hyperv = new HypervisorType("Hyperv");
public static final HypervisorType VirtualBox = new HypervisorType("VirtualBox");
public static final HypervisorType Parralels = new HypervisorType("Parralels");
diff --git a/api/src/main/java/com/cloud/network/Ipv6Service.java b/api/src/main/java/com/cloud/network/Ipv6Service.java
index 4ef5f98c38d..e6c3b9250a7 100644
--- a/api/src/main/java/com/cloud/network/Ipv6Service.java
+++ b/api/src/main/java/com/cloud/network/Ipv6Service.java
@@ -45,7 +45,7 @@ public interface Ipv6Service extends PluggableService, Configurable {
static final ConfigKey Ipv6OfferingCreationEnabled = new ConfigKey("Advanced", Boolean.class,
"ipv6.offering.enabled",
"false",
- "Indicates whether creation of IPv6 network/VPC offering is enabled or not.",
+ "Indicates whether creation of IPv6 Network/VPC offering is enabled or not.",
true);
static final ConfigKey Ipv6PrefixSubnetCleanupInterval = new ConfigKey("Advanced", Integer.class,
diff --git a/api/src/main/java/com/cloud/network/Network.java b/api/src/main/java/com/cloud/network/Network.java
index d3bc5005cb7..43825cbda6a 100644
--- a/api/src/main/java/com/cloud/network/Network.java
+++ b/api/src/main/java/com/cloud/network/Network.java
@@ -324,9 +324,9 @@ public interface Network extends ControlledEntity, StateObject, I
public enum State {
- Allocated("Indicates the network configuration is in allocated but not setup"), Setup("Indicates the network configuration is setup"), Implementing(
- "Indicates the network configuration is being implemented"), Implemented("Indicates the network configuration is in use"), Shutdown(
- "Indicates the network configuration is being destroyed"), Destroy("Indicates that the network is destroyed");
+ Allocated("Indicates the Network configuration is in allocated but not setup"), Setup("Indicates the Network configuration is setup"), Implementing(
+ "Indicates the Network configuration is being implemented"), Implemented("Indicates the Network configuration is in use"), Shutdown(
+ "Indicates the Network configuration is being destroyed"), Destroy("Indicates that the Network is destroyed");
protected static final StateMachine2 s_fsm = new StateMachine2();
diff --git a/api/src/main/java/com/cloud/network/NetworkService.java b/api/src/main/java/com/cloud/network/NetworkService.java
index b8dd464b365..9b570fee5c5 100644
--- a/api/src/main/java/com/cloud/network/NetworkService.java
+++ b/api/src/main/java/com/cloud/network/NetworkService.java
@@ -80,7 +80,7 @@ public interface NetworkService {
true, ConfigKey.Scope.Zone);
public static final ConfigKey AllowUsersToSpecifyVRMtu = new ConfigKey<>("Advanced", Boolean.class,
- "allow.end.users.to.specify.vr.mtu", "false", "Allow end users to specify VR MTU",
+ "allow.end.users.to.specify.vr.mtu", "false", "Allow end Users to specify VR MTU",
true, ConfigKey.Scope.Zone);
List getIsolatedNetworksOwnedByAccountInZone(long zoneId, Account owner);
diff --git a/api/src/main/java/com/cloud/network/Networks.java b/api/src/main/java/com/cloud/network/Networks.java
index dfa0ddb84ca..8e7399bb21d 100644
--- a/api/src/main/java/com/cloud/network/Networks.java
+++ b/api/src/main/java/com/cloud/network/Networks.java
@@ -78,7 +78,7 @@ public class Networks {
}
@Override
public String getValueFrom(URI uri) {
- return uri.getAuthority();
+ return uri == null ? null : uri.getAuthority();
}
},
Vswitch("vs", String.class), LinkLocal(null, null), Vnet("vnet", Long.class), Storage("storage", Integer.class), Lswitch("lswitch", String.class) {
@@ -96,7 +96,7 @@ public class Networks {
*/
@Override
public String getValueFrom(URI uri) {
- return uri.getSchemeSpecificPart();
+ return uri == null ? null : uri.getSchemeSpecificPart();
}
},
Mido("mido", String.class), Pvlan("pvlan", String.class),
@@ -176,7 +176,7 @@ public class Networks {
* @return the scheme as BroadcastDomainType
*/
public static BroadcastDomainType getSchemeValue(URI uri) {
- return toEnumValue(uri.getScheme());
+ return toEnumValue(uri == null ? null : uri.getScheme());
}
/**
@@ -190,7 +190,7 @@ public class Networks {
if (com.cloud.dc.Vlan.UNTAGGED.equalsIgnoreCase(str)) {
return Native;
}
- return getSchemeValue(new URI(str));
+ return getSchemeValue(str == null ? null : new URI(str));
}
/**
@@ -219,7 +219,7 @@ public class Networks {
* @return the host part as String
*/
public String getValueFrom(URI uri) {
- return uri.getHost();
+ return uri == null ? null : uri.getHost();
}
/**
@@ -242,7 +242,7 @@ public class Networks {
* @throws URISyntaxException the string is not even an uri
*/
public static String getValue(String uriString) throws URISyntaxException {
- return getValue(new URI(uriString));
+ return getValue(uriString == null ? null : new URI(uriString));
}
/**
diff --git a/api/src/main/java/com/cloud/network/as/AutoScaleVmGroup.java b/api/src/main/java/com/cloud/network/as/AutoScaleVmGroup.java
index c265c1f36a0..c05b3bda3db 100644
--- a/api/src/main/java/com/cloud/network/as/AutoScaleVmGroup.java
+++ b/api/src/main/java/com/cloud/network/as/AutoScaleVmGroup.java
@@ -43,7 +43,7 @@ public interface AutoScaleVmGroup extends ControlledEntity, InternalIdentity, Di
} else if (state.equalsIgnoreCase("scaling")) {
return SCALING;
} else {
- throw new IllegalArgumentException("Unexpected AutoScale VM group state : " + state);
+ throw new IllegalArgumentException("Unexpected AutoScale Instance group state : " + state);
}
}
}
diff --git a/api/src/main/java/com/cloud/server/ManagementService.java b/api/src/main/java/com/cloud/server/ManagementService.java
index 18f3e901cd9..2670b657df1 100644
--- a/api/src/main/java/com/cloud/server/ManagementService.java
+++ b/api/src/main/java/com/cloud/server/ManagementService.java
@@ -20,7 +20,6 @@ import java.util.ArrayList;
import java.util.List;
import java.util.Map;
-import com.cloud.user.UserData;
import org.apache.cloudstack.api.command.admin.cluster.ListClustersCmd;
import org.apache.cloudstack.api.command.admin.config.ListCfgGroupsByCmd;
import org.apache.cloudstack.api.command.admin.config.ListCfgsByCmd;
@@ -66,11 +65,14 @@ import org.apache.cloudstack.api.command.user.vm.GetVMPasswordCmd;
import org.apache.cloudstack.api.command.user.vmgroup.UpdateVMGroupCmd;
import org.apache.cloudstack.config.Configuration;
import org.apache.cloudstack.config.ConfigurationGroup;
+import org.apache.cloudstack.framework.config.ConfigKey;
import com.cloud.alert.Alert;
import com.cloud.capacity.Capacity;
import com.cloud.dc.Pod;
import com.cloud.dc.Vlan;
+import com.cloud.deploy.DeploymentPlan;
+import com.cloud.deploy.DeploymentPlanner.ExcludeList;
import com.cloud.exception.ConcurrentOperationException;
import com.cloud.exception.ManagementServerException;
import com.cloud.exception.ResourceUnavailableException;
@@ -85,11 +87,13 @@ import com.cloud.storage.GuestOSHypervisor;
import com.cloud.storage.GuestOsCategory;
import com.cloud.storage.StoragePool;
import com.cloud.user.SSHKeyPair;
+import com.cloud.user.UserData;
import com.cloud.utils.Pair;
import com.cloud.utils.Ternary;
import com.cloud.vm.InstanceGroup;
import com.cloud.vm.VirtualMachine;
import com.cloud.vm.VirtualMachine.Type;
+import com.cloud.vm.VirtualMachineProfile;
/**
* Hopefully this is temporary.
@@ -98,6 +102,14 @@ import com.cloud.vm.VirtualMachine.Type;
public interface ManagementService {
static final String Name = "management-server";
+ ConfigKey JsInterpretationEnabled = new ConfigKey<>("Hidden"
+ , Boolean.class
+ , "js.interpretation.enabled"
+ , "false"
+ , "Enable/Disable all JavaScript interpretation related functionalities to create or update Javascript rules."
+ , false
+ , ConfigKey.Scope.Global);
+
/**
* returns the a map of the names/values in the configuration table
*
@@ -443,6 +455,19 @@ public interface ManagementService {
Ternary, Integer>, List, Map> listHostsForMigrationOfVM(VirtualMachine vm, Long startIndex, Long pageSize, String keyword, List vmList);
+ /**
+ * Apply affinity group constraints and other exclusion rules for VM migration.
+ * This is a helper method that can be used independently for per-iteration affinity checks in DRS.
+ *
+ * @param vm The virtual machine to migrate
+ * @param vmProfile The VM profile
+ * @param plan The deployment plan
+ * @param vmList List of VMs with current/simulated placements for affinity processing
+ * @return ExcludeList containing hosts to avoid
+ */
+ ExcludeList applyAffinityConstraints(VirtualMachine vm, VirtualMachineProfile vmProfile,
+ DeploymentPlan plan, List vmList);
+
/**
* List storage pools for live migrating of a volume. The API returns list of all pools in the cluster to which the
* volume can be migrated. Current pool is not included in the list. In case of vSphere datastore cluster storage pools,
@@ -481,4 +506,6 @@ public interface ManagementService {
Pair patchSystemVM(PatchSystemVMCmd cmd);
+ void checkJsInterpretationAllowedIfNeededForParameterValue(String paramName, boolean paramValue);
+
}
diff --git a/api/src/main/java/com/cloud/server/ResourceManagerUtil.java b/api/src/main/java/com/cloud/server/ResourceManagerUtil.java
index 9a3b51a70d5..f5081cbe307 100644
--- a/api/src/main/java/com/cloud/server/ResourceManagerUtil.java
+++ b/api/src/main/java/com/cloud/server/ResourceManagerUtil.java
@@ -18,6 +18,7 @@ package com.cloud.server;
public interface ResourceManagerUtil {
long getResourceId(String resourceId, ResourceTag.ResourceObjectType resourceType);
+ long getResourceId(String resourceId, ResourceTag.ResourceObjectType resourceType, boolean checkAccess);
String getUuid(String resourceId, ResourceTag.ResourceObjectType resourceType);
ResourceTag.ResourceObjectType getResourceType(String resourceTypeStr);
void checkResourceAccessible(Long accountId, Long domainId, String exceptionMessage);
diff --git a/api/src/main/java/com/cloud/storage/VolumeApiService.java b/api/src/main/java/com/cloud/storage/VolumeApiService.java
index bb69b5b6650..4182728c204 100644
--- a/api/src/main/java/com/cloud/storage/VolumeApiService.java
+++ b/api/src/main/java/com/cloud/storage/VolumeApiService.java
@@ -171,6 +171,13 @@ public interface VolumeApiService {
*
*/
boolean doesStoragePoolSupportDiskOffering(StoragePool destPool, DiskOffering diskOffering);
+
+ /**
+ * Checks if the storage pool supports the required disk offering tags
+ * destPool the storage pool to check the disk offering tags
+ * diskOfferingTags the tags that should be supported
+ * return whether the tags are supported in the storage pool
+ */
boolean doesStoragePoolSupportDiskOfferingTags(StoragePool destPool, String diskOfferingTags);
Volume destroyVolume(long volumeId, Account caller, boolean expunge, boolean forceExpunge);
diff --git a/api/src/main/java/com/cloud/user/AccountService.java b/api/src/main/java/com/cloud/user/AccountService.java
index e2c3bed0c29..c0ebcf09f59 100644
--- a/api/src/main/java/com/cloud/user/AccountService.java
+++ b/api/src/main/java/com/cloud/user/AccountService.java
@@ -87,6 +87,8 @@ public interface AccountService {
boolean isDomainAdmin(Long accountId);
+ boolean isResourceDomainAdmin(Long accountId);
+
boolean isNormalUser(long accountId);
User getActiveUserByRegistrationToken(String registrationToken);
diff --git a/api/src/main/java/com/cloud/user/ResourceLimitService.java b/api/src/main/java/com/cloud/user/ResourceLimitService.java
index 2f4ad1347be..666529808bf 100644
--- a/api/src/main/java/com/cloud/user/ResourceLimitService.java
+++ b/api/src/main/java/com/cloud/user/ResourceLimitService.java
@@ -34,7 +34,7 @@ import com.cloud.template.VirtualMachineTemplate;
public interface ResourceLimitService {
static final ConfigKey MaxAccountSecondaryStorage = new ConfigKey<>("Account Defaults", Long.class, "max.account.secondary.storage", "400",
- "The default maximum secondary storage space (in GiB) that can be used for an account", false);
+ "The default maximum secondary storage space (in GiB) that can be used for an Account", false);
static final ConfigKey MaxProjectSecondaryStorage = new ConfigKey<>("Project Defaults", Long.class, "max.project.secondary.storage", "400",
"The default maximum secondary storage space (in GiB) that can be used for a project", false);
static final ConfigKey ResourceCountCheckInterval = new ConfigKey<>("Advanced", Long.class, "resourcecount.check.interval", "300",
diff --git a/api/src/main/java/com/cloud/vm/UserVmService.java b/api/src/main/java/com/cloud/vm/UserVmService.java
index 72b18b70e18..dc9e8c1f0d8 100644
--- a/api/src/main/java/com/cloud/vm/UserVmService.java
+++ b/api/src/main/java/com/cloud/vm/UserVmService.java
@@ -503,7 +503,31 @@ public interface UserVmService {
void collectVmNetworkStatistics (UserVm userVm);
- UserVm importVM(final DataCenter zone, final Host host, final VirtualMachineTemplate template, final String instanceName, final String displayName, final Account owner, final String userData, final Account caller, final Boolean isDisplayVm, final String keyboard,
+ /**
+ * Import VM into CloudStack
+ * @param zone importing zone
+ * @param host importing host
+ * @param template template for the imported VM
+ * @param instanceNameInternal set to null to CloudStack to autogenerate from the next available VM ID on database
+ * @param displayName display name for the imported VM
+ * @param owner owner of the imported VM
+ * @param userData user data for the imported VM
+ * @param caller caller account
+ * @param isDisplayVm true to display the imported VM
+ * @param keyboard keyboard distribution for the imported VM
+ * @param accountId account ID
+ * @param userId user ID
+ * @param serviceOffering service offering for the imported VM
+ * @param sshPublicKey ssh key for the imported VM
+ * @param hostName the name for the imported VM
+ * @param hypervisorType hypervisor type for the imported VM
+ * @param customParameters details for the imported VM
+ * @param powerState power state of the imported VM
+ * @param networkNicMap network to nic mapping
+ * @return the imported VM
+ * @throws InsufficientCapacityException in case of errors
+ */
+ UserVm importVM(final DataCenter zone, final Host host, final VirtualMachineTemplate template, final String instanceNameInternal, final String displayName, final Account owner, final String userData, final Account caller, final Boolean isDisplayVm, final String keyboard,
final long accountId, final long userId, final ServiceOffering serviceOffering, final String sshPublicKey,
final String hostName, final HypervisorType hypervisorType, final Map customParameters,
final VirtualMachine.PowerState powerState, final LinkedHashMap> networkNicMap) throws InsufficientCapacityException;
diff --git a/api/src/main/java/com/cloud/vm/snapshot/VMSnapshot.java b/api/src/main/java/com/cloud/vm/snapshot/VMSnapshot.java
index 3897df2d5e6..4e1579e0565 100644
--- a/api/src/main/java/com/cloud/vm/snapshot/VMSnapshot.java
+++ b/api/src/main/java/com/cloud/vm/snapshot/VMSnapshot.java
@@ -29,8 +29,8 @@ import com.cloud.utils.fsm.StateObject;
public interface VMSnapshot extends ControlledEntity, Identity, InternalIdentity, StateObject {
enum State {
- Allocated("The VM snapshot is allocated but has not been created yet."), Creating("The VM snapshot is being created."), Ready(
- "The VM snapshot is ready to be used."), Reverting("The VM snapshot is being used to revert"), Expunging("The volume is being expunging"), Removed(
+ Allocated("The Instance Snapshot is allocated but has not been created yet."), Creating("The Instance Snapshot is being created."), Ready(
+ "The Instance Snapshot is ready to be used."), Reverting("The Instance Snapshot is being used to revert"), Expunging("The volume is being expunging"), Removed(
"The volume is destroyed, and can't be recovered."), Error("The volume is in error state, and can't be recovered");
String _description;
diff --git a/api/src/main/java/com/cloud/vm/snapshot/VMSnapshotService.java b/api/src/main/java/com/cloud/vm/snapshot/VMSnapshotService.java
index 84a56aaedd3..754e463e710 100644
--- a/api/src/main/java/com/cloud/vm/snapshot/VMSnapshotService.java
+++ b/api/src/main/java/com/cloud/vm/snapshot/VMSnapshotService.java
@@ -19,6 +19,7 @@ package com.cloud.vm.snapshot;
import java.util.List;
+import com.cloud.utils.fsm.NoTransitionException;
import org.apache.cloudstack.api.command.user.vmsnapshot.ListVMSnapshotCmd;
import com.cloud.exception.ConcurrentOperationException;
@@ -53,4 +54,6 @@ public interface VMSnapshotService {
* @param id vm id
*/
boolean deleteVMSnapshotsFromDB(Long vmId, boolean unmanage);
+
+ void updateOperationFailed(VMSnapshot vmSnapshot) throws NoTransitionException;
}
diff --git a/api/src/main/java/org/apache/cloudstack/acl/RoleType.java b/api/src/main/java/org/apache/cloudstack/acl/RoleType.java
index 005d47c85bc..6d351649c0b 100644
--- a/api/src/main/java/org/apache/cloudstack/acl/RoleType.java
+++ b/api/src/main/java/org/apache/cloudstack/acl/RoleType.java
@@ -105,10 +105,10 @@ public enum RoleType {
* */
public static Account.Type getAccountTypeByRole(final Role role, final Account.Type defautAccountType) {
if (role != null) {
- LOGGER.debug(String.format("Role [%s] is not null; therefore, we use its account type [%s].", role, defautAccountType));
+ LOGGER.debug(String.format("Role [%s] is not null; therefore, we use its Account type [%s].", role, defautAccountType));
return role.getRoleType().getAccountType();
}
- LOGGER.debug(String.format("Role is null; therefore, we use the default account type [%s] value.", defautAccountType));
+ LOGGER.debug(String.format("Role is null; therefore, we use the default Account type [%s] value.", defautAccountType));
return defautAccountType;
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/affinity/AffinityGroupResponse.java b/api/src/main/java/org/apache/cloudstack/affinity/AffinityGroupResponse.java
index 69f391a5656..f5a71b99452 100644
--- a/api/src/main/java/org/apache/cloudstack/affinity/AffinityGroupResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/affinity/AffinityGroupResponse.java
@@ -34,27 +34,27 @@ import com.cloud.serializer.Param;
public class AffinityGroupResponse extends BaseResponse implements ControlledViewEntityResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the affinity group")
+ @Param(description = "The ID of the affinity group")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the affinity group")
+ @Param(description = "The name of the affinity group")
private String name;
@SerializedName(ApiConstants.DESCRIPTION)
- @Param(description = "the description of the affinity group")
+ @Param(description = "The description of the affinity group")
private String description;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account owning the affinity group")
+ @Param(description = "The account owning the affinity group")
private String accountName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain ID of the affinity group")
+ @Param(description = "The domain ID of the affinity group")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain name of the affinity group")
+ @Param(description = "The domain name of the affinity group")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
@@ -62,19 +62,19 @@ public class AffinityGroupResponse extends BaseResponse implements ControlledVie
private String domainPath;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project ID of the affinity group")
+ @Param(description = "The project ID of the affinity group")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the affinity group")
+ @Param(description = "The project name of the affinity group")
private String projectName;
@SerializedName(ApiConstants.TYPE)
- @Param(description = "the type of the affinity group")
+ @Param(description = "The type of the affinity group")
private String type;
@SerializedName("virtualmachineIds")
- @Param(description = "virtual machine IDs associated with this affinity group")
+ @Param(description = "Instance IDs associated with this affinity group")
private List vmIdList;
@SerializedName("dedicatedresources")
diff --git a/api/src/main/java/org/apache/cloudstack/affinity/AffinityGroupTypeResponse.java b/api/src/main/java/org/apache/cloudstack/affinity/AffinityGroupTypeResponse.java
index 6f5fb23d159..7ddf6dd9f73 100644
--- a/api/src/main/java/org/apache/cloudstack/affinity/AffinityGroupTypeResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/affinity/AffinityGroupTypeResponse.java
@@ -29,7 +29,7 @@ import com.cloud.serializer.Param;
public class AffinityGroupTypeResponse extends BaseResponse {
@SerializedName(ApiConstants.TYPE)
- @Param(description = "the type of the affinity group")
+ @Param(description = "The type of the affinity group")
private String type;
public AffinityGroupTypeResponse() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/AbstractGetUploadParamsCmd.java b/api/src/main/java/org/apache/cloudstack/api/AbstractGetUploadParamsCmd.java
index 083a1be00f5..1abdc0bbcc4 100644
--- a/api/src/main/java/org/apache/cloudstack/api/AbstractGetUploadParamsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/AbstractGetUploadParamsCmd.java
@@ -29,28 +29,28 @@ import org.apache.cloudstack.api.response.ZoneResponse;
public abstract class AbstractGetUploadParamsCmd extends BaseCmd {
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "the name of the volume/template/iso")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "The name of the Volume/Template/ISO")
private String name;
- @Parameter(name = ApiConstants.FORMAT, type = CommandType.STRING, required = true, description = "the format for the volume/template/iso. Possible values include QCOW2, OVA, "
+ @Parameter(name = ApiConstants.FORMAT, type = CommandType.STRING, required = true, description = "The format for the Volume/Template/ISO. Possible values include QCOW2, OVA, "
+ "and VHD.")
private String format;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, required = true, description = "the ID of the zone the volume/template/iso is "
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, required = true, description = "The ID of the zone the Volume/Template/ISO is "
+ "to be hosted on")
private Long zoneId;
- @Parameter(name = ApiConstants.CHECKSUM, type = CommandType.STRING, description = "the checksum value of this volume/template/iso " + ApiConstants.CHECKSUM_PARAMETER_PREFIX_DESCRIPTION)
+ @Parameter(name = ApiConstants.CHECKSUM, type = CommandType.STRING, description = "The checksum value of this Volume/Template/ISO " + ApiConstants.CHECKSUM_PARAMETER_PREFIX_DESCRIPTION)
private String checksum;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "an optional accountName. Must be used with domainId.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "An optional accountName. Must be used with domainId.")
private String accountName;
- @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "an optional domainId. If the account parameter is used, "
+ @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "An optional domainId. If the Account parameter is used, "
+ "domainId must also be used.")
private Long domainId;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "Upload volume/template/iso for the project")
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "Upload Volume/Template/ISO for the project")
private Long projectId;
public String getName() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/ApiConstants.java b/api/src/main/java/org/apache/cloudstack/api/ApiConstants.java
index 89c9a194e3f..4abc0d13d74 100644
--- a/api/src/main/java/org/apache/cloudstack/api/ApiConstants.java
+++ b/api/src/main/java/org/apache/cloudstack/api/ApiConstants.java
@@ -26,6 +26,7 @@ public class ApiConstants {
public static final String ACTIVATION_RULE = "activationrule";
public static final String ACTIVITY = "activity";
public static final String ADAPTER_TYPE = "adaptertype";
+ public static final String ADDITONAL_CONFIG_ENABLED = "additionalconfigenabled";
public static final String ADDRESS = "address";
public static final String ALGORITHM = "algorithm";
public static final String ALIAS = "alias";
diff --git a/api/src/main/java/org/apache/cloudstack/api/BaseAsyncCreateCustomIdCmd.java b/api/src/main/java/org/apache/cloudstack/api/BaseAsyncCreateCustomIdCmd.java
index 8680d7f11de..30baa71d6d8 100644
--- a/api/src/main/java/org/apache/cloudstack/api/BaseAsyncCreateCustomIdCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/BaseAsyncCreateCustomIdCmd.java
@@ -19,7 +19,7 @@ package org.apache.cloudstack.api;
public abstract class BaseAsyncCreateCustomIdCmd extends BaseAsyncCreateCmd {
@Parameter(name = ApiConstants.CUSTOM_ID,
type = CommandType.STRING,
- description = "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only")
+ description = "An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only")
private String customId;
public String getCustomId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/BaseAsyncCustomIdCmd.java b/api/src/main/java/org/apache/cloudstack/api/BaseAsyncCustomIdCmd.java
index b251c6ef2ec..c1777d3b8f8 100644
--- a/api/src/main/java/org/apache/cloudstack/api/BaseAsyncCustomIdCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/BaseAsyncCustomIdCmd.java
@@ -21,7 +21,7 @@ import org.apache.cloudstack.acl.RoleType;
public abstract class BaseAsyncCustomIdCmd extends BaseAsyncCmd {
@Parameter(name = ApiConstants.CUSTOM_ID,
type = CommandType.STRING,
- description = "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", since = "4.4", authorized = {RoleType.Admin})
+ description = "An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", since = "4.4", authorized = {RoleType.Admin})
private String customId;
public String getCustomId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/BaseCustomIdCmd.java b/api/src/main/java/org/apache/cloudstack/api/BaseCustomIdCmd.java
index 7ca9f1efe7e..8a2292eadd0 100644
--- a/api/src/main/java/org/apache/cloudstack/api/BaseCustomIdCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/BaseCustomIdCmd.java
@@ -22,7 +22,7 @@ public abstract class BaseCustomIdCmd extends BaseCmd {
@Parameter(name = ApiConstants.CUSTOM_ID,
type = CommandType.STRING,
- description = "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", since = "4.4", authorized = {RoleType.Admin})
+ description = "An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", since = "4.4", authorized = {RoleType.Admin})
private String customId;
public String getCustomId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/BaseListAccountResourcesCmd.java b/api/src/main/java/org/apache/cloudstack/api/BaseListAccountResourcesCmd.java
index aa5273ace3b..bb18080dfcc 100644
--- a/api/src/main/java/org/apache/cloudstack/api/BaseListAccountResourcesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/BaseListAccountResourcesCmd.java
@@ -19,7 +19,7 @@ package org.apache.cloudstack.api;
public abstract class BaseListAccountResourcesCmd extends BaseListDomainResourcesCmd implements IBaseListAccountResourcesCmd {
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "list resources by account. Must be used with the domainId parameter.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "List resources by Account. Must be used with the domainId parameter.")
private String accountName;
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/BaseListDomainResourcesCmd.java b/api/src/main/java/org/apache/cloudstack/api/BaseListDomainResourcesCmd.java
index 7a8cee33770..640caa93542 100644
--- a/api/src/main/java/org/apache/cloudstack/api/BaseListDomainResourcesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/BaseListDomainResourcesCmd.java
@@ -27,10 +27,10 @@ public abstract class BaseListDomainResourcesCmd extends BaseListCmd implements
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "list only resources belonging to the domain specified")
+ description = "List only resources belonging to the domain specified")
private Long domainId;
- @Parameter(name = ApiConstants.IS_RECURSIVE, type = CommandType.BOOLEAN, description = "defaults to false,"
+ @Parameter(name = ApiConstants.IS_RECURSIVE, type = CommandType.BOOLEAN, description = "Defaults to false,"
+ " but if true, lists all resources from the parent specified by the domainId till leaves.")
private Boolean recursive;
diff --git a/api/src/main/java/org/apache/cloudstack/api/BaseListProjectAndAccountResourcesCmd.java b/api/src/main/java/org/apache/cloudstack/api/BaseListProjectAndAccountResourcesCmd.java
index 0bcfba15ea6..d3c999ddb04 100644
--- a/api/src/main/java/org/apache/cloudstack/api/BaseListProjectAndAccountResourcesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/BaseListProjectAndAccountResourcesCmd.java
@@ -20,7 +20,7 @@ import org.apache.cloudstack.api.response.ProjectResponse;
public abstract class BaseListProjectAndAccountResourcesCmd extends BaseListAccountResourcesCmd implements IBaseListProjectAndAccountResourcesCmd {
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "list objects by project; if projectid=-1 lists All VMs")
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "List objects by project; if projectid=-1 lists All Instances")
private Long projectId;
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/BaseListRetrieveOnlyResourceCountCmd.java b/api/src/main/java/org/apache/cloudstack/api/BaseListRetrieveOnlyResourceCountCmd.java
index 0e8e136a6c1..20c270c30b2 100644
--- a/api/src/main/java/org/apache/cloudstack/api/BaseListRetrieveOnlyResourceCountCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/BaseListRetrieveOnlyResourceCountCmd.java
@@ -19,7 +19,7 @@ package org.apache.cloudstack.api;
import org.apache.commons.lang3.BooleanUtils;
public abstract class BaseListRetrieveOnlyResourceCountCmd extends BaseListTaggedResourcesCmd {
- @Parameter(name = ApiConstants.RETRIEVE_ONLY_RESOURCE_COUNT, type = CommandType.BOOLEAN, description = "makes the API's response contains only the resource count")
+ @Parameter(name = ApiConstants.RETRIEVE_ONLY_RESOURCE_COUNT, type = CommandType.BOOLEAN, description = "Makes the API's response contains only the resource count")
private Boolean retrieveOnlyResourceCount;
public Boolean getRetrieveOnlyResourceCount() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/BaseListTemplateOrIsoPermissionsCmd.java b/api/src/main/java/org/apache/cloudstack/api/BaseListTemplateOrIsoPermissionsCmd.java
index be95547a8a7..27e58233b24 100644
--- a/api/src/main/java/org/apache/cloudstack/api/BaseListTemplateOrIsoPermissionsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/BaseListTemplateOrIsoPermissionsCmd.java
@@ -33,7 +33,7 @@ public abstract class BaseListTemplateOrIsoPermissionsCmd extends BaseCmd implem
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TemplatePermissionsResponse.class, required = true, description = "the template ID")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TemplatePermissionsResponse.class, required = true, description = "The Template ID")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/BaseResponse.java b/api/src/main/java/org/apache/cloudstack/api/BaseResponse.java
index 45016c1a2a2..ebf0c4b19a0 100644
--- a/api/src/main/java/org/apache/cloudstack/api/BaseResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/BaseResponse.java
@@ -25,11 +25,11 @@ public abstract class BaseResponse implements ResponseObject {
private transient String objectName;
@SerializedName(ApiConstants.JOB_ID)
- @Param(description = "the UUID of the latest async job acting on this object")
+ @Param(description = "The UUID of the latest async job acting on this object")
protected String jobId;
@SerializedName(ApiConstants.JOB_STATUS)
- @Param(description = "the current status of the latest async job acting on this object")
+ @Param(description = "The current status of the latest async job acting on this object")
private Integer jobStatus;
public BaseResponse() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/BaseResponseWithAnnotations.java b/api/src/main/java/org/apache/cloudstack/api/BaseResponseWithAnnotations.java
index f7c0c21395f..19d88382ce7 100644
--- a/api/src/main/java/org/apache/cloudstack/api/BaseResponseWithAnnotations.java
+++ b/api/src/main/java/org/apache/cloudstack/api/BaseResponseWithAnnotations.java
@@ -22,7 +22,7 @@ import com.google.gson.annotations.SerializedName;
public abstract class BaseResponseWithAnnotations extends BaseResponse {
@SerializedName(ApiConstants.HAS_ANNOTATIONS)
- @Param(description = "true if the entity/resource has annotations")
+ @Param(description = "True if the entity/resource has annotations")
private Boolean hasAnnotation;
public Boolean hasAnnotation() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/BaseResponseWithAssociatedNetwork.java b/api/src/main/java/org/apache/cloudstack/api/BaseResponseWithAssociatedNetwork.java
index 1ffe4657bd9..48be5c6b4de 100755
--- a/api/src/main/java/org/apache/cloudstack/api/BaseResponseWithAssociatedNetwork.java
+++ b/api/src/main/java/org/apache/cloudstack/api/BaseResponseWithAssociatedNetwork.java
@@ -22,11 +22,11 @@ import com.google.gson.annotations.SerializedName;
public abstract class BaseResponseWithAssociatedNetwork extends BaseResponseWithAnnotations {
@SerializedName(ApiConstants.ASSOCIATED_NETWORK_ID)
- @Param(description = "the ID of the Network associated with this private gateway")
+ @Param(description = "The ID of the Network associated with this private gateway")
private String associatedNetworkId;
@SerializedName(ApiConstants.ASSOCIATED_NETWORK)
- @Param(description = "the name of the Network associated with this private gateway")
+ @Param(description = "The name of the Network associated with this private gateway")
private String associatedNetworkName;
public void setAssociatedNetworkId(String associatedNetworkId) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/BaseResponseWithTagInformation.java b/api/src/main/java/org/apache/cloudstack/api/BaseResponseWithTagInformation.java
index 710b9f0b9ec..a01cd5677ba 100755
--- a/api/src/main/java/org/apache/cloudstack/api/BaseResponseWithTagInformation.java
+++ b/api/src/main/java/org/apache/cloudstack/api/BaseResponseWithTagInformation.java
@@ -26,7 +26,7 @@ import com.google.gson.annotations.SerializedName;
public abstract class BaseResponseWithTagInformation extends BaseResponseWithAnnotations {
@SerializedName(ApiConstants.TAGS)
- @Param(description = "the list of resource tags associated", responseObject = ResourceTagResponse.class)
+ @Param(description = "The list of resource tags associated", responseObject = ResourceTagResponse.class)
protected Set tags;
public void addTag(ResourceTagResponse tag) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/BaseUpdateTemplateOrIsoCmd.java b/api/src/main/java/org/apache/cloudstack/api/BaseUpdateTemplateOrIsoCmd.java
index 9a8282df112..38cf765dd1a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/BaseUpdateTemplateOrIsoCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/BaseUpdateTemplateOrIsoCmd.java
@@ -30,45 +30,45 @@ public abstract class BaseUpdateTemplateOrIsoCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.BOOTABLE, type = CommandType.BOOLEAN, description = "true if image is bootable, false otherwise; available only for updateIso API")
+ @Parameter(name = ApiConstants.BOOTABLE, type = CommandType.BOOLEAN, description = "True if image is bootable, false otherwise; available only for updateIso API")
private Boolean bootable;
- @Parameter(name = ApiConstants.REQUIRES_HVM, type = CommandType.BOOLEAN, description = "true if the template requires HVM, false otherwise; available only for updateTemplate API")
+ @Parameter(name = ApiConstants.REQUIRES_HVM, type = CommandType.BOOLEAN, description = "True if the Template requires HVM, false otherwise; available only for updateTemplate API")
private Boolean requiresHvm;
- @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "the display text of the image", length = 4096)
+ @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "The display text of the image", length = 4096)
private String displayText;
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TemplateResponse.class, required = true, description = "the ID of the image file")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TemplateResponse.class, required = true, description = "The ID of the image file")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the image file")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the image file")
private String templateName;
@Parameter(name = ApiConstants.OS_TYPE_ID,
type = CommandType.UUID,
entityType = GuestOSResponse.class,
- description = "the ID of the OS type that best represents the OS of this image.")
+ description = "The ID of the OS type that best represents the OS of this image.")
private Long osTypeId;
- @Parameter(name = ApiConstants.FORMAT, type = CommandType.STRING, description = "the format for the image")
+ @Parameter(name = ApiConstants.FORMAT, type = CommandType.STRING, description = "The format for the image")
private String format;
- @Parameter(name = ApiConstants.PASSWORD_ENABLED, type = CommandType.BOOLEAN, description = "true if the image supports the password reset feature; default is false")
+ @Parameter(name = ApiConstants.PASSWORD_ENABLED, type = CommandType.BOOLEAN, description = "True if the image supports the password reset feature; default is false")
private Boolean passwordEnabled;
- @Parameter(name = ApiConstants.SSHKEY_ENABLED, type = CommandType.BOOLEAN, description = "true if the template supports the sshkey upload feature; default is false")
+ @Parameter(name = ApiConstants.SSHKEY_ENABLED, type = CommandType.BOOLEAN, description = "True if the Template supports the SSHkey upload feature; default is false")
private Boolean sshKeyEnabled;
- @Parameter(name = ApiConstants.SORT_KEY, type = CommandType.INTEGER, description = "sort key of the template, integer")
+ @Parameter(name = ApiConstants.SORT_KEY, type = CommandType.INTEGER, description = "Sort key of the Template, integer")
private Integer sortKey;
@Parameter(name = ApiConstants.IS_DYNAMICALLY_SCALABLE,
type = CommandType.BOOLEAN,
- description = "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory")
+ description = "True if Template/ISO contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory")
private Boolean isDynamicallyScalable;
- @Parameter(name = ApiConstants.ROUTING, type = CommandType.BOOLEAN, description = "true if the template type is routing i.e., if template is used to deploy router")
+ @Parameter(name = ApiConstants.ROUTING, type = CommandType.BOOLEAN, description = "True if the Template type is routing i.e., if Template is used to deploy router")
protected Boolean isRoutingType;
@Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61")
@@ -76,7 +76,7 @@ public abstract class BaseUpdateTemplateOrIsoCmd extends BaseCmd {
@Parameter(name = ApiConstants.CLEAN_UP_DETAILS,
type = CommandType.BOOLEAN,
- description = "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)")
+ description = "Optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)")
private Boolean cleanupDetails;
@Parameter(name = ApiConstants.ARCH, type = CommandType.STRING,
diff --git a/api/src/main/java/org/apache/cloudstack/api/BaseUpdateTemplateOrIsoPermissionsCmd.java b/api/src/main/java/org/apache/cloudstack/api/BaseUpdateTemplateOrIsoPermissionsCmd.java
index e6ee0897db0..0a62591ddc2 100644
--- a/api/src/main/java/org/apache/cloudstack/api/BaseUpdateTemplateOrIsoPermissionsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/BaseUpdateTemplateOrIsoPermissionsCmd.java
@@ -40,31 +40,31 @@ public abstract class BaseUpdateTemplateOrIsoPermissionsCmd extends BaseCmd {
@Parameter(name = ApiConstants.ACCOUNTS,
type = CommandType.LIST,
collectionType = CommandType.STRING,
- description = "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.")
+ description = "A comma delimited list of Accounts within caller's domain. If specified, \"op\" parameter has to be passed in.")
private List accountNames;
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TemplateResponse.class, required = true, description = "the template ID")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TemplateResponse.class, required = true, description = "The Template ID")
private Long id;
- @Parameter(name = ApiConstants.IS_FEATURED, type = CommandType.BOOLEAN, description = "true for featured template/iso, false otherwise")
+ @Parameter(name = ApiConstants.IS_FEATURED, type = CommandType.BOOLEAN, description = "True for featured Template/ISO, false otherwise")
private Boolean featured;
- @Parameter(name = ApiConstants.IS_PUBLIC, type = CommandType.BOOLEAN, description = "true for public template/iso, false for private templates/isos")
+ @Parameter(name = ApiConstants.IS_PUBLIC, type = CommandType.BOOLEAN, description = "True for public Template/ISO, false for private Templates/ISOs")
private Boolean isPublic;
@Parameter(name = ApiConstants.IS_EXTRACTABLE,
type = CommandType.BOOLEAN,
- description = "true if the template/iso is extractable, false other wise. Can be set only by root admin")
+ description = "True if the Template/ISO is extractable, false otherwise. Can be set only by root admin")
private Boolean isExtractable;
- @Parameter(name = ApiConstants.OP, type = CommandType.STRING, description = "permission operator (add, remove, reset)")
+ @Parameter(name = ApiConstants.OP, type = CommandType.STRING, description = "Permission operator (add, remove, reset)")
private String operation;
@Parameter(name = ApiConstants.PROJECT_IDS,
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = ProjectResponse.class,
- description = "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.")
+ description = "A comma delimited list of projects. If specified, \"op\" parameter has to be passed in.")
private List projectIds;
// ///////////////////////////////////////////////////
@@ -121,7 +121,7 @@ public abstract class BaseUpdateTemplateOrIsoPermissionsCmd extends BaseCmd {
SuccessResponse response = new SuccessResponse(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update template/iso permissions");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update Template/ISO permissions");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/account/CreateAccountCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/account/CreateAccountCmd.java
index 6dbc6acc59a..ea25c56ee39 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/account/CreateAccountCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/account/CreateAccountCmd.java
@@ -50,12 +50,12 @@ public class CreateAccountCmd extends BaseCmd {
@Parameter(name = ApiConstants.ACCOUNT,
type = CommandType.STRING,
- description = "Name of the account to be created. The user will be added to this newly created account. If no account is specified, the username will be used as the account name.")
+ description = "Name of the Account to be created. The user will be added to this newly created account. If no Account is specified, the username will be used as the Account name.")
private String accountName;
@Parameter(name = ApiConstants.ACCOUNT_TYPE,
type = CommandType.INTEGER,
- description = "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin")
+ description = "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin")
private Integer accountType;
@Parameter(name = ApiConstants.ROLE_ID, type = CommandType.UUID, entityType = RoleResponse.class, description = "Creates the account under the specified role.")
@@ -64,13 +64,13 @@ public class CreateAccountCmd extends BaseCmd {
@Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "Creates the user under the specified domain.")
private Long domainId;
- @Parameter(name = ApiConstants.EMAIL, type = CommandType.STRING, required = true, description = "email")
+ @Parameter(name = ApiConstants.EMAIL, type = CommandType.STRING, required = true, description = "E-mail")
private String email;
- @Parameter(name = ApiConstants.FIRSTNAME, type = CommandType.STRING, required = true, description = "firstname")
+ @Parameter(name = ApiConstants.FIRSTNAME, type = CommandType.STRING, required = true, description = "First name")
private String firstName;
- @Parameter(name = ApiConstants.LASTNAME, type = CommandType.STRING, required = true, description = "lastname")
+ @Parameter(name = ApiConstants.LASTNAME, type = CommandType.STRING, required = true, description = "Last name")
private String lastName;
@Parameter(name = ApiConstants.PASSWORD,
@@ -87,16 +87,16 @@ public class CreateAccountCmd extends BaseCmd {
@Parameter(name = ApiConstants.USERNAME, type = CommandType.STRING, required = true, description = "Unique username.")
private String userName;
- @Parameter(name = ApiConstants.NETWORK_DOMAIN, type = CommandType.STRING, description = "Network domain for the account's networks")
+ @Parameter(name = ApiConstants.NETWORK_DOMAIN, type = CommandType.STRING, description = "Network domain for the Account's Networks")
private String networkDomain;
- @Parameter(name = ApiConstants.ACCOUNT_DETAILS, type = CommandType.MAP, description = "details for account used to store specific parameters")
+ @Parameter(name = ApiConstants.ACCOUNT_DETAILS, type = CommandType.MAP, description = "Details for Account used to store specific parameters")
private Map details;
- @Parameter(name = ApiConstants.ACCOUNT_ID, type = CommandType.STRING, description = "Account UUID, required for adding account from external provisioning system")
+ @Parameter(name = ApiConstants.ACCOUNT_ID, type = CommandType.STRING, description = "Account UUID, required for adding Account from external provisioning system")
private String accountUUID;
- @Parameter(name = ApiConstants.USER_ID, type = CommandType.STRING, description = "User UUID, required for adding account from external provisioning system")
+ @Parameter(name = ApiConstants.USER_ID, type = CommandType.STRING, description = "User UUID, required for adding Account from external provisioning system")
private String userUUID;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/account/DeleteAccountCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/account/DeleteAccountCmd.java
index a90fc4aebe9..c207801e364 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/account/DeleteAccountCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/account/DeleteAccountCmd.java
@@ -35,7 +35,7 @@ import org.apache.cloudstack.region.RegionService;
import com.cloud.event.EventTypes;
import com.cloud.user.Account;
-@APICommand(name = "deleteAccount", description = "Deletes a account, and all users associated with this account", responseObject = SuccessResponse.class, entityType = {Account.class},
+@APICommand(name = "deleteAccount", description = "Deletes an Account and all Users associated with this Account", responseObject = SuccessResponse.class, entityType = {Account.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class DeleteAccountCmd extends BaseAsyncCmd {
@@ -79,8 +79,8 @@ public class DeleteAccountCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
Account account = _accountService.getAccount(getId());
- return (account != null ? "Deleting user account " + account.getAccountName() + " (ID: " + account.getUuid() + ") and all corresponding users"
- : "Account delete, but this account does not exist in the system");
+ return (account != null ? "Deleting user Account " + account.getAccountName() + " (ID: " + account.getUuid() + ") and all corresponding users"
+ : "Cannot delete Account - it does not exist in the system");
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/account/DisableAccountCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/account/DisableAccountCmd.java
index 55293eca619..29774e254aa 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/account/DisableAccountCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/account/DisableAccountCmd.java
@@ -50,13 +50,13 @@ public class DisableAccountCmd extends BaseAsyncCmd {
@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = AccountResponse.class, description = "Account id")
private Long id;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "Disables specified account.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "Disables specified Account.")
private String accountName;
- @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "Disables specified account in this domain.")
+ @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "Disables specified Account in this domain.")
private Long domainId;
- @Parameter(name = ApiConstants.LOCK, type = CommandType.BOOLEAN, required = true, description = "If true, only lock the account; else disable the account")
+ @Parameter(name = ApiConstants.LOCK, type = CommandType.BOOLEAN, required = true, description = "If true, only lock the Account; else disable the Account")
private Boolean lockRequested;
@Inject
@@ -108,7 +108,7 @@ public class DisableAccountCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "disabling account: " + getAccountName() + " in domain: " + getDomainId();
+ return "Disabling Account: " + getAccountName() + " in domain: " + getDomainId();
}
@Override
@@ -120,7 +120,7 @@ public class DisableAccountCmd extends BaseAsyncCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, lockRequested == true ? "Failed to lock account" : "Failed to disable account");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, lockRequested == true ? "Failed to lock Account" : "Failed to disable Account");
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/account/EnableAccountCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/account/EnableAccountCmd.java
index da96383f134..7478bc8b811 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/account/EnableAccountCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/account/EnableAccountCmd.java
@@ -46,10 +46,10 @@ public class EnableAccountCmd extends BaseCmd {
@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = AccountResponse.class, description = "Account id")
private Long id;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "Enables specified account.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "Enables specified Account.")
private String accountName;
- @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "Enables specified account in this domain.")
+ @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "Enables specified Account in this domain.")
private Long domainId;
@Inject
@@ -98,7 +98,7 @@ public class EnableAccountCmd extends BaseCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to enable account");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to enable Account");
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/account/ListAccountsCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/account/ListAccountsCmdByAdmin.java
index 09a626ac954..50e9ba4989c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/account/ListAccountsCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/account/ListAccountsCmdByAdmin.java
@@ -23,7 +23,7 @@ import org.apache.cloudstack.api.response.AccountResponse;
import com.cloud.user.Account;
-@APICommand(name = "listAccounts", description = "Lists accounts and provides detailed account information for listed accounts", responseObject = AccountResponse.class, responseView = ResponseView.Full, entityType = {Account.class},
+@APICommand(name = "listAccounts", description = "Lists Accounts and provides detailed Account information for listed Accounts", responseObject = AccountResponse.class, responseView = ResponseView.Full, entityType = {Account.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class ListAccountsCmdByAdmin extends ListAccountsCmd {
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/account/LockAccountCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/account/LockAccountCmd.java
index d7847373e92..3ec191acf84 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/account/LockAccountCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/account/LockAccountCmd.java
@@ -28,7 +28,7 @@ import com.cloud.user.Account;
import com.cloud.utils.exception.CloudRuntimeException;
@APICommand(name = "lockAccount",
- description = "This deprecated function used to locks an account. Look for the API DisableAccount instead",
+ description = "This deprecated function used to lock an Account. Look for the API DisableAccount instead",
responseObject = AccountResponse.class,
entityType = {Account.class},
requestHasSensitiveInfo = false,
@@ -47,7 +47,7 @@ public class LockAccountCmd extends BaseCmd {
type = CommandType.UUID,
entityType = DomainResponse.class,
required = true,
- description = "Locks the specified account on this domain.")
+ description = "Locks the specified Account on this domain.")
private Long domainId;
/////////////////////////////////////////////////////
@@ -78,6 +78,6 @@ public class LockAccountCmd extends BaseCmd {
@Override
public void execute() {
- throw new CloudRuntimeException("LockAccount does not lock accounts. Its implementation is disabled. Use DisableAccount instead");
+ throw new CloudRuntimeException("LockAccount does not lock Accounts. Its implementation is disabled. Use DisableAccount instead.");
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/account/UpdateAccountCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/account/UpdateAccountCmd.java
index 3347a0d09f3..b6b975ae1ce 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/account/UpdateAccountCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/account/UpdateAccountCmd.java
@@ -41,7 +41,7 @@ import org.apache.cloudstack.region.RegionService;
import com.cloud.user.Account;
-@APICommand(name = "updateAccount", description = "Updates account information for the authenticated user", responseObject = AccountResponse.class, entityType = {Account.class},
+@APICommand(name = "updateAccount", description = "Updates Account information for the authenticated user", responseObject = AccountResponse.class, entityType = {Account.class},
responseView = ResponseView.Restricted, requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class UpdateAccountCmd extends BaseCmd implements UserCmd {
@@ -52,24 +52,24 @@ public class UpdateAccountCmd extends BaseCmd implements UserCmd {
@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = AccountResponse.class, description = "Account UUID")
private Long id;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "Current account name")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "Current Account name")
private String accountName;
- @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "The UUID of the domain where the account exists")
+ @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "The UUID of the domain where the Account exists")
private Long domainId;
- @Parameter(name = ApiConstants.ROLE_ID, type = CommandType.UUID, entityType = RoleResponse.class, description = "The UUID of the dynamic role to set for the account")
+ @Parameter(name = ApiConstants.ROLE_ID, type = CommandType.UUID, entityType = RoleResponse.class, description = "The UUID of the dynamic role to set for the Account")
private Long roleId;
- @Parameter(name = ApiConstants.NEW_NAME, type = CommandType.STRING, description = "New name for the account")
+ @Parameter(name = ApiConstants.NEW_NAME, type = CommandType.STRING, description = "New name for the Account")
private String newName;
@Parameter(name = ApiConstants.NETWORK_DOMAIN,
type = CommandType.STRING,
- description = "Network domain for the account's networks; empty string will update domainName with NULL value")
+ description = "Network domain for the Account's networks; empty string will update domainName with NULL value")
private String networkDomain;
- @Parameter(name = ApiConstants.ACCOUNT_DETAILS, type = CommandType.MAP, description = "Details for the account used to store specific parameters")
+ @Parameter(name = ApiConstants.ACCOUNT_DETAILS, type = CommandType.MAP, description = "Details for the Account used to store specific parameters")
private Map details;
@Parameter(name = ApiConstants.API_KEY_ACCESS, type = CommandType.STRING, description = "Determines if Api key access for this user is enabled, disabled or inherits the value from its parent, the domain level setting api.key.access", since = "4.20.1.0", authorized = {RoleType.Admin})
@@ -144,7 +144,7 @@ public class UpdateAccountCmd extends BaseCmd implements UserCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update account");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update Account");
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/CreateRoleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/CreateRoleCmd.java
index e67a3e2c0a0..59a09ef7a48 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/CreateRoleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/CreateRoleCmd.java
@@ -109,7 +109,7 @@ public class CreateRoleCmd extends RoleCmd {
}
if (getRoleId() != null && getRoleId() < 1L) {
- throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "Invalid role id provided");
+ throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "Invalid role ID provided");
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/UpdateRoleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/UpdateRoleCmd.java
index 7d002cd889b..78fe062ac43 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/UpdateRoleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/UpdateRoleCmd.java
@@ -46,7 +46,7 @@ public class UpdateRoleCmd extends RoleCmd {
description = "ID of the role", validations = {ApiArgValidator.PositiveNumber})
private Long roleId;
- @Parameter(name = ApiConstants.NAME, type = BaseCmd.CommandType.STRING, description = "creates a role with this unique name")
+ @Parameter(name = ApiConstants.NAME, type = BaseCmd.CommandType.STRING, description = "Creates a role with this unique name")
private String roleName;
@Parameter(name = ApiConstants.DESCRIPTION, type = BaseCmd.CommandType.STRING, description = "The description of the role")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/UpdateRolePermissionCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/UpdateRolePermissionCmd.java
index 3f926092ec3..8f8115e9957 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/UpdateRolePermissionCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/UpdateRolePermissionCmd.java
@@ -53,7 +53,7 @@ public class UpdateRolePermissionCmd extends BaseCmd {
private Long roleId;
@Parameter(name = ApiConstants.RULE_ORDER, type = CommandType.LIST, collectionType = CommandType.UUID, entityType = RolePermissionResponse.class,
- description = "The parent role permission uuid, use 0 to move this rule at the top of the list")
+ description = "The parent role permission UUID, use 0 to move this rule at the top of the list")
private List rulePermissionOrder;
@Parameter(name = ApiConstants.RULE_ID, type = CommandType.UUID, entityType = RolePermissionResponse.class,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/project/CreateProjectRoleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/project/CreateProjectRoleCmd.java
index ed17a876b24..f71daee5b53 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/project/CreateProjectRoleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/project/CreateProjectRoleCmd.java
@@ -41,7 +41,7 @@ public class CreateProjectRoleCmd extends ProjectRoleCmd {
/////////////////////////////////////////////////////
@Parameter(name = ApiConstants.NAME, type = BaseCmd.CommandType.STRING, required = true,
- description = "creates a project role with this unique name")
+ description = "Creates a project role with this unique name")
private String projectRoleName;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/project/ListProjectRolesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/project/ListProjectRolesCmd.java
index e876dbc9b58..dedbb410ea5 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/project/ListProjectRolesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/project/ListProjectRolesCmd.java
@@ -72,7 +72,7 @@ public class ListProjectRolesCmd extends BaseListCmd {
@Override
public void execute() {
- List projectRoles;
+ List projectRoles = new ArrayList<>();
if (getProjectId() != null && getProjectRoleId() != null) {
projectRoles = Collections.singletonList(projRoleService.findProjectRole(getProjectRoleId(), getProjectId()));
} else if (StringUtils.isNotBlank(getRoleName())) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/project/UpdateProjectRoleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/project/UpdateProjectRoleCmd.java
index 3bc8b3d6186..80dbfd71275 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/project/UpdateProjectRoleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/project/UpdateProjectRoleCmd.java
@@ -43,7 +43,7 @@ public class UpdateProjectRoleCmd extends ProjectRoleCmd {
private Long id;
@Parameter(name = ApiConstants.NAME, type = BaseCmd.CommandType.STRING,
- description = "creates a project role with this unique name", validations = {ApiArgValidator.NotNullOrEmpty})
+ description = "Creates a project role with this unique name", validations = {ApiArgValidator.NotNullOrEmpty})
private String projectRoleName;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/project/UpdateProjectRolePermissionCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/project/UpdateProjectRolePermissionCmd.java
index dd59310c66a..b273b9f5849 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/project/UpdateProjectRolePermissionCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/acl/project/UpdateProjectRolePermissionCmd.java
@@ -57,7 +57,7 @@ public class UpdateProjectRolePermissionCmd extends BaseCmd {
private Long projectId;
@Parameter(name = ApiConstants.RULE_ORDER, type = CommandType.LIST, collectionType = CommandType.UUID, entityType = ProjectRolePermissionResponse.class,
- description = "The parent role permission uuid, use 0 to move this rule at the top of the list")
+ description = "ID of the parent role permission, use 0 to move this rule at the top of the list")
private List projectRulePermissionOrder;
@Parameter(name = ApiConstants.PROJECT_ROLE_PERMISSION_ID, type = CommandType.UUID, entityType = ProjectRolePermissionResponse.class,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/address/AcquirePodIpCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/address/AcquirePodIpCmdByAdmin.java
index 7397697bd2c..88c48103c1b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/address/AcquirePodIpCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/address/AcquirePodIpCmdByAdmin.java
@@ -40,7 +40,7 @@ public class AcquirePodIpCmdByAdmin extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.STRING, entityType = ZoneResponse.class, required = true, description = "the ID of the zone")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.STRING, entityType = ZoneResponse.class, required = true, description = "The ID of the zone")
private String zoneId;
@Parameter(name = ApiConstants.POD_ID, type = CommandType.STRING, entityType = ZoneResponse.class, required = false, description = "Pod ID")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/address/AssociateIPAddrCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/address/AssociateIPAddrCmdByAdmin.java
index 672691ffbd8..a34de31f78e 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/address/AssociateIPAddrCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/address/AssociateIPAddrCmdByAdmin.java
@@ -23,7 +23,7 @@ import org.apache.cloudstack.api.command.admin.AdminCmd;
import org.apache.cloudstack.api.command.user.address.AssociateIPAddrCmd;
import org.apache.cloudstack.api.response.IPAddressResponse;
-@APICommand(name = "associateIpAddress", description = "Acquires and associates a public IP to an account.", responseObject = IPAddressResponse.class, responseView = ResponseView.Full,
+@APICommand(name = "associateIpAddress", description = "Acquires and associates a public IP to an Account.", responseObject = IPAddressResponse.class, responseView = ResponseView.Full,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class AssociateIPAddrCmdByAdmin extends AssociateIPAddrCmd implements AdminCmd {
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/address/ListPublicIpAddressesCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/address/ListPublicIpAddressesCmdByAdmin.java
index 4bd6aa7227c..9976747e1b6 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/address/ListPublicIpAddressesCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/address/ListPublicIpAddressesCmdByAdmin.java
@@ -24,6 +24,6 @@ import org.apache.cloudstack.api.response.IPAddressResponse;
import com.cloud.network.IpAddress;
-@APICommand(name = "listPublicIpAddresses", description = "Lists all public ip addresses", responseObject = IPAddressResponse.class, responseView = ResponseView.Full,
+@APICommand(name = "listPublicIpAddresses", description = "Lists all public IP addresses", responseObject = IPAddressResponse.class, responseView = ResponseView.Full,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false, entityType = {IpAddress.class})
public class ListPublicIpAddressesCmdByAdmin extends ListPublicIpAddressesCmd implements AdminCmd {}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/address/ReleasePodIpCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/address/ReleasePodIpCmdByAdmin.java
index 7d4cab6a0ac..266c8eecd58 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/address/ReleasePodIpCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/address/ReleasePodIpCmdByAdmin.java
@@ -70,7 +70,7 @@ public class ReleasePodIpCmdByAdmin extends BaseCmd {
response.setDisplayText("IP is released successfully");
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to release Pod ip ");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to release Pod IP");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/affinitygroup/UpdateVMAffinityGroupCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/affinitygroup/UpdateVMAffinityGroupCmdByAdmin.java
index 43e70838e18..fbe2d3cc0bd 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/affinitygroup/UpdateVMAffinityGroupCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/affinitygroup/UpdateVMAffinityGroupCmdByAdmin.java
@@ -26,7 +26,7 @@ import org.apache.cloudstack.api.response.UserVmResponse;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "updateVMAffinityGroup", description = "Updates the affinity/anti-affinity group associations of a virtual machine. The VM has to be stopped and restarted for the "
+@APICommand(name = "updateVMAffinityGroup", description = "Updates the affinity/anti-affinity group associations of an Instance. The Instance has to be stopped and restarted for the "
+ "new properties to take effect.", responseObject = UserVmResponse.class, responseView = ResponseView.Full,
entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/annotation/AddAnnotationCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/annotation/AddAnnotationCmd.java
index c2ded921c40..834fda1834b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/annotation/AddAnnotationCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/annotation/AddAnnotationCmd.java
@@ -33,22 +33,22 @@ import org.apache.cloudstack.api.response.AnnotationResponse;
import org.apache.cloudstack.context.CallContext;
import org.apache.commons.lang3.BooleanUtils;
-@APICommand(name = "addAnnotation", description = "add an annotation.", responseObject = AnnotationResponse.class,
+@APICommand(name = "addAnnotation", description = "Add an annotation.", responseObject = AnnotationResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false, since = "4.11", authorized = {RoleType.Admin})
public class AddAnnotationCmd extends BaseCmd {
- @Parameter(name = ApiConstants.ANNOTATION, type = CommandType.STRING, description = "the annotation text")
+ @Parameter(name = ApiConstants.ANNOTATION, type = CommandType.STRING, description = "The annotation text")
private String annotation;
@Parameter(name = ApiConstants.ENTITY_TYPE, type = CommandType.STRING, description = "The following entity types are allowed VM, VOLUME, SNAPSHOT, VM_SNAPSHOT, INSTANCE_GROUP, SSH_KEYPAIR, USER_DATA, NETWORK, VPC, PUBLIC_IP_ADDRESS, VPN_CUSTOMER_GATEWAY, TEMPLATE, ISO, KUBERNETES_CLUSTER, SERVICE_OFFERING, DISK_OFFERING, NETWORK_OFFERING, ZONE, POD, CLUSTER, HOST, DOMAIN, PRIMARY_STORAGE, SECONDARY_STORAGE, VR, SYSTEM_VM, AUTOSCALE_VM_GROUP, MANAGEMENT_SERVER")
private String entityType;
- @Parameter(name = ApiConstants.ENTITY_ID, type = CommandType.STRING, description = "the id of the entity to annotate")
+ @Parameter(name = ApiConstants.ENTITY_ID, type = CommandType.STRING, description = "The ID of the entity to annotate")
private String entityUuid;
@Parameter(name = ApiConstants.ADMINS_ONLY, type = CommandType.BOOLEAN, since = "4.16.0",
- description = "the annotation is visible for admins only")
+ description = "The annotation is visible for admins only")
private Boolean adminsOnly;
public String getAnnotation() {
@@ -77,7 +77,7 @@ public class AddAnnotationCmd extends BaseCmd {
public void execute()
throws ResourceUnavailableException, InsufficientCapacityException, ServerApiException, ConcurrentOperationException, ResourceAllocationException,
NetworkRuleConflictException {
- Preconditions.checkNotNull(getEntityUuid(),"I have to have an entity to set an annotation on!");
+ Preconditions.checkNotNull(getEntityUuid(),"I need to have an entity to set an annotation on!");
Preconditions.checkState(AnnotationService.EntityType.contains(entityType),(java.lang.String)"'%s' is not a valid EntityType to put annotations on", entityType);
AnnotationResponse annotationResponse = annotationService.addAnnotation(this);
annotationResponse.setResponseName(getCommandName());
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/annotation/ListAnnotationsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/annotation/ListAnnotationsCmd.java
index 3df4536786f..fcaba5154e1 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/annotation/ListAnnotationsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/annotation/ListAnnotationsCmd.java
@@ -37,22 +37,22 @@ import org.apache.commons.lang3.StringUtils;
public class ListAnnotationsCmd extends BaseListCmd {
- @Parameter(name = ApiConstants.ID, type = CommandType.STRING, description = "the id of the annotation")
+ @Parameter(name = ApiConstants.ID, type = CommandType.STRING, description = "The ID of the annotation")
private String uuid;
- @Parameter(name = ApiConstants.ENTITY_TYPE, type = CommandType.STRING, description = "the entity type")
+ @Parameter(name = ApiConstants.ENTITY_TYPE, type = CommandType.STRING, description = "The entity type")
private String entityType;
- @Parameter(name = ApiConstants.ENTITY_ID, type = CommandType.STRING, description = "the id of the entity for which to show annotations")
+ @Parameter(name = ApiConstants.ENTITY_ID, type = CommandType.STRING, description = "The ID of the entity for which to show annotations")
private String entityUuid;
@Parameter(name = ApiConstants.USER_ID, type = CommandType.STRING, since = "4.16.0",
- description = "optional: the id of the user of the annotation", required = false)
+ description = "Optional: The ID of the user of the annotation", required = false)
private String userUuid;
@Parameter(name = ApiConstants.ANNOTATION_FILTER,
type = CommandType.STRING, since = "4.16.0",
- description = "possible values are \"self\" and \"all\". "
+ description = "Possible values are \"self\" and \"all\". "
+ "* self : annotations that have been created by the calling user. "
+ "* all : all the annotations the calling user can access")
private String annotationFilter;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/annotation/RemoveAnnotationCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/annotation/RemoveAnnotationCmd.java
index 693ad09bfa9..d173c35289f 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/annotation/RemoveAnnotationCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/annotation/RemoveAnnotationCmd.java
@@ -30,12 +30,12 @@ import org.apache.cloudstack.api.ServerApiException;
import org.apache.cloudstack.api.response.AnnotationResponse;
import org.apache.cloudstack.context.CallContext;
-@APICommand(name = "removeAnnotation", description = "remove an annotation.", responseObject = AnnotationResponse.class,
+@APICommand(name = "removeAnnotation", description = "Remove an annotation.", responseObject = AnnotationResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false, since = "4.11", authorized = {RoleType.Admin})
public class RemoveAnnotationCmd extends BaseCmd {
- @Parameter(name = ApiConstants.ID, type = CommandType.STRING, required = true, description = "the id of the annotation")
+ @Parameter(name = ApiConstants.ID, type = CommandType.STRING, required = true, description = "The ID of the annotation")
private String uuid;
public String getUuid() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/annotation/UpdateAnnotationVisibilityCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/annotation/UpdateAnnotationVisibilityCmd.java
index b1b7295510c..d0bd7042ead 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/annotation/UpdateAnnotationVisibilityCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/annotation/UpdateAnnotationVisibilityCmd.java
@@ -30,7 +30,7 @@ import org.apache.cloudstack.api.ServerApiException;
import org.apache.cloudstack.api.response.AnnotationResponse;
import org.apache.cloudstack.context.CallContext;
-@APICommand(name = "updateAnnotationVisibility", description = "update an annotation visibility.",
+@APICommand(name = "updateAnnotationVisibility", description = "Update an annotation visibility.",
responseObject = AnnotationResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false,
since = "4.16", authorized = {RoleType.Admin})
@@ -38,11 +38,11 @@ public class UpdateAnnotationVisibilityCmd extends BaseCmd {
@Parameter(name = ApiConstants.ID, type = CommandType.STRING, required = true,
- description = "the id of the annotation")
+ description = "The ID of the annotation")
private String uuid;
@Parameter(name = ApiConstants.ADMINS_ONLY, type = CommandType.BOOLEAN, required = true,
- description = "the annotation is visible for admins only")
+ description = "The annotation is visible for admins only")
private Boolean adminsOnly;
public String getUuid() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/autoscale/CreateCounterCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/autoscale/CreateCounterCmd.java
index 7fa66ffff1f..4b0ca25691a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/autoscale/CreateCounterCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/autoscale/CreateCounterCmd.java
@@ -31,7 +31,7 @@ import com.cloud.event.EventTypes;
import com.cloud.network.as.Counter;
import com.cloud.user.Account;
-@APICommand(name = "createCounter", description = "Adds metric counter for VM auto scaling", responseObject = CounterResponse.class,
+@APICommand(name = "createCounter", description = "Adds metric counter for Instance auto scaling", responseObject = CounterResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class CreateCounterCmd extends BaseAsyncCreateCmd {
private static final String s_name = "counterresponse";
@@ -113,7 +113,7 @@ public class CreateCounterCmd extends BaseAsyncCreateCmd {
@Override
public String getEventDescription() {
- return "creating a new Counter";
+ return "Creating a new Counter";
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/autoscale/DeleteCounterCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/autoscale/DeleteCounterCmd.java
index b7b2ce5cb70..fb0c9606c51 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/autoscale/DeleteCounterCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/autoscale/DeleteCounterCmd.java
@@ -32,7 +32,7 @@ import com.cloud.event.EventTypes;
import com.cloud.exception.ResourceInUseException;
import com.cloud.user.Account;
-@APICommand(name = "deleteCounter", description = "Deletes a counter for VM auto scaling", responseObject = SuccessResponse.class,
+@APICommand(name = "deleteCounter", description = "Deletes a counter for Instance auto scaling", responseObject = SuccessResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class DeleteCounterCmd extends BaseAsyncCmd {
@@ -40,7 +40,7 @@ public class DeleteCounterCmd extends BaseAsyncCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = CounterResponse.class, required = true, description = "the ID of the counter")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = CounterResponse.class, required = true, description = "The ID of the counter")
private Long id;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/backup/ImportBackupOfferingCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/backup/ImportBackupOfferingCmd.java
index 7d3902bc490..2e73698e7aa 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/backup/ImportBackupOfferingCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/backup/ImportBackupOfferingCmd.java
@@ -55,11 +55,11 @@ public class ImportBackupOfferingCmd extends BaseAsyncCmd {
////////////////////////////////////////////////////
@Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true,
- description = "the name of the backup offering")
+ description = "The name of the backup offering")
private String name;
@Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, required = true,
- description = "the description of the backup offering")
+ description = "The description of the backup offering")
private String description;
@Parameter(name = ApiConstants.EXTERNAL_ID,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/ca/ProvisionCertificateCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/ca/ProvisionCertificateCmd.java
index a39985549ac..af24e1f10c8 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/ca/ProvisionCertificateCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/ca/ProvisionCertificateCmd.java
@@ -52,7 +52,7 @@ public class ProvisionCertificateCmd extends BaseAsyncCmd {
/////////////////////////////////////////////////////
@Parameter(name = ApiConstants.HOST_ID, type = CommandType.UUID, required = true, entityType = HostResponse.class,
- description = "The host/agent uuid to which the certificate has to be provisioned (issued and propagated)")
+ description = "The host/agent ID to which the certificate has to be provisioned (issued and propagated)")
private Long hostId;
@Parameter(name = ApiConstants.RECONNECT, type = CommandType.BOOLEAN,
@@ -108,7 +108,7 @@ public class ProvisionCertificateCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "provisioning certificate for host id=" + hostId + " using provider=" + provider;
+ return "Provisioning certificate for host id=" + hostId + " using provider=" + provider;
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/ca/RevokeCertificateCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/ca/RevokeCertificateCmd.java
index 381bed65f95..c2212442f4b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/ca/RevokeCertificateCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/ca/RevokeCertificateCmd.java
@@ -105,6 +105,6 @@ public class RevokeCertificateCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "revoking certificate with serial id=" + serial + ", cn=" + cn;
+ return "Revoking certificate with serial id=" + serial + ", cn=" + cn;
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/cluster/AddClusterCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/cluster/AddClusterCmd.java
index 69cb43ce40e..89cd4a05245 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/cluster/AddClusterCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/cluster/AddClusterCmd.java
@@ -44,48 +44,48 @@ import com.cloud.user.Account;
public class AddClusterCmd extends BaseCmd {
- @Parameter(name = ApiConstants.CLUSTER_NAME, type = CommandType.STRING, required = true, description = "the cluster name")
+ @Parameter(name = ApiConstants.CLUSTER_NAME, type = CommandType.STRING, required = true, description = "The cluster name")
private String clusterName;
- @Parameter(name = ApiConstants.PASSWORD, type = CommandType.STRING, required = false, description = "the password for the host")
+ @Parameter(name = ApiConstants.PASSWORD, type = CommandType.STRING, required = false, description = "The password for the host")
private String password;
- @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, required = true, description = "the Pod ID for the host")
+ @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, required = true, description = "The Pod ID for the host")
private Long podId;
- @Parameter(name = ApiConstants.URL, type = CommandType.STRING, required = false, description = "the URL")
+ @Parameter(name = ApiConstants.URL, type = CommandType.STRING, required = false, description = "The URL")
private String url;
- @Parameter(name = ApiConstants.USERNAME, type = CommandType.STRING, required = false, description = "the username for the cluster")
+ @Parameter(name = ApiConstants.USERNAME, type = CommandType.STRING, required = false, description = "The username for the cluster")
private String username;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, required = true, description = "the Zone ID for the cluster")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, required = true, description = "The Zone ID for the cluster")
private Long zoneId;
@Parameter(name = ApiConstants.HYPERVISOR,
type = CommandType.STRING,
required = true,
- description = "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3")
+ description = "Hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3")
private String hypervisor;
@Parameter(name = ApiConstants.ARCH, type = CommandType.STRING,
- description = "the CPU arch of the cluster. Valid options are: x86_64, aarch64",
+ description = "The CPU arch of the cluster. Valid options are: x86_64, aarch64",
since = "4.20")
private String arch;
- @Parameter(name = ApiConstants.CLUSTER_TYPE, type = CommandType.STRING, required = true, description = "type of the cluster: CloudManaged, ExternalManaged")
+ @Parameter(name = ApiConstants.CLUSTER_TYPE, type = CommandType.STRING, required = true, description = "Type of the cluster: CloudManaged, ExternalManaged")
private String clusterType;
@Parameter(name = ApiConstants.ALLOCATION_STATE, type = CommandType.STRING, description = "Allocation state of this cluster for allocation of new resources")
private String allocationState;
- @Parameter(name = ApiConstants.VSM_USERNAME, type = CommandType.STRING, required = false, description = "the username for the VSM associated with this cluster")
+ @Parameter(name = ApiConstants.VSM_USERNAME, type = CommandType.STRING, required = false, description = "The username for the VSM associated with this cluster")
private String vsmusername;
- @Parameter(name = ApiConstants.VSM_PASSWORD, type = CommandType.STRING, required = false, description = "the password for the VSM associated with this cluster")
+ @Parameter(name = ApiConstants.VSM_PASSWORD, type = CommandType.STRING, required = false, description = "The password for the VSM associated with this cluster")
private String vsmpassword;
- @Parameter(name = ApiConstants.VSM_IPADDRESS, type = CommandType.STRING, required = false, description = "the ipaddress of the VSM associated with this cluster")
+ @Parameter(name = ApiConstants.VSM_IPADDRESS, type = CommandType.STRING, required = false, description = "The IP address of the VSM associated with this cluster")
private String vsmipaddress;
@Parameter(name = ApiConstants.VSWITCH_TYPE_GUEST_TRAFFIC,
@@ -109,7 +109,7 @@ public class AddClusterCmd extends BaseCmd {
@Parameter(name = ApiConstants.VSWITCH_NAME_PUBLIC_TRAFFIC,
type = CommandType.STRING,
required = false,
- description = "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.")
+ description = "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.")
private String vSwitchNamePublicTraffic;
@Parameter(name = ApiConstants.OVM3_POOL, type = CommandType.STRING, required = false, description = "Ovm3 native pooling enabled for cluster")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/cluster/DeleteClusterCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/cluster/DeleteClusterCmd.java
index 2b1cfe8bcb5..afabf7fef16 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/cluster/DeleteClusterCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/cluster/DeleteClusterCmd.java
@@ -38,7 +38,7 @@ public class DeleteClusterCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ClusterResponse.class, required = true, description = "the cluster ID")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ClusterResponse.class, required = true, description = "The cluster ID")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/cluster/ListClustersCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/cluster/ListClustersCmd.java
index 362913a1138..b464930b9dd 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/cluster/ListClustersCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/cluster/ListClustersCmd.java
@@ -42,31 +42,31 @@ public class ListClustersCmd extends BaseListCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ClusterResponse.class, description = "lists clusters by the cluster ID")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ClusterResponse.class, description = "Lists clusters by the cluster ID")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "lists clusters by the cluster name")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "Lists clusters by the cluster name")
private String clusterName;
- @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "lists clusters by Pod ID")
+ @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "Lists clusters by Pod ID")
private Long podId;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "lists clusters by Zone ID")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "Lists clusters by Zone ID")
private Long zoneId;
- @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, description = "lists clusters by hypervisor type")
+ @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, description = "Lists clusters by hypervisor type")
private String hypervisorType;
- @Parameter(name = ApiConstants.CLUSTER_TYPE, type = CommandType.STRING, description = "lists clusters by cluster type")
+ @Parameter(name = ApiConstants.CLUSTER_TYPE, type = CommandType.STRING, description = "Lists clusters by cluster type")
private String clusterType;
- @Parameter(name = ApiConstants.ALLOCATION_STATE, type = CommandType.STRING, description = "lists clusters by allocation state")
+ @Parameter(name = ApiConstants.ALLOCATION_STATE, type = CommandType.STRING, description = "Lists clusters by allocation state")
private String allocationState;
- @Parameter(name = ApiConstants.MANAGED_STATE, type = CommandType.STRING, description = "whether this cluster is managed by cloudstack")
+ @Parameter(name = ApiConstants.MANAGED_STATE, type = CommandType.STRING, description = "Whether this cluster is managed by cloudstack")
private String managedState;
- @Parameter(name = ApiConstants.SHOW_CAPACITIES, type = CommandType.BOOLEAN, description = "flag to display the capacity of the clusters")
+ @Parameter(name = ApiConstants.SHOW_CAPACITIES, type = CommandType.BOOLEAN, description = "Flag to display the capacity of the clusters")
private Boolean showCapacities;
@Parameter(name = ApiConstants.ARCH, type = CommandType.STRING,
@@ -128,19 +128,19 @@ public class ListClustersCmd extends BaseListCmd {
protected Pair, Integer> getClusterResponses() {
Pair, Integer> result = _mgr.searchForClusters(this);
- List clusterResponses = new ArrayList();
+ List clusterResponses = new ArrayList<>();
for (Cluster cluster : result.first()) {
ClusterResponse clusterResponse = _responseGenerator.createClusterResponse(cluster, showCapacities);
clusterResponse.setObjectName("cluster");
clusterResponses.add(clusterResponse);
}
- return new Pair, Integer>(clusterResponses, result.second());
+ return new Pair<>(clusterResponses, result.second());
}
@Override
public void execute() {
Pair, Integer> clusterResponses = getClusterResponses();
- ListResponse response = new ListResponse();
+ ListResponse response = new ListResponse<>();
response.setResponses(clusterResponses.first(), clusterResponses.second());
response.setResponseName(getCommandName());
this.setResponseObject(response);
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/cluster/UpdateClusterCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/cluster/UpdateClusterCmd.java
index c4ee87380ed..fde463312ca 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/cluster/UpdateClusterCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/cluster/UpdateClusterCmd.java
@@ -37,22 +37,22 @@ import org.apache.commons.lang3.StringUtils;
public class UpdateClusterCmd extends BaseCmd {
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ClusterResponse.class, required = true, description = "the ID of the Cluster")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ClusterResponse.class, required = true, description = "The ID of the Cluster")
private Long id;
- @Parameter(name = ApiConstants.CLUSTER_NAME, type = CommandType.STRING, description = "the cluster name")
+ @Parameter(name = ApiConstants.CLUSTER_NAME, type = CommandType.STRING, description = "The cluster name")
private String clusterName;
- @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, description = "hypervisor type of the cluster")
+ @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, description = "Hypervisor type of the cluster")
private String hypervisor;
- @Parameter(name = ApiConstants.CLUSTER_TYPE, type = CommandType.STRING, description = "hypervisor type of the cluster")
+ @Parameter(name = ApiConstants.CLUSTER_TYPE, type = CommandType.STRING, description = "Hypervisor type of the cluster")
private String clusterType;
@Parameter(name = ApiConstants.ALLOCATION_STATE, type = CommandType.STRING, description = "Allocation state of this cluster for allocation of new resources")
private String allocationState;
- @Parameter(name = ApiConstants.MANAGED_STATE, type = CommandType.STRING, description = "whether this cluster is managed by cloudstack")
+ @Parameter(name = ApiConstants.MANAGED_STATE, type = CommandType.STRING, description = "Whether this cluster is managed by cloudstack")
private String managedState;
@Parameter(name = ApiConstants.ARCH, type = CommandType.STRING,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/config/ListCfgGroupsByCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/config/ListCfgGroupsByCmd.java
index d735218169d..c63e7cf92d4 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/config/ListCfgGroupsByCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/config/ListCfgGroupsByCmd.java
@@ -40,7 +40,7 @@ public class ListCfgGroupsByCmd extends BaseListCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.GROUP, type = CommandType.STRING, description = "lists configuration group by group name")
+ @Parameter(name = ApiConstants.GROUP, type = CommandType.STRING, description = "Lists configuration group by group name")
private String groupName;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/config/ListCfgsByCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/config/ListCfgsByCmd.java
index e365d8bc2dc..f6f66415f53 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/config/ListCfgsByCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/config/ListCfgsByCmd.java
@@ -52,55 +52,55 @@ public class ListCfgsByCmd extends BaseListCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.CATEGORY, type = CommandType.STRING, description = "lists configurations by category")
+ @Parameter(name = ApiConstants.CATEGORY, type = CommandType.STRING, description = "Lists configurations by category")
private String category;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "lists configuration by name")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "Lists configuration by name")
private String configName;
@Parameter(name = ApiConstants.ZONE_ID,
type = CommandType.UUID,
entityType = ZoneResponse.class,
- description = "the ID of the Zone to update the parameter value for corresponding zone")
+ description = "The ID of the Zone to update the parameter value for corresponding zone")
private Long zoneId;
@Parameter(name = ApiConstants.CLUSTER_ID,
type = CommandType.UUID,
entityType = ClusterResponse.class,
- description = "the ID of the Cluster to update the parameter value for corresponding cluster")
+ description = "The ID of the Cluster to update the parameter value for corresponding cluster")
private Long clusterId;
@Parameter(name = ApiConstants.STORAGE_ID,
type = CommandType.UUID,
entityType = StoragePoolResponse.class,
- description = "the ID of the Storage pool to update the parameter value for corresponding storage pool")
+ description = "The ID of the Storage pool to update the parameter value for corresponding storage pool")
private Long storagePoolId;
@Parameter(name = ApiConstants.ACCOUNT_ID,
type = CommandType.UUID,
entityType = AccountResponse.class,
- description = "the ID of the Account to update the parameter value for corresponding account")
+ description = "The ID of the Account to update the parameter value for corresponding account")
private Long accountId;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "the ID of the Domain to update the parameter value for corresponding domain")
+ description = "The ID of the Domain to update the parameter value for corresponding domain")
private Long domainId;
@Parameter(name = ApiConstants.IMAGE_STORE_UUID,
type = CommandType.UUID,
entityType = ImageStoreResponse.class,
- description = "the ID of the Image Store to update the parameter value for corresponding image store")
+ description = "The ID of the Image Store to update the parameter value for corresponding image store")
private Long imageStoreId;
- @Parameter(name = ApiConstants.GROUP, type = CommandType.STRING, description = "lists configuration by group name (primarily used for UI)", since = "4.18.0")
+ @Parameter(name = ApiConstants.GROUP, type = CommandType.STRING, description = "Lists configuration by group name (primarily used for UI)", since = "4.18.0")
private String groupName;
- @Parameter(name = ApiConstants.SUBGROUP, type = CommandType.STRING, description = "lists configuration by subgroup name (primarily used for UI)", since = "4.18.0")
+ @Parameter(name = ApiConstants.SUBGROUP, type = CommandType.STRING, description = "Lists configuration by subgroup name (primarily used for UI)", since = "4.18.0")
private String subGroupName;
- @Parameter(name = ApiConstants.PARENT, type = CommandType.STRING, description = "lists configuration by parent name (primarily used for UI)", since = "4.18.0")
+ @Parameter(name = ApiConstants.PARENT, type = CommandType.STRING, description = "Lists configuration by parent name (primarily used for UI)", since = "4.18.0")
private String parentName;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/config/ListHypervisorCapabilitiesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/config/ListHypervisorCapabilitiesCmd.java
index e7cc9e0234e..d8622f94b6b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/config/ListHypervisorCapabilitiesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/config/ListHypervisorCapabilitiesCmd.java
@@ -47,7 +47,7 @@ public class ListHypervisorCapabilitiesCmd extends BaseListCmd {
@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = HypervisorCapabilitiesResponse.class, description = "ID of the hypervisor capability")
private Long id;
- @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, description = "the hypervisor for which to restrict the search")
+ @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, description = "The hypervisor for which to restrict the search")
private String hypervisor;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/config/ResetCfgCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/config/ResetCfgCmd.java
index f114b263b63..2d511cff34d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/config/ResetCfgCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/config/ResetCfgCmd.java
@@ -45,43 +45,43 @@ public class ResetCfgCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "the name of the configuration", validations = {ApiArgValidator.NotNullOrEmpty})
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "The name of the configuration", validations = {ApiArgValidator.NotNullOrEmpty})
private String cfgName;
@Parameter(name = ApiConstants.ZONE_ID,
type = CommandType.UUID,
entityType = ZoneResponse.class,
- description = "the ID of the Zone to reset the parameter value for corresponding zone")
+ description = "The ID of the Zone to reset the parameter value for corresponding zone")
private Long zoneId;
@Parameter(name = ApiConstants.CLUSTER_ID,
type = CommandType.UUID,
entityType = ClusterResponse.class,
- description = "the ID of the Cluster to reset the parameter value for corresponding cluster")
+ description = "The ID of the Cluster to reset the parameter value for corresponding cluster")
private Long clusterId;
@Parameter(name = ApiConstants.STORAGE_ID,
type = CommandType.UUID,
entityType = StoragePoolResponse.class,
- description = "the ID of the Storage pool to reset the parameter value for corresponding storage pool")
+ description = "The ID of the Storage pool to reset the parameter value for corresponding storage pool")
private Long storagePoolId;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "the ID of the Domain to reset the parameter value for corresponding domain")
+ description = "The ID of the Domain to reset the parameter value for corresponding domain")
private Long domainId;
@Parameter(name = ApiConstants.ACCOUNT_ID,
type = CommandType.UUID,
entityType = AccountResponse.class,
- description = "the ID of the Account to reset the parameter value for corresponding account")
+ description = "The ID of the Account to reset the parameter value for corresponding account")
private Long accountId;
@Parameter(name = ApiConstants.IMAGE_STORE_ID,
type = CommandType.UUID,
entityType = ImageStoreResponse.class,
- description = "the ID of the Image Store to reset the parameter value for corresponding image store")
+ description = "The ID of the Image Store to reset the parameter value for corresponding image store")
private Long imageStoreId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/config/UpdateCfgCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/config/UpdateCfgCmd.java
index dbf478df701..2fad8d71c68 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/config/UpdateCfgCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/config/UpdateCfgCmd.java
@@ -45,46 +45,46 @@ public class UpdateCfgCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "the name of the configuration")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "The name of the configuration")
private String cfgName;
- @Parameter(name = ApiConstants.VALUE, type = CommandType.STRING, description = "the value of the configuration", length = 4096)
+ @Parameter(name = ApiConstants.VALUE, type = CommandType.STRING, description = "The value of the configuration", length = 4096)
private String value;
@Parameter(name = ApiConstants.ZONE_ID,
type = CommandType.UUID,
entityType = ZoneResponse.class,
- description = "the ID of the Zone to update the parameter value for corresponding zone")
+ description = "The ID of the Zone to update the parameter value for corresponding zone")
private Long zoneId;
@Parameter(name = ApiConstants.CLUSTER_ID,
type = CommandType.UUID,
entityType = ClusterResponse.class,
- description = "the ID of the Cluster to update the parameter value for corresponding cluster")
+ description = "The ID of the Cluster to update the parameter value for corresponding cluster")
private Long clusterId;
@Parameter(name = ApiConstants.STORAGE_ID,
type = CommandType.UUID,
entityType = StoragePoolResponse.class,
- description = "the ID of the Storage pool to update the parameter value for corresponding storage pool")
+ description = "The ID of the Storage pool to update the parameter value for corresponding storage pool")
private Long storagePoolId;
@Parameter(name = ApiConstants.ACCOUNT_ID,
type = CommandType.UUID,
entityType = AccountResponse.class,
- description = "the ID of the Account to update the parameter value for corresponding account")
+ description = "The ID of the Account to update the parameter value for corresponding account")
private Long accountId;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "the ID of the Domain to update the parameter value for corresponding domain")
+ description = "The ID of the Domain to update the parameter value for corresponding domain")
private Long domainId;
@Parameter(name = ApiConstants.IMAGE_STORE_UUID,
type = CommandType.UUID,
entityType = ImageStoreResponse.class,
- description = "the ID of the Image Store to update the parameter value for corresponding image store",
+ description = "The ID of the Image Store to update the parameter value for corresponding image store",
validations = ApiArgValidator.PositiveNumber)
private Long imageStoreId;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/config/UpdateHypervisorCapabilitiesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/config/UpdateHypervisorCapabilitiesCmd.java
index 01f7af10841..d7342654ec4 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/config/UpdateHypervisorCapabilitiesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/config/UpdateHypervisorCapabilitiesCmd.java
@@ -43,28 +43,28 @@ public class UpdateHypervisorCapabilitiesCmd extends BaseCmd {
@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = HypervisorCapabilitiesResponse.class, description = "ID of the hypervisor capability")
private Long id;
- @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, description = "the hypervisor for which the hypervisor capabilities are to be updated", since = "4.19.1")
+ @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, description = "The hypervisor for which the hypervisor capabilities are to be updated", since = "4.19.1")
private String hypervisor;
- @Parameter(name = ApiConstants.HYPERVISOR_VERSION, type = CommandType.STRING, description = "the hypervisor version for which the hypervisor capabilities are to be updated", since = "4.19.1")
+ @Parameter(name = ApiConstants.HYPERVISOR_VERSION, type = CommandType.STRING, description = "The hypervisor version for which the hypervisor capabilities are to be updated", since = "4.19.1")
private String hypervisorVersion;
- @Parameter(name = ApiConstants.SECURITY_GROUP_EANBLED, type = CommandType.BOOLEAN, description = "set true to enable security group for this hypervisor.")
+ @Parameter(name = ApiConstants.SECURITY_GROUP_EANBLED, type = CommandType.BOOLEAN, description = "Set true to enable security group for this hypervisor.")
private Boolean securityGroupEnabled;
- @Parameter(name = ApiConstants.MAX_GUESTS_LIMIT, type = CommandType.LONG, description = "the max number of Guest VMs per host for this hypervisor.")
+ @Parameter(name = ApiConstants.MAX_GUESTS_LIMIT, type = CommandType.LONG, description = "The maximum number of Guest Instances per host for this hypervisor.")
private Long maxGuestsLimit;
- @Parameter(name = ApiConstants.MAX_DATA_VOLUMES_LIMIT, type = CommandType.INTEGER, description = "the maximum number of Data Volumes that can be attached to a VM for this hypervisor.", since = "4.16.0")
+ @Parameter(name = ApiConstants.MAX_DATA_VOLUMES_LIMIT, type = CommandType.INTEGER, description = "The maximum number of Data Volumes that can be attached to an Instance for this hypervisor.", since = "4.16.0")
private Integer maxDataVolumesLimit;
- @Parameter(name = ApiConstants.STORAGE_MOTION_ENABLED, type = CommandType.BOOLEAN, description = "set true to enable storage motion support for this hypervisor", since = "4.16.0")
+ @Parameter(name = ApiConstants.STORAGE_MOTION_ENABLED, type = CommandType.BOOLEAN, description = "Set true to enable storage motion support for this hypervisor", since = "4.16.0")
private Boolean storageMotionSupported;
- @Parameter(name = ApiConstants.MAX_HOSTS_PER_CLUSTER, type = CommandType.INTEGER, description = "the maximum number of the hypervisor hosts per cluster ", since = "4.16.0")
+ @Parameter(name = ApiConstants.MAX_HOSTS_PER_CLUSTER, type = CommandType.INTEGER, description = "The maximum number of the hypervisor hosts per cluster ", since = "4.16.0")
private Integer maxHostsPerClusterLimit;
- @Parameter(name = ApiConstants.VM_SNAPSHOT_ENABELD, type = CommandType.BOOLEAN, description = "set true to enable VM snapshots for this hypervisor", since = "4.16.0")
+ @Parameter(name = ApiConstants.VM_SNAPSHOT_ENABELD, type = CommandType.BOOLEAN, description = "Set true to enable Instance Snapshots for this hypervisor", since = "4.16.0")
private Boolean vmSnapshotEnabled;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/diagnostics/GetDiagnosticsDataCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/diagnostics/GetDiagnosticsDataCmd.java
index 553ba6b1729..6a59788715e 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/diagnostics/GetDiagnosticsDataCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/diagnostics/GetDiagnosticsDataCmd.java
@@ -48,7 +48,7 @@ import com.cloud.vm.VirtualMachine;
entityType = {VirtualMachine.class},
responseHasSensitiveInfo = false,
requestHasSensitiveInfo = false,
- description = "Get diagnostics and files from system VMs",
+ description = "Get diagnostics and files from System VMs",
since = "4.14.0.0",
authorized = {RoleType.Admin})
public class GetDiagnosticsDataCmd extends BaseAsyncCmd {
@@ -64,7 +64,7 @@ public class GetDiagnosticsDataCmd extends BaseAsyncCmd {
entityType = SystemVmResponse.class,
required = true,
validations = {ApiArgValidator.PositiveNumber},
- description = "The ID of the system VM instance to retrieve diagnostics data files from")
+ description = "The ID of the System VM to retrieve diagnostics data files from")
private Long id;
@Parameter(name = ApiConstants.FILES,
@@ -113,7 +113,7 @@ public class GetDiagnosticsDataCmd extends BaseAsyncCmd {
response.setResponseName(getCommandName());
this.setResponseObject(response);
} else {
- throw new CloudRuntimeException("failed to generate valid download url: " + downloadUrl);
+ throw new CloudRuntimeException("Failed to generate valid download url: " + downloadUrl);
}
} catch (ServerApiException e) {
throw new CloudRuntimeException("Internal exception caught while retrieving diagnostics files: ", e);
@@ -140,7 +140,7 @@ public class GetDiagnosticsDataCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "Getting diagnostics data files from system vm: " + this._uuidMgr.getUuid(VirtualMachine.class, getId());
+ return "Getting diagnostics data files from System VM: " + this._uuidMgr.getUuid(VirtualMachine.class, getId());
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/diagnostics/RunDiagnosticsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/diagnostics/RunDiagnosticsCmd.java
index 4537eb6f215..577d86146fd 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/diagnostics/RunDiagnosticsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/diagnostics/RunDiagnosticsCmd.java
@@ -48,7 +48,7 @@ import com.cloud.vm.VirtualMachine;
@APICommand(name = "runDiagnostics", responseObject = RunDiagnosticsResponse.class, entityType = {VirtualMachine.class},
responseHasSensitiveInfo = false,
requestHasSensitiveInfo = false,
- description = "Execute network-utility command (ping/arping/tracert) on system VMs remotely",
+ description = "Execute network-utility command (ping/arping/tracert) on System VMs remotely",
authorized = {RoleType.Admin},
since = "4.12.0.0")
public class RunDiagnosticsCmd extends BaseAsyncCmd {
@@ -62,7 +62,7 @@ public class RunDiagnosticsCmd extends BaseAsyncCmd {
@ACL(accessType = SecurityChecker.AccessType.OperateEntry)
@Parameter(name = ApiConstants.TARGET_ID, type = CommandType.UUID, required = true, entityType = SystemVmResponse.class,
validations = {ApiArgValidator.PositiveNumber},
- description = "The ID of the system VM instance to diagnose")
+ description = "The ID of the System VM to diagnose")
private Long id;
@Parameter(name = ApiConstants.IP_ADDRESS, type = CommandType.STRING, required = true,
@@ -70,7 +70,7 @@ public class RunDiagnosticsCmd extends BaseAsyncCmd {
private String address;
@Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, required = true,
- description = "The system VM diagnostics type valid options are: ping, traceroute, arping")
+ description = "The System VM diagnostics type valid options are: ping, traceroute, arping")
private String type;
@Parameter(name = ApiConstants.PARAMS, type = CommandType.STRING,
@@ -153,7 +153,7 @@ public class RunDiagnosticsCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "Executing diagnostics on system vm: " + this._uuidMgr.getUuid(VirtualMachine.class, getId());
+ return "Executing diagnostics on System VM: " + this._uuidMgr.getUuid(VirtualMachine.class, getId());
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/direct/download/ListTemplateDirectDownloadCertificatesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/direct/download/ListTemplateDirectDownloadCertificatesCmd.java
index 145ff6ba782..9a605ec4200 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/direct/download/ListTemplateDirectDownloadCertificatesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/direct/download/ListTemplateDirectDownloadCertificatesCmd.java
@@ -41,7 +41,7 @@ import java.util.ArrayList;
import java.util.List;
@APICommand(name = "listTemplateDirectDownloadCertificates",
- description = "List the uploaded certificates for direct download templates",
+ description = "List the uploaded certificates for direct download Templates",
responseObject = DirectDownloadCertificateResponse.class,
since = "4.17.0",
authorized = {RoleType.Admin})
@@ -51,15 +51,15 @@ public class ListTemplateDirectDownloadCertificatesCmd extends BaseListCmd {
DirectDownloadManager directDownloadManager;
@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = DirectDownloadCertificateResponse.class,
- description = "list direct download certificate by ID")
+ description = "List direct download certificate by ID")
private Long id;
@Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class,
- description = "the zone where certificates are uploaded")
+ description = "The zone where certificates are uploaded")
private Long zoneId;
@Parameter(name = ApiConstants.LIST_HOSTS, type = CommandType.BOOLEAN,
- description = "if set to true: include the hosts where the certificate is uploaded to")
+ description = "If set to true: include the hosts where the certificate is uploaded to")
private Boolean listHosts;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/direct/download/ProvisionTemplateDirectDownloadCertificateCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/direct/download/ProvisionTemplateDirectDownloadCertificateCmd.java
index 88f538547e1..3dfbbd940c4 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/direct/download/ProvisionTemplateDirectDownloadCertificateCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/direct/download/ProvisionTemplateDirectDownloadCertificateCmd.java
@@ -50,11 +50,11 @@ public class ProvisionTemplateDirectDownloadCertificateCmd extends BaseCmd {
DirectDownloadManager directDownloadManager;
@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = DirectDownloadCertificateResponse.class,
- description = "the id of the direct download certificate to provision", required = true)
+ description = "The id of the direct download certificate to provision", required = true)
private Long id;
@Parameter(name = ApiConstants.HOST_ID, type = CommandType.UUID, entityType = HostResponse.class,
- description = "the host to provision the certificate", required = true)
+ description = "The host to provision the certificate", required = true)
private Long hostId;
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/direct/download/RevokeTemplateDirectDownloadCertificateCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/direct/download/RevokeTemplateDirectDownloadCertificateCmd.java
index eb9031cbc58..1ad8f271cfc 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/direct/download/RevokeTemplateDirectDownloadCertificateCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/direct/download/RevokeTemplateDirectDownloadCertificateCmd.java
@@ -59,23 +59,23 @@ public class RevokeTemplateDirectDownloadCertificateCmd extends BaseCmd {
@Parameter(name = ApiConstants.ID, type = CommandType.UUID,
entityType = DirectDownloadCertificateResponse.class,
- description = "id of the certificate")
+ description = "ID of the certificate")
private Long certificateId;
@Parameter(name = ApiConstants.NAME, type = BaseCmd.CommandType.STRING,
- description = "(optional) alias of the SSL certificate")
+ description = "(Optional) alias of the SSL certificate")
private String certificateAlias;
@Parameter(name = ApiConstants.HYPERVISOR, type = BaseCmd.CommandType.STRING,
- description = "(optional) hypervisor type")
+ description = "(Optional) hypervisor type")
private String hypervisor;
@Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class,
- description = "(optional) zone to revoke certificate", required = true)
+ description = "(Optional) zone to revoke certificate", required = true)
private Long zoneId;
@Parameter(name = ApiConstants.HOST_ID, type = CommandType.UUID, entityType = HostResponse.class,
- description = "(optional) the host ID to revoke certificate")
+ description = "(Optional) the host ID to revoke certificate")
private Long hostId;
private void createResponse(final List hostsRevokeStatusList) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/direct/download/UploadTemplateDirectDownloadCertificateCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/direct/download/UploadTemplateDirectDownloadCertificateCmd.java
index c5c102be56d..780198dded5 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/direct/download/UploadTemplateDirectDownloadCertificateCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/direct/download/UploadTemplateDirectDownloadCertificateCmd.java
@@ -39,7 +39,7 @@ import java.util.ArrayList;
import java.util.List;
@APICommand(name = "uploadTemplateDirectDownloadCertificate",
- description = "Upload a certificate for HTTPS direct template download on KVM hosts",
+ description = "Upload a certificate for HTTPS direct Template download on KVM hosts",
responseObject = DirectDownloadCertificateResponse.class,
since = "4.11.0",
authorized = {RoleType.Admin})
@@ -65,7 +65,7 @@ public class UploadTemplateDirectDownloadCertificateCmd extends BaseCmd {
private Long zoneId;
@Parameter(name = ApiConstants.HOST_ID, type = CommandType.UUID, entityType = HostResponse.class,
- description = "(optional) the host ID to upload certificate")
+ description = "(Optional) the host ID to upload certificate")
private Long hostId;
private void createResponse(DirectDownloadCertificate certificate, final List hostStatusList) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/domain/CreateDomainCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/domain/CreateDomainCmd.java
index c7f06920bb8..a20f69c90f5 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/domain/CreateDomainCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/domain/CreateDomainCmd.java
@@ -40,13 +40,13 @@ public class CreateDomainCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "creates domain with this name")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "Creates domain with this name")
private String domainName;
@Parameter(name = ApiConstants.PARENT_DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "assigns new domain a parent domain by domain ID of the parent. If no parent domain is specified, the ROOT domain is assumed.")
+ description = "Assigns new domain a parent domain by domain ID of the parent. If no parent domain is specified, the ROOT domain is assumed.")
private Long parentDomainId;
@Parameter(name = ApiConstants.NETWORK_DOMAIN, type = CommandType.STRING, description = "Network domain for networks in the domain")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/domain/DeleteDomainCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/domain/DeleteDomainCmd.java
index db3bae25e39..6adb457f4f8 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/domain/DeleteDomainCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/domain/DeleteDomainCmd.java
@@ -49,7 +49,7 @@ public class DeleteDomainCmd extends BaseAsyncCmd {
@Parameter(name = ApiConstants.CLEANUP,
type = CommandType.BOOLEAN,
- description = "true if all domain resources (child domains, accounts) have to be cleaned up, false otherwise")
+ description = "True if all domain resources (child domains, Accounts) have to be cleaned up, false otherwise")
private Boolean cleanup;
@Inject
@@ -88,7 +88,7 @@ public class DeleteDomainCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "deleting domain: " + getId();
+ return "Deleting domain: " + getId();
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/domain/ListDomainChildrenCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/domain/ListDomainChildrenCmd.java
index 8514bb6dda5..e93948987bb 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/domain/ListDomainChildrenCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/domain/ListDomainChildrenCmd.java
@@ -42,15 +42,15 @@ public class ListDomainChildrenCmd extends BaseListCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "list children domain by parent domain ID.")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "List children domain by parent domain ID.")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "list children domains by name")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "List children domains by name")
private String domainName;
@Parameter(name = ApiConstants.IS_RECURSIVE,
type = CommandType.BOOLEAN,
- description = "to return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".")
+ description = "To return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".")
private Boolean recursive;
@Parameter(name = ApiConstants.LIST_ALL,
@@ -59,7 +59,7 @@ public class ListDomainChildrenCmd extends BaseListCmd {
private Boolean listAll;
@Parameter(name = ApiConstants.SHOW_RESOURCE_ICON, type = CommandType.BOOLEAN,
- description = "flag to display the resource icon for domains")
+ description = "Flag to display the resource icon for domains")
private Boolean showIcon;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/domain/ListDomainsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/domain/ListDomainsCmd.java
index 895e9328992..5c5a92c45ca 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/domain/ListDomainsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/domain/ListDomainsCmd.java
@@ -64,11 +64,11 @@ public class ListDomainsCmd extends BaseListCmd implements UserCmd {
@Parameter(name = ApiConstants.DETAILS,
type = CommandType.LIST,
collectionType = CommandType.STRING,
- description = "comma separated list of domain details requested, value can be a list of [ all, resource, min]")
+ description = "Comma separated list of domain details requested, value can be a list of [ all, resource, min]")
private List viewDetails;
@Parameter(name = ApiConstants.SHOW_RESOURCE_ICON, type = CommandType.BOOLEAN,
- description = "flag to display the resource icon for domains")
+ description = "Flag to display the resource icon for domains")
private Boolean showIcon;
@Parameter(name = ApiConstants.TAG, type = CommandType.STRING, description = "Tag for resource type to return usage", since = "4.20.0")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/domain/UpdateDomainCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/domain/UpdateDomainCmd.java
index 353cb852bfd..adce521627f 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/domain/UpdateDomainCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/domain/UpdateDomainCmd.java
@@ -44,7 +44,7 @@ public class UpdateDomainCmd extends BaseCmd {
@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = DomainResponse.class, required = true, description = "ID of domain to update")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "updates domain with this name")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "Updates domain with this name")
private String domainName;
@Parameter(name = ApiConstants.NETWORK_DOMAIN,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/guest/AddGuestOsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/guest/AddGuestOsCmd.java
index b854e8389c4..1868d0412a1 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/guest/AddGuestOsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/guest/AddGuestOsCmd.java
@@ -138,7 +138,7 @@ public class AddGuestOsCmd extends BaseAsyncCreateCmd {
@Override
public String getEventDescription() {
- return "adding a new guest OS type Id: " + getEntityId();
+ return "Adding a new guest OS type Id: " + getEntityId();
}
@Override
@@ -153,7 +153,7 @@ public class AddGuestOsCmd extends BaseAsyncCreateCmd {
@Override
public String getCreateEventDescription() {
- return "adding new guest OS type";
+ return "Adding new guest OS type";
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/guest/AddGuestOsMappingCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/guest/AddGuestOsMappingCmd.java
index 3fdfebb54bf..1a32168308e 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/guest/AddGuestOsMappingCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/guest/AddGuestOsMappingCmd.java
@@ -133,7 +133,7 @@ public class AddGuestOsMappingCmd extends BaseAsyncCreateCmd {
@Override
public String getEventDescription() {
- return "adding a new guest OS mapping Id: " + getEntityId();
+ return "Adding a new guest OS mapping Id: " + getEntityId();
}
@Override
@@ -148,6 +148,6 @@ public class AddGuestOsMappingCmd extends BaseAsyncCreateCmd {
@Override
public String getCreateEventDescription() {
- return "adding new guest OS mapping";
+ return "Adding new guest OS mapping";
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/guest/GetHypervisorGuestOsNamesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/guest/GetHypervisorGuestOsNamesCmd.java
index da920a2ec2d..811ecc8b165 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/guest/GetHypervisorGuestOsNamesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/guest/GetHypervisorGuestOsNamesCmd.java
@@ -44,11 +44,11 @@ public class GetHypervisorGuestOsNamesCmd extends BaseAsyncCmd {
validations = {ApiArgValidator.NotNullOrEmpty})
private String hypervisor;
- @Parameter(name = ApiConstants.HYPERVISOR_VERSION, type = CommandType.STRING, required = true, description = "Hypervisor version to get the guest os names (atleast one hypervisor host with the version specified must be available)",
+ @Parameter(name = ApiConstants.HYPERVISOR_VERSION, type = CommandType.STRING, required = true, description = "Hypervisor version to get the guest OS names (at least one hypervisor host with the version specified must be available)",
validations = {ApiArgValidator.NotNullOrEmpty})
private String hypervisorVersion;
- @Parameter(name = ApiConstants.KEYWORD, type = CommandType.STRING, required = false, description = "Keyword for guest os name")
+ @Parameter(name = ApiConstants.KEYWORD, type = CommandType.STRING, required = false, description = "Keyword for guest OS name")
private String keyword;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/guest/ListGuestOsMappingCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/guest/ListGuestOsMappingCmd.java
index 23e62cdc781..47082dae68c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/guest/ListGuestOsMappingCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/guest/ListGuestOsMappingCmd.java
@@ -40,22 +40,22 @@ public class ListGuestOsMappingCmd extends BaseListCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = GuestOsMappingResponse.class, required = false, description = "list mapping by its UUID")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = GuestOsMappingResponse.class, required = false, description = "List mapping by its UUID")
private Long id;
- @Parameter(name = ApiConstants.OS_TYPE_ID, type = CommandType.UUID, entityType = GuestOSResponse.class, required = false, description = "list mapping by Guest OS Type UUID")
+ @Parameter(name = ApiConstants.OS_TYPE_ID, type = CommandType.UUID, entityType = GuestOSResponse.class, required = false, description = "List mapping by Guest OS Type UUID")
private Long osTypeId;
- @Parameter(name = ApiConstants.OS_DISPLAY_NAME, type = CommandType.STRING, required = false, description = "list Guest OS mapping by OS display name")
+ @Parameter(name = ApiConstants.OS_DISPLAY_NAME, type = CommandType.STRING, required = false, description = "List Guest OS mapping by OS display name")
private String osDisplayName;
- @Parameter(name = ApiConstants.OS_NAME_FOR_HYPERVISOR, type = CommandType.STRING, required = false, description = "list Guest OS mapping by OS mapping name with hypervisor")
+ @Parameter(name = ApiConstants.OS_NAME_FOR_HYPERVISOR, type = CommandType.STRING, required = false, description = "List Guest OS mapping by OS mapping name with hypervisor")
private String osNameForHypervisor;
- @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, required = false, description = "list Guest OS mapping by hypervisor")
+ @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, required = false, description = "List Guest OS mapping by hypervisor")
private String hypervisor;
- @Parameter(name = ApiConstants.HYPERVISOR_VERSION, type = CommandType.STRING, required = false, description = "list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter")
+ @Parameter(name = ApiConstants.HYPERVISOR_VERSION, type = CommandType.STRING, required = false, description = "List Guest OS mapping by hypervisor version. Must be used with hypervisor parameter")
private String hypervisorVersion;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/ConfigureHAForHostCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/ConfigureHAForHostCmd.java
index 12033c04b80..d7707e197d6 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/ConfigureHAForHostCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/ConfigureHAForHostCmd.java
@@ -115,6 +115,6 @@ public final class ConfigureHAForHostCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "configure HA for host: " + getHostId();
+ return "Configure HA for host: " + getHostId();
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/DisableHAForClusterCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/DisableHAForClusterCmd.java
index d570746765b..51554b7607d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/DisableHAForClusterCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/DisableHAForClusterCmd.java
@@ -102,7 +102,7 @@ public final class DisableHAForClusterCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "disable HA for cluster: " + getClusterId();
+ return "Disable HA for cluster: " + getClusterId();
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/DisableHAForHostCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/DisableHAForHostCmd.java
index 5a8b1f1954f..ad9c6414532 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/DisableHAForHostCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/DisableHAForHostCmd.java
@@ -104,6 +104,6 @@ public final class DisableHAForHostCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "disable HA for host: " + getHostId();
+ return "Disable HA for host: " + getHostId();
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/DisableHAForZoneCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/DisableHAForZoneCmd.java
index fbd57fa82a1..1f0758459b5 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/DisableHAForZoneCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/DisableHAForZoneCmd.java
@@ -103,7 +103,7 @@ public final class DisableHAForZoneCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "disable HA for zone: " + getZoneId();
+ return "Disable HA for zone: " + getZoneId();
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/EnableHAForClusterCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/EnableHAForClusterCmd.java
index 7e627939ca5..3bb7a4c3070 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/EnableHAForClusterCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/EnableHAForClusterCmd.java
@@ -103,6 +103,6 @@ public final class EnableHAForClusterCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "enable HA for cluster: " + getClusterId();
+ return "Enable HA for cluster: " + getClusterId();
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/EnableHAForHostCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/EnableHAForHostCmd.java
index aac3d350519..f5476722543 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/EnableHAForHostCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/EnableHAForHostCmd.java
@@ -104,6 +104,6 @@ public final class EnableHAForHostCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "enable HA for host: " + getHostId();
+ return "Enable HA for host: " + getHostId();
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/EnableHAForZoneCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/EnableHAForZoneCmd.java
index f9b1560bd8a..99607315c54 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/EnableHAForZoneCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/ha/EnableHAForZoneCmd.java
@@ -103,7 +103,7 @@ public final class EnableHAForZoneCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "enable HA for zone: " + getZoneId();
+ return "Enable HA for zone: " + getZoneId();
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/AddHostCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/AddHostCmd.java
index ca27837aa88..6c8eded2618 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/AddHostCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/AddHostCmd.java
@@ -45,34 +45,34 @@ public class AddHostCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.CLUSTER_ID, type = CommandType.UUID, entityType = ClusterResponse.class, description = "the cluster ID for the host")
+ @Parameter(name = ApiConstants.CLUSTER_ID, type = CommandType.UUID, entityType = ClusterResponse.class, description = "The cluster ID for the host")
private Long clusterId;
- @Parameter(name = ApiConstants.CLUSTER_NAME, type = CommandType.STRING, description = "the cluster name for the host")
+ @Parameter(name = ApiConstants.CLUSTER_NAME, type = CommandType.STRING, description = "The cluster name for the host")
private String clusterName;
- @Parameter(name = ApiConstants.USERNAME, type = CommandType.STRING, description = "the username for the host; required to be passed for hypervisors other than VMWare")
+ @Parameter(name = ApiConstants.USERNAME, type = CommandType.STRING, description = "The username for the host; required to be passed for hypervisors other than VMWare")
private String username;
- @Parameter(name = ApiConstants.PASSWORD, type = CommandType.STRING, description = "the password for the host; required to be passed for hypervisors other than VMWare")
+ @Parameter(name = ApiConstants.PASSWORD, type = CommandType.STRING, description = "The password for the host; required to be passed for hypervisors other than VMWare")
private String password;
- @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, required = true, description = "the Pod ID for the host")
+ @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, required = true, description = "The Pod ID for the host")
private Long podId;
- @Parameter(name = ApiConstants.URL, type = CommandType.STRING, required = true, description = "the host URL")
+ @Parameter(name = ApiConstants.URL, type = CommandType.STRING, required = true, description = "The host URL")
private String url;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, required = true, description = "the Zone ID for the host")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, required = true, description = "The Zone ID for the host")
private Long zoneId;
- @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, required = true, description = "hypervisor type of the host")
+ @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, required = true, description = "Hypervisor type of the host")
private String hypervisor;
@Parameter(name = ApiConstants.ALLOCATION_STATE, type = CommandType.STRING, description = "Allocation state of this Host for allocation of new resources")
private String allocationState;
- @Parameter(name = ApiConstants.HOST_TAGS, type = CommandType.LIST, collectionType = CommandType.STRING, description = "list of tags to be added to the host")
+ @Parameter(name = ApiConstants.HOST_TAGS, type = CommandType.LIST, collectionType = CommandType.STRING, description = "List of tags to be added to the host")
private List hostTags;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/AddSecondaryStorageCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/AddSecondaryStorageCmd.java
index c965a39450b..9a7eff7e2e5 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/AddSecondaryStorageCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/AddSecondaryStorageCmd.java
@@ -38,10 +38,10 @@ public class AddSecondaryStorageCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.URL, type = CommandType.STRING, required = true, description = "the URL for the secondary storage")
+ @Parameter(name = ApiConstants.URL, type = CommandType.STRING, required = true, description = "The URL for the secondary storage")
protected String url;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "the Zone ID for the secondary storage")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "The Zone ID for the secondary storage")
protected Long zoneId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/CancelHostAsDegradedCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/CancelHostAsDegradedCmd.java
index 4e9d997b3b7..f68da1edcd1 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/CancelHostAsDegradedCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/CancelHostAsDegradedCmd.java
@@ -47,7 +47,7 @@ public class CancelHostAsDegradedCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = BaseCmd.CommandType.UUID, entityType = HostResponse.class, description = "host ID", required = true, validations = {ApiArgValidator.PositiveNumber})
+ @Parameter(name = ApiConstants.ID, type = BaseCmd.CommandType.UUID, entityType = HostResponse.class, description = "Host ID", required = true, validations = {ApiArgValidator.PositiveNumber})
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/CancelMaintenanceCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/CancelMaintenanceCmd.java
index a514a61b8a4..96882985f26 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/CancelMaintenanceCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/CancelMaintenanceCmd.java
@@ -40,7 +40,7 @@ public class CancelMaintenanceCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = HostResponse.class, required = true, description = "the host ID")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = HostResponse.class, required = true, description = "The host ID")
private Long id;
/////////////////////////////////////////////////////
@@ -76,7 +76,7 @@ public class CancelMaintenanceCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "canceling maintenance for host: " + getId();
+ return "Canceling maintenance for host: " + getId();
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/DeclareHostAsDegradedCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/DeclareHostAsDegradedCmd.java
index 6bb8f382e54..209d8b65fba 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/DeclareHostAsDegradedCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/DeclareHostAsDegradedCmd.java
@@ -33,7 +33,7 @@ import org.apache.cloudstack.api.response.HostResponse;
import org.apache.cloudstack.context.CallContext;
@APICommand(name = "declareHostAsDegraded",
- description = "Declare host as 'Degraded'. Host must be on 'Disconnected' or 'Alert' state. The ADMIN must be sure that there are no VMs running on the respective host otherwise this command might corrupted VMs that were running on the 'Degraded' host.",
+ description = "Declare host as 'Degraded'. Host must be on 'Disconnected' or 'Alert' state. The ADMIN must be sure that there are no Instances running on the respective host otherwise this command might corrupted Instances that were running on the 'Degraded' host.",
since = "4.16.0.0",
responseObject = HostResponse.class,
requestHasSensitiveInfo = false,
@@ -47,7 +47,7 @@ public class DeclareHostAsDegradedCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = BaseCmd.CommandType.UUID, entityType = HostResponse.class, description = "host ID", required = true, validations = {ApiArgValidator.PositiveNumber})
+ @Parameter(name = ApiConstants.ID, type = BaseCmd.CommandType.UUID, entityType = HostResponse.class, description = "Host ID", required = true, validations = {ApiArgValidator.PositiveNumber})
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/DeleteHostCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/DeleteHostCmd.java
index 38325c2f072..79ad1acec9f 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/DeleteHostCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/DeleteHostCmd.java
@@ -37,17 +37,17 @@ public class DeleteHostCmd extends BaseCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = HostResponse.class, required = true, description = "the host ID")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = HostResponse.class, required = true, description = "The host ID")
private Long id;
@Parameter(name = ApiConstants.FORCED,
type = CommandType.BOOLEAN,
- description = "Force delete the host. All HA enabled vms running on the host will be put to HA; HA disabled ones will be stopped")
+ description = "Force delete the host. All HA enabled Instances running on the host will be put to HA; HA disabled ones will be stopped")
private Boolean forced;
@Parameter(name = ApiConstants.FORCED_DESTROY_LOCAL_STORAGE,
type = CommandType.BOOLEAN,
- description = "Force destroy local storage on this host. All VMs created on this local storage will be destroyed")
+ description = "Force destroy local storage on this host. All Instances created on this local storage will be destroyed")
private Boolean forceDestroyLocalStorage;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/FindHostsForMigrationCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/FindHostsForMigrationCmd.java
index db30e4f4c02..abca619f82a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/FindHostsForMigrationCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/FindHostsForMigrationCmd.java
@@ -33,7 +33,7 @@ import com.cloud.host.Host;
import com.cloud.utils.Pair;
import com.cloud.utils.Ternary;
-@APICommand(name = "findHostsForMigration", description = "Find hosts suitable for migrating a virtual machine.", responseObject = HostForMigrationResponse.class,
+@APICommand(name = "findHostsForMigration", description = "Find hosts suitable for migrating an Instance.", responseObject = HostForMigrationResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class FindHostsForMigrationCmd extends BaseListCmd {
@@ -46,7 +46,7 @@ public class FindHostsForMigrationCmd extends BaseListCmd {
type = CommandType.UUID,
entityType = UserVmResponse.class,
required = true,
- description = "find hosts to which this VM can be migrated and flag the hosts with enough " + "CPU/RAM to host the VM")
+ description = "Find hosts to which this Instance can be migrated and flag the hosts with enough " + "CPU/RAM to host the Instance")
private Long virtualMachineId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/ListHostsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/ListHostsCmd.java
index 099ffc0bde4..a73a0d00ffb 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/ListHostsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/ListHostsCmd.java
@@ -51,59 +51,59 @@ public class ListHostsCmd extends BaseListCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.CLUSTER_ID, type = CommandType.UUID, entityType = ClusterResponse.class, description = "lists hosts existing in particular cluster")
+ @Parameter(name = ApiConstants.CLUSTER_ID, type = CommandType.UUID, entityType = ClusterResponse.class, description = "Lists hosts existing in particular cluster")
private Long clusterId;
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = HostResponse.class, description = "the id of the host")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = HostResponse.class, description = "The ID of the host")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the host")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the host")
private String hostName;
- @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "the Pod ID for the host")
+ @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "The Pod ID for the host")
private Long podId;
- @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "the state of the host")
+ @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "The state of the host")
private String state;
- @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, description = "the host type")
+ @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, description = "The host type")
private String type;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "the Zone ID for the host")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "The Zone ID for the host")
private Long zoneId;
@Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID,
type = CommandType.UUID,
entityType = UserVmResponse.class,
required = false,
- description = "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM")
+ description = "Lists hosts in the same cluster as this Instance and flag hosts with enough CPU/RAm to host this Instance")
private Long virtualMachineId;
@Parameter(name = ApiConstants.OUTOFBANDMANAGEMENT_ENABLED,
type = CommandType.BOOLEAN,
- description = "list hosts for which out-of-band management is enabled")
+ description = "List hosts for which out-of-band management is enabled")
private Boolean outOfBandManagementEnabled;
@Parameter(name = ApiConstants.OUTOFBANDMANAGEMENT_POWERSTATE,
type = CommandType.STRING,
- description = "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]")
+ description = "List hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]")
private String outOfBandManagementPowerState;
@Parameter(name = ApiConstants.RESOURCE_STATE,
type = CommandType.STRING,
- description = "list hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]")
+ description = "List hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]")
private String resourceState;
@Parameter(name = ApiConstants.DETAILS,
type = CommandType.LIST,
collectionType = CommandType.STRING,
- description = "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]")
+ description = "Comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]")
private List viewDetails;
- @Parameter(name = ApiConstants.HA_HOST, type = CommandType.BOOLEAN, description = "if true, list only hosts dedicated to HA")
+ @Parameter(name = ApiConstants.HA_HOST, type = CommandType.BOOLEAN, description = "If true, list only hosts dedicated to HA")
private Boolean haHost;
- @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, description = "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator")
+ @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, description = "Hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator")
private String hypervisor;
@Parameter(name = ApiConstants.ARCH, type = CommandType.STRING, description = "CPU Arch of the host", since = "4.20.1")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/PrepareForMaintenanceCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/PrepareForMaintenanceCmd.java
index 2641c54364e..53fe6fe3dab 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/PrepareForMaintenanceCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/PrepareForMaintenanceCmd.java
@@ -40,7 +40,7 @@ public class PrepareForMaintenanceCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = HostResponse.class, required = true, description = "the host ID")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = HostResponse.class, required = true, description = "The host ID")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/ReconnectHostCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/ReconnectHostCmd.java
index 3550d61fdb9..178a96cedbd 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/ReconnectHostCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/ReconnectHostCmd.java
@@ -41,7 +41,7 @@ public class ReconnectHostCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = HostResponse.class, required = true, description = "the host ID")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = HostResponse.class, required = true, description = "The host ID")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/ReleaseHostReservationCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/ReleaseHostReservationCmd.java
index 7fee0684c78..d7905421a8f 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/ReleaseHostReservationCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/ReleaseHostReservationCmd.java
@@ -40,7 +40,7 @@ public class ReleaseHostReservationCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = HostResponse.class, required = true, description = "the host ID")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = HostResponse.class, required = true, description = "The host ID")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/UpdateHostCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/UpdateHostCmd.java
index 397f9c80735..fa7376f74bb 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/UpdateHostCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/UpdateHostCmd.java
@@ -38,7 +38,7 @@ public class UpdateHostCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = HostResponse.class, required = true, description = "the ID of the host to update")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = HostResponse.class, required = true, description = "The ID of the host to update")
private Long id;
@Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "Change the name of host", since = "4.15", authorized = {RoleType.Admin})
@@ -47,7 +47,7 @@ public class UpdateHostCmd extends BaseCmd {
@Parameter(name = ApiConstants.OS_CATEGORY_ID,
type = CommandType.UUID,
entityType = GuestOSCategoryResponse.class,
- description = "the id of Os category to update the host with")
+ description = "The ID of OS category to update the host with")
private Long osCategoryId;
@Parameter(name = ApiConstants.ALLOCATION_STATE,
@@ -55,13 +55,13 @@ public class UpdateHostCmd extends BaseCmd {
description = "Change resource state of host, valid values are [Enable, Disable]. Operation may failed if host in states not allowing Enable/Disable")
private String allocationState;
- @Parameter(name = ApiConstants.HOST_TAGS, type = CommandType.LIST, collectionType = CommandType.STRING, description = "list of tags to be added to the host")
+ @Parameter(name = ApiConstants.HOST_TAGS, type = CommandType.LIST, collectionType = CommandType.STRING, description = "List of tags to be added to the host")
private List hostTags;
@Parameter(name = ApiConstants.IS_TAG_A_RULE, type = CommandType.BOOLEAN, description = ApiConstants.PARAMETER_DESCRIPTION_IS_TAG_A_RULE)
private Boolean isTagARule;
- @Parameter(name = ApiConstants.URL, type = CommandType.STRING, description = "the new uri for the secondary storage: nfs://host/path")
+ @Parameter(name = ApiConstants.URL, type = CommandType.STRING, description = "The new URI for the secondary storage: nfs://host/path")
private String url;
@Parameter(name = ApiConstants.ANNOTATION, type = CommandType.STRING, description = "Add an annotation to this host", since = "4.11", authorized = {RoleType.Admin})
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/UpdateHostPasswordCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/UpdateHostPasswordCmd.java
index c94fe2c5865..f96f01d3a87 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/host/UpdateHostPasswordCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/host/UpdateHostPasswordCmd.java
@@ -36,19 +36,19 @@ public class UpdateHostPasswordCmd extends BaseCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.HOST_ID, type = CommandType.UUID, entityType = HostResponse.class, description = "the host ID")
+ @Parameter(name = ApiConstants.HOST_ID, type = CommandType.UUID, entityType = HostResponse.class, description = "The host ID")
private Long hostId;
- @Parameter(name = ApiConstants.CLUSTER_ID, type = CommandType.UUID, entityType = ClusterResponse.class, description = "the cluster ID")
+ @Parameter(name = ApiConstants.CLUSTER_ID, type = CommandType.UUID, entityType = ClusterResponse.class, description = "The cluster ID")
private Long clusterId;
- @Parameter(name = ApiConstants.SHOULD_UPDATE_PASSWORD, type = CommandType.BOOLEAN, description = "if the password should also be updated on the hosts")
+ @Parameter(name = ApiConstants.SHOULD_UPDATE_PASSWORD, type = CommandType.BOOLEAN, description = "If the password should also be updated on the hosts")
private Boolean updatePasswdOnHost;
- @Parameter(name = ApiConstants.USERNAME, type = CommandType.STRING, required = true, description = "the username for the host/cluster")
+ @Parameter(name = ApiConstants.USERNAME, type = CommandType.STRING, required = true, description = "The username for the host/cluster")
private String username;
- @Parameter(name = ApiConstants.PASSWORD, type = CommandType.STRING, required = true, description = "the new password for the host/cluster")
+ @Parameter(name = ApiConstants.PASSWORD, type = CommandType.STRING, required = true, description = "The new password for the host/cluster")
private String password;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/ConfigureInternalLoadBalancerElementCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/ConfigureInternalLoadBalancerElementCmd.java
index c94d326ee62..9bb28523eca 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/ConfigureInternalLoadBalancerElementCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/ConfigureInternalLoadBalancerElementCmd.java
@@ -50,7 +50,7 @@ public class ConfigureInternalLoadBalancerElementCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = InternalLoadBalancerElementResponse.class,
required = true,
- description = "the ID of the internal lb provider")
+ description = "The ID of the internal lb provider")
private Long id;
@Parameter(name = ApiConstants.ENABLED, type = CommandType.BOOLEAN, required = true, description = "Enables/Disables the Internal Load Balancer element")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/CreateInternalLoadBalancerElementCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/CreateInternalLoadBalancerElementCmd.java
index 924287b673b..474bbc831e5 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/CreateInternalLoadBalancerElementCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/CreateInternalLoadBalancerElementCmd.java
@@ -48,7 +48,7 @@ public class CreateInternalLoadBalancerElementCmd extends BaseAsyncCreateCmd {
type = CommandType.UUID,
entityType = ProviderResponse.class,
required = true,
- description = "the network service provider ID of the internal load balancer element")
+ description = "The network service provider ID of the internal load balancer element")
private Long nspId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/ListInternalLBVMsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/ListInternalLBVMsCmd.java
index 0eb00234382..9ba23279c5d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/ListInternalLBVMsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/ListInternalLBVMsCmd.java
@@ -35,7 +35,7 @@ import org.apache.cloudstack.api.response.ZoneResponse;
import com.cloud.network.router.VirtualRouter.Role;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "listInternalLoadBalancerVMs", description = "List internal LB VMs.", responseObject = DomainRouterResponse.class, entityType = {VirtualMachine.class},
+@APICommand(name = "listInternalLoadBalancerVMs", description = "List internal LB Instances.", responseObject = DomainRouterResponse.class, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListInternalLBVMsCmd extends BaseListProjectAndAccountResourcesCmd {
@@ -45,36 +45,36 @@ public class ListInternalLBVMsCmd extends BaseListProjectAndAccountResourcesCmd
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.HOST_ID, type = CommandType.UUID, entityType = HostResponse.class, description = "the host ID of the Internal LB VM")
+ @Parameter(name = ApiConstants.HOST_ID, type = CommandType.UUID, entityType = HostResponse.class, description = "The host ID of the Internal LB Instance")
private Long hostId;
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = UserVmResponse.class, description = "the ID of the Internal LB VM")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = UserVmResponse.class, description = "The ID of the Internal LB Instance")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the Internal LB VM")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the Internal LB Instance")
private String routerName;
- @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "the Pod ID of the Internal LB VM")
+ @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "The Pod ID of the Internal LB Instance")
private Long podId;
- @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "the state of the Internal LB VM")
+ @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "The state of the Internal LB Instance")
private String state;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "the Zone ID of the Internal LB VM")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "The Zone ID of the Internal LB Instance")
private Long zoneId;
- @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "list by network id")
+ @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "List by Network ID")
private Long networkId;
- @Parameter(name = ApiConstants.VPC_ID, type = CommandType.UUID, entityType = VpcResponse.class, description = "List Internal LB VMs by VPC")
+ @Parameter(name = ApiConstants.VPC_ID, type = CommandType.UUID, entityType = VpcResponse.class, description = "List Internal LB Instances by VPC")
private Long vpcId;
- @Parameter(name = ApiConstants.FOR_VPC, type = CommandType.BOOLEAN, description = "if true is passed for this parameter, list only VPC Internal LB VMs")
+ @Parameter(name = ApiConstants.FOR_VPC, type = CommandType.BOOLEAN, description = "If true is passed for this parameter, list only VPC Internal LB Instances")
private Boolean forVpc;
@Parameter(name = ApiConstants.FETCH_ROUTER_HEALTH_CHECK_RESULTS, type = CommandType.BOOLEAN, since = "4.14",
- description = "if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false")
+ description = "If true is passed for this parameter, also fetch last executed health check results for the Instance. Default is false")
private Boolean fetchHealthCheckResults;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/ListInternalLoadBalancerElementsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/ListInternalLoadBalancerElementsCmd.java
index b17cc22e746..9cd7ba2656b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/ListInternalLoadBalancerElementsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/ListInternalLoadBalancerElementsCmd.java
@@ -50,16 +50,16 @@ public class ListInternalLoadBalancerElementsCmd extends BaseListCmd {
@Parameter(name = ApiConstants.ID,
type = CommandType.UUID,
entityType = InternalLoadBalancerElementResponse.class,
- description = "list internal load balancer elements by id")
+ description = "List internal load balancer elements by ID")
private Long id;
@Parameter(name = ApiConstants.NSP_ID,
type = CommandType.UUID,
entityType = ProviderResponse.class,
- description = "list internal load balancer elements by network service provider id")
+ description = "List internal load balancer elements by network service provider ID")
private Long nspId;
- @Parameter(name = ApiConstants.ENABLED, type = CommandType.BOOLEAN, description = "list internal load balancer elements by enabled state")
+ @Parameter(name = ApiConstants.ENABLED, type = CommandType.BOOLEAN, description = "List internal load balancer elements by enabled state")
private Boolean enabled;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/StartInternalLBVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/StartInternalLBVMCmd.java
index 3dd7d2adf37..b5aa3c8d9b0 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/StartInternalLBVMCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/internallb/StartInternalLBVMCmd.java
@@ -38,7 +38,7 @@ import com.cloud.network.router.VirtualRouter;
import com.cloud.network.router.VirtualRouter.Role;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "startInternalLoadBalancerVM", responseObject = DomainRouterResponse.class, description = "Starts an existing internal lb vm.", entityType = {VirtualMachine.class},
+@APICommand(name = "startInternalLoadBalancerVM", responseObject = DomainRouterResponse.class, description = "Starts an existing Internal LB Instance.", entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class StartInternalLBVMCmd extends BaseAsyncCmd {
private static final String s_name = "startinternallbvmresponse";
@@ -47,7 +47,7 @@ public class StartInternalLBVMCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = DomainRouterResponse.class, required = true, description = "the ID of the internal lb vm")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = DomainRouterResponse.class, required = true, description = "The ID of the Internal LB Instance")
private Long id;
/////////////////////////////////////////////////////
@@ -77,7 +77,7 @@ public class StartInternalLBVMCmd extends BaseAsyncCmd {
if (router != null && router.getRole() == Role.INTERNAL_LB_VM) {
return router.getAccountId();
} else {
- throw new InvalidParameterValueException("Unable to find internal lb vm by id");
+ throw new InvalidParameterValueException("Unable to find Internal LB Instance by ID");
}
}
@@ -88,7 +88,7 @@ public class StartInternalLBVMCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "starting internal lb vm: " + getId();
+ return "starting Internal LB Instance: " + getId();
}
@Override
@@ -103,11 +103,11 @@ public class StartInternalLBVMCmd extends BaseAsyncCmd {
@Override
public void execute() throws ConcurrentOperationException, ResourceUnavailableException, InsufficientCapacityException {
- CallContext.current().setEventDetails("Internal Lb Vm Id: " + getId());
+ CallContext.current().setEventDetails("Internal LB Instance ID: " + getId());
VirtualRouter result = null;
VirtualRouter router = _routerService.findRouter(getId());
if (router == null || router.getRole() != Role.INTERNAL_LB_VM) {
- throw new InvalidParameterValueException("Can't find internal lb vm by id");
+ throw new InvalidParameterValueException("Can't find Internal LB Instance by ID");
} else {
result = _internalLbSvc.startInternalLbVm(getId(), CallContext.current().getCallingAccount(), CallContext.current().getCallingUserId());
}
@@ -117,7 +117,7 @@ public class StartInternalLBVMCmd extends BaseAsyncCmd {
routerResponse.setResponseName(getCommandName());
setResponseObject(routerResponse);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to start internal lb vm");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to start Internal LB Instance");
}
}
}
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 a746e5d906d..82eddb27c7d 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
@@ -37,7 +37,7 @@ import com.cloud.network.router.VirtualRouter;
import com.cloud.network.router.VirtualRouter.Role;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "stopInternalLoadBalancerVM", description = "Stops an Internal LB vm.", responseObject = DomainRouterResponse.class, entityType = {VirtualMachine.class},
+@APICommand(name = "stopInternalLoadBalancerVM", description = "Stops an Internal LB Instance.", responseObject = DomainRouterResponse.class, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class StopInternalLBVMCmd extends BaseAsyncCmd {
private static final String s_name = "stopinternallbvmresponse";
@@ -46,10 +46,10 @@ public class StopInternalLBVMCmd extends BaseAsyncCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = DomainRouterResponse.class, required = true, description = "the ID of the internal lb vm")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = DomainRouterResponse.class, required = true, description = "The ID of the internal LB Instance")
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). To be used if the caller knows the VM is stopped and should be marked as such.")
+ @Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN, required = false, description = "Force stop the Instance (Instance 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 Instance is stopped and should be marked as such.")
private Boolean forced;
// ///////////////////////////////////////////////////
@@ -75,7 +75,7 @@ public class StopInternalLBVMCmd extends BaseAsyncCmd {
if (vm != null && vm.getRole() == Role.INTERNAL_LB_VM) {
return vm.getAccountId();
} else {
- throw new InvalidParameterValueException("Unable to find internal lb vm by id");
+ throw new InvalidParameterValueException("Unable to find Internal LB Instance by ID");
}
}
@@ -86,7 +86,7 @@ public class StopInternalLBVMCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "stopping internal lb vm: " + getId();
+ return "Stopping Internal LB Instance: " + getId();
}
@Override
@@ -105,11 +105,11 @@ public class StopInternalLBVMCmd extends BaseAsyncCmd {
@Override
public void execute() throws ConcurrentOperationException, ResourceUnavailableException {
- CallContext.current().setEventDetails("Internal lb vm Id: " + getId());
+ CallContext.current().setEventDetails("Internal LB Instance Id: " + getId());
VirtualRouter result = null;
VirtualRouter vm = _routerService.findRouter(getId());
if (vm == null || vm.getRole() != Role.INTERNAL_LB_VM) {
- throw new InvalidParameterValueException("Can't find internal lb vm by id");
+ throw new InvalidParameterValueException("Can't find Internal LB Instance by ID");
} else {
result = _internalLbSvc.stopInternalLbVm(getId(), isForced(), CallContext.current().getCallingAccount(), CallContext.current().getCallingUserId());
}
@@ -119,7 +119,7 @@ public class StopInternalLBVMCmd extends BaseAsyncCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to stop internal lb vm");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to stop Internal LB Instance");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/iso/AttachIsoCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/iso/AttachIsoCmdByAdmin.java
index e39107b2593..d253580f098 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/iso/AttachIsoCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/iso/AttachIsoCmdByAdmin.java
@@ -22,6 +22,6 @@ import org.apache.cloudstack.api.command.admin.AdminCmd;
import org.apache.cloudstack.api.command.user.iso.AttachIsoCmd;
import org.apache.cloudstack.api.response.UserVmResponse;
-@APICommand(name = "attachIso", description = "Attaches an ISO to a virtual machine.", responseObject = UserVmResponse.class, responseView = ResponseView.Full,
+@APICommand(name = "attachIso", description = "Attaches an ISO to an Instance.", responseObject = UserVmResponse.class, responseView = ResponseView.Full,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class AttachIsoCmdByAdmin extends AttachIsoCmd implements AdminCmd { }
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/iso/CopyIsoCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/iso/CopyIsoCmdByAdmin.java
index f27c0c5c234..f64326638a3 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/iso/CopyIsoCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/iso/CopyIsoCmdByAdmin.java
@@ -21,7 +21,7 @@ import org.apache.cloudstack.api.ResponseObject.ResponseView;
import org.apache.cloudstack.api.command.user.iso.CopyIsoCmd;
import org.apache.cloudstack.api.response.TemplateResponse;
-@APICommand(name = "copyIso", description = "Copies an iso from one zone to another.", responseObject = TemplateResponse.class, responseView = ResponseView.Full,
+@APICommand(name = "copyIso", description = "Copies an ISO from one zone to another.", responseObject = TemplateResponse.class, responseView = ResponseView.Full,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class CopyIsoCmdByAdmin extends CopyIsoCmd {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/iso/DetachIsoCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/iso/DetachIsoCmdByAdmin.java
index 5eeba2bfa30..553d0ae13c6 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/iso/DetachIsoCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/iso/DetachIsoCmdByAdmin.java
@@ -22,6 +22,6 @@ import org.apache.cloudstack.api.command.admin.AdminCmd;
import org.apache.cloudstack.api.command.user.iso.DetachIsoCmd;
import org.apache.cloudstack.api.response.UserVmResponse;
-@APICommand(name = "detachIso", description = "Detaches any ISO file (if any) currently attached to a virtual machine.", responseObject = UserVmResponse.class, responseView = ResponseView.Full,
+@APICommand(name = "detachIso", description = "Detaches any ISO file (if any) currently attached to an Instance.", responseObject = UserVmResponse.class, responseView = ResponseView.Full,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class DetachIsoCmdByAdmin extends DetachIsoCmd implements AdminCmd {}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/iso/ListIsoPermissionsCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/iso/ListIsoPermissionsCmdByAdmin.java
index 46bd4f3766e..c4b9db3b7c3 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/iso/ListIsoPermissionsCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/iso/ListIsoPermissionsCmdByAdmin.java
@@ -23,7 +23,7 @@ import org.apache.cloudstack.api.command.user.iso.ListIsoPermissionsCmd;
import org.apache.cloudstack.api.response.TemplatePermissionsResponse;
@APICommand(name = "listIsoPermissions",
- description = "List iso visibility and all accounts that have permissions to view this iso.",
+ description = "List ISO visibility and all accounts that have permissions to view this ISO.",
responseObject = TemplatePermissionsResponse.class,
responseView = ResponseView.Full,
requestHasSensitiveInfo = false,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/loadbalancer/ListLoadBalancerRuleInstancesCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/loadbalancer/ListLoadBalancerRuleInstancesCmdByAdmin.java
index b11988b241f..a37e058924f 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/loadbalancer/ListLoadBalancerRuleInstancesCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/loadbalancer/ListLoadBalancerRuleInstancesCmdByAdmin.java
@@ -23,7 +23,7 @@ import org.apache.cloudstack.api.APICommand;
import org.apache.cloudstack.api.ResponseObject.ResponseView;
import org.apache.cloudstack.api.command.user.loadbalancer.ListLoadBalancerRuleInstancesCmd;
-@APICommand(name = "listLoadBalancerRuleInstances", description = "List all virtual machine instances that are assigned to a load balancer rule.", responseObject = LoadBalancerRuleVmMapResponse.class, responseView = ResponseView.Full,
+@APICommand(name = "listLoadBalancerRuleInstances", description = "List all Instances that are assigned to a load balancer rule.", responseObject = LoadBalancerRuleVmMapResponse.class, responseView = ResponseView.Full,
requestHasSensitiveInfo = false,
responseHasSensitiveInfo = true)
public class ListLoadBalancerRuleInstancesCmdByAdmin extends ListLoadBalancerRuleInstancesCmd implements AdminCmd {}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/management/ListMgmtsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/management/ListMgmtsCmd.java
index 7b7eae1d0e9..ecc59f7cab8 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/management/ListMgmtsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/management/ListMgmtsCmd.java
@@ -34,10 +34,10 @@ public class ListMgmtsCmd extends BaseListCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ManagementServerResponse.class, description = "the id of the management server")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ManagementServerResponse.class, description = "The ID of the management server")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the management server")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the management server")
private String hostName;
@Parameter(name = ApiConstants.PEERS, type = CommandType.BOOLEAN,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/AddNetworkDeviceCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/AddNetworkDeviceCmd.java
index 33477297043..e90a56a92ab 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/AddNetworkDeviceCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/AddNetworkDeviceCmd.java
@@ -55,7 +55,7 @@ public class AddNetworkDeviceCmd extends BaseCmd {
description = "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall")
private String type;
- @Parameter(name = ApiConstants.NETWORK_DEVICE_PARAMETER_LIST, type = CommandType.MAP, description = "parameters for network device")
+ @Parameter(name = ApiConstants.NETWORK_DEVICE_PARAMETER_LIST, type = CommandType.MAP, description = "Parameters for network device")
private Map paramList;
public String getDeviceType() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/AddNetworkServiceProviderCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/AddNetworkServiceProviderCmd.java
index 40a82239345..a0013f9d6e2 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/AddNetworkServiceProviderCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/AddNetworkServiceProviderCmd.java
@@ -52,22 +52,22 @@ public class AddNetworkServiceProviderCmd extends BaseAsyncCreateCmd {
type = CommandType.UUID,
entityType = PhysicalNetworkResponse.class,
required = true,
- description = "the Physical Network ID to add the provider to")
+ description = "The Physical Network ID to add the provider to")
private Long physicalNetworkId;
@Parameter(name = ApiConstants.DEST_PHYSICAL_NETWORK_ID,
type = CommandType.UUID,
entityType = PhysicalNetworkResponse.class,
- description = "the destination Physical Network ID to bridge to")
+ description = "The destination Physical Network ID to bridge to")
private Long destinationPhysicalNetworkId;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "the name for the physical network service provider")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "The name for the physical network service provider")
private String name;
@Parameter(name = ApiConstants.SERVICE_LIST,
type = CommandType.LIST,
collectionType = CommandType.STRING,
- description = "the list of services to be enabled for this physical network service provider")
+ description = "The list of services to be enabled for this physical network service provider")
private List enabledServices;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreateManagementNetworkIpRangeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreateManagementNetworkIpRangeCmd.java
index 85cfddfb714..a7826e022a6 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreateManagementNetworkIpRangeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreateManagementNetworkIpRangeCmd.java
@@ -34,6 +34,7 @@ import com.cloud.exception.InsufficientCapacityException;
import com.cloud.exception.ResourceAllocationException;
import com.cloud.exception.ResourceUnavailableException;
import com.cloud.user.Account;
+import com.cloud.utils.StringUtils;
@APICommand(name = "createManagementNetworkIpRange",
description = "Creates a Management network IP range.",
@@ -118,7 +119,7 @@ public class CreateManagementNetworkIpRangeCmd extends BaseAsyncCmd {
}
public String getVlan() {
- if (vlan == null || vlan.isEmpty()) {
+ if (StringUtils.isBlank(vlan)) {
vlan = "untagged";
}
return vlan;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreateNetworkCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreateNetworkCmdByAdmin.java
index d8b57f79528..57d1d4fad11 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreateNetworkCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreateNetworkCmdByAdmin.java
@@ -31,24 +31,24 @@ import com.cloud.network.Network;
import java.util.List;
-@APICommand(name = "createNetwork", description = "Creates a network", responseObject = NetworkResponse.class, responseView = ResponseView.Full, entityType = {Network.class},
+@APICommand(name = "createNetwork", description = "Creates a Network", responseObject = NetworkResponse.class, responseView = ResponseView.Full, entityType = {Network.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class CreateNetworkCmdByAdmin extends CreateNetworkCmd implements AdminCmd {
- @Parameter(name=ApiConstants.VLAN, type=CommandType.STRING, description="the ID or VID of the network")
+ @Parameter(name=ApiConstants.VLAN, type=CommandType.STRING, description = "The ID or VID of the network")
private String vlan;
- @Parameter(name=ApiConstants.BYPASS_VLAN_OVERLAP_CHECK, type=CommandType.BOOLEAN, description="when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks")
+ @Parameter(name=ApiConstants.BYPASS_VLAN_OVERLAP_CHECK, type=CommandType.BOOLEAN, description = "When true bypasses VLAN ID/range overlap check during Network creation for shared and L2 Networks")
private Boolean bypassVlanOverlapCheck;
- @Parameter(name=ApiConstants.HIDE_IP_ADDRESS_USAGE, type=CommandType.BOOLEAN, description="when true ip address usage for the network will not be exported by the listUsageRecords API")
+ @Parameter(name=ApiConstants.HIDE_IP_ADDRESS_USAGE, type=CommandType.BOOLEAN, description = "When true IP address usage for the Network will not be exported by the listUsageRecords API")
private Boolean hideIpAddressUsage;
- @Parameter(name = ApiConstants.ROUTER_IP, type = CommandType.STRING, description = "IPV4 address to be assigned to a router in a shared network", since = "4.16",
+ @Parameter(name = ApiConstants.ROUTER_IP, type = CommandType.STRING, description = "IPv4 address to be assigned to a router in a shared Network", since = "4.16",
validations = {ApiArgValidator.NotNullOrEmpty})
private String routerIp;
- @Parameter(name = ApiConstants.ROUTER_IPV6, type = CommandType.STRING, description = "IPV6 address to be assigned to a router in a shared network", since = "4.16",
+ @Parameter(name = ApiConstants.ROUTER_IPV6, type = CommandType.STRING, description = "IPv6 address to be assigned to a router in a shared Network", since = "4.16",
validations = {ApiArgValidator.NotNullOrEmpty})
private String routerIpv6;
@@ -56,7 +56,7 @@ public class CreateNetworkCmdByAdmin extends CreateNetworkCmd implements AdminCm
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = BgpPeerResponse.class,
- description = "Ids of the Bgp Peer for the network",
+ description = "IDs of the Bgp Peer for the Network",
since = "4.20.0")
private List bgpPeerIds;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreateNetworkOfferingCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreateNetworkOfferingCmd.java
index af3db374a7c..c6a9a494f7c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreateNetworkOfferingCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreateNetworkOfferingCmd.java
@@ -68,76 +68,76 @@ public class CreateNetworkOfferingCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "the name of the network offering")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "The name of the network offering")
private String networkOfferingName;
- @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "the display text of the network offering, defaults to the value of 'name'.")
+ @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "The display text of the network offering, defaults to the value of 'name'.")
private String displayText;
@Parameter(name = ApiConstants.TRAFFIC_TYPE,
type = CommandType.STRING,
required = true,
- description = "the traffic type for the network offering. Supported type in current release is GUEST only")
+ description = "The traffic type for the network offering. Supported type in current release is GUEST only")
private String traffictype;
- @Parameter(name = ApiConstants.TAGS, type = CommandType.STRING, description = "the tags for the network offering.", length = 4096)
+ @Parameter(name = ApiConstants.TAGS, type = CommandType.STRING, description = "The tags for the network offering.", length = 4096)
private String tags;
- @Parameter(name = ApiConstants.SPECIFY_VLAN, type = CommandType.BOOLEAN, description = "true if network offering supports vlans")
+ @Parameter(name = ApiConstants.SPECIFY_VLAN, type = CommandType.BOOLEAN, description = "True if network offering supports VLANs")
private Boolean specifyVlan;
- @Parameter(name = ApiConstants.AVAILABILITY, type = CommandType.STRING, description = "the availability of network offering. The default value is Optional. "
+ @Parameter(name = ApiConstants.AVAILABILITY, type = CommandType.STRING, description = "The availability of network offering. The default value is Optional. "
+ " Another value is Required, which will make it as the default network offering for new networks ")
private String availability;
- @Parameter(name = ApiConstants.NETWORKRATE, type = CommandType.INTEGER, description = "data transfer rate in megabits per second allowed")
+ @Parameter(name = ApiConstants.NETWORKRATE, type = CommandType.INTEGER, description = "Data transfer rate in megabits per second allowed")
private Integer networkRate;
- @Parameter(name = ApiConstants.CONSERVE_MODE, type = CommandType.BOOLEAN, description = "true if the network offering is IP conserve mode enabled")
+ @Parameter(name = ApiConstants.CONSERVE_MODE, type = CommandType.BOOLEAN, description = "True if the network offering is IP conserve mode enabled")
private Boolean conserveMode;
@Parameter(name = ApiConstants.SERVICE_OFFERING_ID,
type = CommandType.UUID,
entityType = ServiceOfferingResponse.class,
- description = "the service offering ID used by virtual router provider")
+ description = "The service offering ID used by virtual router provider")
private Long serviceOfferingId;
- @Parameter(name = ApiConstants.GUEST_IP_TYPE, type = CommandType.STRING, required = true, description = "guest type of the network offering: Shared or Isolated")
+ @Parameter(name = ApiConstants.GUEST_IP_TYPE, type = CommandType.STRING, required = true, description = "Guest type of the network offering: Shared or Isolated")
private String guestIptype;
@Parameter(name = ApiConstants.INTERNET_PROTOCOL,
type = CommandType.STRING,
- description = "The internet protocol of network offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create a network offering that supports both IPv4 and IPv6",
+ description = "The internet protocol of network offering. Options are IPv4 and dualstack. Default is IPv4. dualstack will create a network offering that supports both IPv4 and IPv6",
since = "4.17.0")
private String internetProtocol;
@Parameter(name = ApiConstants.SUPPORTED_SERVICES,
type = CommandType.LIST,
collectionType = CommandType.STRING,
- description = "services supported by the network offering")
+ description = "Services supported by the network offering")
private List supportedServices;
@Parameter(name = ApiConstants.SERVICE_PROVIDER_LIST,
type = CommandType.MAP,
- description = "provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network")
+ description = "Provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network")
private Map serviceProviderList;
- @Parameter(name = ApiConstants.SERVICE_CAPABILITY_LIST, type = CommandType.MAP, description = "desired service capabilities as part of network offering")
+ @Parameter(name = ApiConstants.SERVICE_CAPABILITY_LIST, type = CommandType.MAP, description = "Desired service capabilities as part of network offering")
private Map serviceCapabilitystList;
@Parameter(name = ApiConstants.SPECIFY_IP_RANGES,
type = CommandType.BOOLEAN,
- description = "true if network offering supports specifying ip ranges; defaulted to false if not specified")
+ description = "True if network offering supports specifying ip ranges; defaulted to false if not specified")
private Boolean specifyIpRanges;
@Parameter(name = ApiConstants.IS_PERSISTENT,
type = CommandType.BOOLEAN,
- description = "true if network offering supports persistent networks; defaulted to false if not specified")
+ description = "True if network offering supports persistent networks; defaulted to false if not specified")
private Boolean isPersistent;
@Parameter(name = ApiConstants.FOR_VPC,
type = CommandType.BOOLEAN,
- description = "true if network offering is meant to be used for VPC, false otherwise.")
+ description = "True if network offering is meant to be used for VPC, false otherwise.")
private Boolean forVpc;
@Parameter(name = ApiConstants.FOR_NSX,
@@ -148,13 +148,13 @@ public class CreateNetworkOfferingCmd extends BaseCmd {
@Parameter(name = ApiConstants.NSX_SUPPORT_LB,
type = CommandType.BOOLEAN,
- description = "true if network offering for NSX network offering supports Load balancer service.",
+ description = "True if network offering for NSX network offering supports Load balancer service.",
since = "4.20.0")
private Boolean nsxSupportsLbService;
@Parameter(name = ApiConstants.NSX_SUPPORTS_INTERNAL_LB,
type = CommandType.BOOLEAN,
- description = "true if network offering for NSX network offering supports Internal Load balancer service.",
+ description = "True if network offering for NSX network offering supports Internal Load balancer service.",
since = "4.20.0")
private Boolean nsxSupportsInternalLbService;
@@ -166,7 +166,7 @@ public class CreateNetworkOfferingCmd extends BaseCmd {
@Parameter(name = ApiConstants.FOR_TUNGSTEN,
type = CommandType.BOOLEAN,
- description = "true if network offering is meant to be used for Tungsten-Fabric, false otherwise.")
+ description = "True if network offering is meant to be used for Tungsten-Fabric, false otherwise.")
private Boolean forTungsten;
@Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, since = "4.2.0", description = "Network offering details in key/value pairs."
@@ -176,38 +176,38 @@ public class CreateNetworkOfferingCmd extends BaseCmd {
@Parameter(name = ApiConstants.EGRESS_DEFAULT_POLICY,
type = CommandType.BOOLEAN,
- description = "true if guest network default egress policy is allow; false if default egress policy is deny")
+ description = "True if guest network default egress policy is allow; false if default egress policy is deny")
private Boolean egressDefaultPolicy;
@Parameter(name = ApiConstants.KEEPALIVE_ENABLED,
type = CommandType.BOOLEAN,
required = false,
- description = "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.")
+ description = "If true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.")
private Boolean keepAliveEnabled;
@Parameter(name = ApiConstants.MAX_CONNECTIONS,
type = CommandType.INTEGER,
- description = "maximum number of concurrent connections supported by the network offering")
+ description = "Maximum number of concurrent connections supported by the Network offering")
private Integer maxConnections;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = DomainResponse.class,
- description = "the ID of the containing domain(s), null for public offerings")
+ description = "The ID of the containing domain(s), null for public offerings")
private List domainIds;
@Parameter(name = ApiConstants.ZONE_ID,
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = ZoneResponse.class,
- description = "the ID of the containing zone(s), null for public offerings",
+ description = "The ID of the containing zone(s), null for public offerings",
since = "4.13")
private List zoneIds;
@Parameter(name = ApiConstants.ENABLE,
type = CommandType.BOOLEAN,
- description = "set to true if the offering is to be enabled during creation. Default is false",
+ description = "Set to true if the offering is to be enabled during creation. Default is false",
since = "4.16")
private Boolean enable;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreatePhysicalNetworkCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreatePhysicalNetworkCmd.java
index 7eb52b92456..f4ce9483bfb 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreatePhysicalNetworkCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreatePhysicalNetworkCmd.java
@@ -36,7 +36,7 @@ import com.cloud.exception.ResourceAllocationException;
import com.cloud.network.PhysicalNetwork;
import com.cloud.user.Account;
-@APICommand(name = "createPhysicalNetwork", description = "Creates a physical network", responseObject = PhysicalNetworkResponse.class, since = "3.0.0",
+@APICommand(name = "createPhysicalNetwork", description = "Creates a physical Network", responseObject = PhysicalNetworkResponse.class, since = "3.0.0",
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class CreatePhysicalNetworkCmd extends BaseAsyncCreateCmd {
@@ -49,36 +49,36 @@ public class CreatePhysicalNetworkCmd extends BaseAsyncCreateCmd {
type = CommandType.UUID,
entityType = ZoneResponse.class,
required = true,
- description = "the Zone ID for the physical network")
+ description = "The Zone ID for the physical Network")
private Long zoneId;
- @Parameter(name = ApiConstants.VLAN, type = CommandType.STRING, description = "the VLAN for the physical network")
+ @Parameter(name = ApiConstants.VLAN, type = CommandType.STRING, description = "The VLAN for the physical Network")
private String vlan;
- @Parameter(name = ApiConstants.NETWORK_SPEED, type = CommandType.STRING, description = "the speed for the physical network[1G/10G]")
+ @Parameter(name = ApiConstants.NETWORK_SPEED, type = CommandType.STRING, description = "The speed for the physical Network[1G/10G]")
private String speed;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "domain ID of the account owning a physical network")
+ description = "Domain ID of the Account owning a physical Network")
private Long domainId;
@Parameter(name = ApiConstants.BROADCAST_DOMAIN_RANGE,
type = CommandType.STRING,
- description = "the broadcast domain range for the physical network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic")
+ description = "The broadcast domain range for the physical Network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic")
private String broadcastDomainRange;
- @Parameter(name = ApiConstants.TAGS, type = CommandType.LIST, collectionType = CommandType.STRING, description = "Tag the physical network")
+ @Parameter(name = ApiConstants.TAGS, type = CommandType.LIST, collectionType = CommandType.STRING, description = "Tag the physical Network")
private List tags;
@Parameter(name = ApiConstants.ISOLATION_METHODS,
type = CommandType.LIST,
collectionType = CommandType.STRING,
- description = "the isolation method for the physical network[VLAN/L3/GRE]")
+ description = "The isolation method for the physical Network[VLAN/L3/GRE]")
private List isolationMethods;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "the name of the physical network")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "The name of the physical Network")
private String networkName;
/////////////////////////////////////////////////////
@@ -139,7 +139,7 @@ public class CreatePhysicalNetworkCmd extends BaseAsyncCreateCmd {
@Override
public String getEventDescription() {
- return "creating Physical Network. Id: " + getEntityId();
+ return "Creating Physical Network. ID: " + getEntityId();
}
/////////////////////////////////////////////////////
@@ -148,14 +148,14 @@ public class CreatePhysicalNetworkCmd extends BaseAsyncCreateCmd {
@Override
public void execute() {
- CallContext.current().setEventDetails("Physical Network Id: " + getEntityId());
+ CallContext.current().setEventDetails("Physical Network ID: " + getEntityId());
PhysicalNetwork result = _networkService.getCreatedPhysicalNetwork(getEntityId());
if (result != null) {
PhysicalNetworkResponse response = _responseGenerator.createPhysicalNetworkResponse(result);
response.setResponseName(getCommandName());
this.setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create physical network");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create physical Network");
}
}
@@ -168,7 +168,7 @@ public class CreatePhysicalNetworkCmd extends BaseAsyncCreateCmd {
setEntityId(result.getId());
setEntityUuid(result.getUuid());
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create physical network entity");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create physical Network entity");
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreateStorageNetworkIpRangeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreateStorageNetworkIpRangeCmd.java
index 42262cc2bf1..439edcbf8f9 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreateStorageNetworkIpRangeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/CreateStorageNetworkIpRangeCmd.java
@@ -50,24 +50,24 @@ public class CreateStorageNetworkIpRangeCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = PodResponse.class,
required = true,
- description = "UUID of pod where the ip range belongs to")
+ description = "ID of pod where the IP range belongs to")
private Long podId;
- @Parameter(name = ApiConstants.START_IP, type = CommandType.STRING, required = true, description = "the beginning IP address")
+ @Parameter(name = ApiConstants.START_IP, type = CommandType.STRING, required = true, description = "The starting IP address")
private String startIp;
- @Parameter(name = ApiConstants.END_IP, type = CommandType.STRING, description = "the ending IP address")
+ @Parameter(name = ApiConstants.END_IP, type = CommandType.STRING, description = "The ending IP address")
private String endIp;
@Parameter(name = ApiConstants.VLAN,
type = CommandType.INTEGER,
- description = "Optional. The vlan the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly retrieve bridge from physical network traffic type table")
+ description = "Optional. The VLAN the IP range sits on, default to Null when it is not specified which means your network is not on any VLAN. This is mainly for VMware as other hypervisors can directly retrieve bridge from physical network traffic type table")
private Integer vlan;
- @Parameter(name = ApiConstants.NETMASK, type = CommandType.STRING, required = true, description = "the netmask for storage network")
+ @Parameter(name = ApiConstants.NETMASK, type = CommandType.STRING, required = true, description = "The netmask for storage network")
private String netmask;
- @Parameter(name = ApiConstants.GATEWAY, type = CommandType.STRING, required = true, description = "the gateway for storage network")
+ @Parameter(name = ApiConstants.GATEWAY, type = CommandType.STRING, required = true, description = "The gateway for storage network")
private String gateway;
/////////////////////////////////////////////////////
@@ -105,7 +105,7 @@ public class CreateStorageNetworkIpRangeCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "Creating storage ip range from " + getStartIp() + " to " + getEndIp() + " with vlan " + getVlan();
+ return "Creating storage IP range from " + getStartIp() + " to " + getEndIp() + " with VLAN " + getVlan();
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/DedicateGuestVlanRangeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/DedicateGuestVlanRangeCmd.java
index 355f738679e..dcc1fa51dce 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/DedicateGuestVlanRangeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/DedicateGuestVlanRangeCmd.java
@@ -44,23 +44,23 @@ public class DedicateGuestVlanRangeCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.VLAN_RANGE, type = CommandType.STRING, required = true, description = "guest vlan range to be dedicated")
+ @Parameter(name = ApiConstants.VLAN_RANGE, type = CommandType.STRING, required = true, description = "Guest VLAN range to be dedicated")
private String vlan;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "account who will own the VLAN")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "Account who will own the VLAN")
private String accountName;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "project who will own the VLAN")
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "Project who will own the VLAN")
private Long projectId;
- @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "domain ID of the account owning a VLAN")
+ @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "Domain ID of the Account owning a VLAN")
private Long domainId;
@Parameter(name = ApiConstants.PHYSICAL_NETWORK_ID,
type = CommandType.UUID,
entityType = PhysicalNetworkResponse.class,
required = true,
- description = "physical network ID of the vlan")
+ description = "Physical Network ID of the VLAN")
private Long physicalNetworkId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/DeleteNetworkOfferingCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/DeleteNetworkOfferingCmd.java
index e0598b71ea1..a24fc0dc371 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/DeleteNetworkOfferingCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/DeleteNetworkOfferingCmd.java
@@ -40,7 +40,7 @@ public class DeleteNetworkOfferingCmd extends BaseCmd {
type = CommandType.UUID,
entityType = NetworkOfferingResponse.class,
required = true,
- description = "the ID of the network offering")
+ description = "The ID of the network offering")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/DeleteNetworkServiceProviderCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/DeleteNetworkServiceProviderCmd.java
index 4b56612fdda..23d14966c49 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/DeleteNetworkServiceProviderCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/DeleteNetworkServiceProviderCmd.java
@@ -45,7 +45,7 @@ public class DeleteNetworkServiceProviderCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = ProviderResponse.class,
required = true,
- description = "the ID of the network service provider")
+ description = "The ID of the network service provider")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/DeletePhysicalNetworkCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/DeletePhysicalNetworkCmd.java
index 3233130211c..70c35716b65 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/DeletePhysicalNetworkCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/DeletePhysicalNetworkCmd.java
@@ -43,7 +43,7 @@ public class DeletePhysicalNetworkCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = PhysicalNetworkResponse.class,
required = true,
- description = "the ID of the Physical network")
+ description = "The ID of the Physical network")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/DeleteStorageNetworkIpRangeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/DeleteStorageNetworkIpRangeCmd.java
index 454dfba92f2..d12135cc60c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/DeleteStorageNetworkIpRangeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/DeleteStorageNetworkIpRangeCmd.java
@@ -46,7 +46,7 @@ public class DeleteStorageNetworkIpRangeCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = StorageNetworkIpRangeResponse.class,
required = true,
- description = "the uuid of the storage network ip range")
+ description = "The UUID of the storage network IP range")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListDedicatedGuestVlanRangesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListDedicatedGuestVlanRangesCmd.java
index 0247a306921..a5edbfdce4a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListDedicatedGuestVlanRangesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListDedicatedGuestVlanRangesCmd.java
@@ -44,33 +44,33 @@ public class ListDedicatedGuestVlanRangesCmd extends BaseListCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = GuestVlanRangeResponse.class, description = "list dedicated guest vlan ranges by id")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = GuestVlanRangeResponse.class, description = "List dedicated guest VLAN ranges by ID")
private Long id;
@Parameter(name = ApiConstants.ACCOUNT,
type = CommandType.STRING,
- description = "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.")
+ description = "The account with which the guest VLAN range is associated. Must be used with the domainId parameter.")
private String accountName;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "project who will own the guest VLAN range")
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "Project who will own the guest VLAN range")
private Long projectId;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "the domain ID with which the guest VLAN range is associated. If used with the account parameter, returns all guest VLAN ranges for that account in the specified domain.")
+ description = "The domain ID with which the guest VLAN range is associated. If used with the account parameter, returns all guest VLAN ranges for that account in the specified domain.")
private Long domainId;
- @Parameter(name = ApiConstants.GUEST_VLAN_RANGE, type = CommandType.STRING, description = "the dedicated guest vlan range")
+ @Parameter(name = ApiConstants.GUEST_VLAN_RANGE, type = CommandType.STRING, description = "The dedicated guest vlan range")
private String guestVlanRange;
@Parameter(name = ApiConstants.PHYSICAL_NETWORK_ID,
type = CommandType.UUID,
entityType = PhysicalNetworkResponse.class,
- description = "physical network id of the guest VLAN range")
+ description = "Physical network ID of the guest VLAN range")
private Long physicalNetworkId;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "zone of the guest VLAN range")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "Zone of the guest VLAN range")
private Long zoneId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListGuestVlansCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListGuestVlansCmd.java
index 4b368f5e034..80c9540a848 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListGuestVlansCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListGuestVlansCmd.java
@@ -44,19 +44,19 @@ public class ListGuestVlansCmd extends BaseListCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.LONG, required = false, description = "list guest vlan by id")
+ @Parameter(name = ApiConstants.ID, type = CommandType.LONG, required = false, description = "List guest VLAN by ID")
private Long id;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, required = false, description = "list guest vlan by zone")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, required = false, description = "List guest VLAN by zone")
private Long zoneId;
- @Parameter(name = ApiConstants.PHYSICAL_NETWORK_ID, type = CommandType.UUID, entityType = PhysicalNetworkResponse.class, required = false, description = "list guest vlan by physical network")
+ @Parameter(name = ApiConstants.PHYSICAL_NETWORK_ID, type = CommandType.UUID, entityType = PhysicalNetworkResponse.class, required = false, description = "List guest VLAN by physical network")
private Long physicalNetworkId;
- @Parameter(name = ApiConstants.VNET, type = CommandType.STRING, required = false, description = "list guest vlan by vnet")
+ @Parameter(name = ApiConstants.VNET, type = CommandType.STRING, required = false, description = "List guest VLAN by vnet")
private String vnet;
- @Parameter(name = ApiConstants.ALLOCATED_ONLY, type = CommandType.BOOLEAN, required = false, description = "limits search results to allocated guest vlan. false by default.")
+ @Parameter(name = ApiConstants.ALLOCATED_ONLY, type = CommandType.BOOLEAN, required = false, description = "Limits search results to allocated guest VLAN. False by default.")
private Boolean allocatedOnly;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListNetworkDeviceCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListNetworkDeviceCmd.java
index 768bab64108..ace635376eb 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListNetworkDeviceCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListNetworkDeviceCmd.java
@@ -57,7 +57,7 @@ public class ListNetworkDeviceCmd extends BaseListCmd {
description = "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall")
private String type;
- @Parameter(name = ApiConstants.NETWORK_DEVICE_PARAMETER_LIST, type = CommandType.MAP, description = "parameters for network device")
+ @Parameter(name = ApiConstants.NETWORK_DEVICE_PARAMETER_LIST, type = CommandType.MAP, description = "Parameters for network device")
private Map paramList;
public String getDeviceType() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListNetworkServiceProvidersCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListNetworkServiceProvidersCmd.java
index 68495a62215..95071e41f6c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListNetworkServiceProvidersCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListNetworkServiceProvidersCmd.java
@@ -44,13 +44,13 @@ public class ListNetworkServiceProvidersCmd extends BaseListCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.PHYSICAL_NETWORK_ID, type = CommandType.UUID, entityType = PhysicalNetworkResponse.class, description = "the Physical Network ID")
+ @Parameter(name = ApiConstants.PHYSICAL_NETWORK_ID, type = CommandType.UUID, entityType = PhysicalNetworkResponse.class, description = "The Physical Network ID")
private Long physicalNetworkId;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "list providers by name")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "List providers by name")
private String name;
- @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "list providers by state")
+ @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "List providers by state")
private String state;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListNetworksCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListNetworksCmdByAdmin.java
index 8df1133d5e7..bb564f1c3de 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListNetworksCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListNetworksCmdByAdmin.java
@@ -30,7 +30,7 @@ import com.cloud.network.Network;
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListNetworksCmdByAdmin extends ListNetworksCmd implements AdminCmd {
- @Parameter(name= ApiConstants.VLAN, type=CommandType.STRING, description="the ID or VID of the network", since = "4.17.0")
+ @Parameter(name= ApiConstants.VLAN, type=CommandType.STRING, description = "The ID or VID of the network", since = "4.17.0")
private String vlan;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListPhysicalNetworksCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListPhysicalNetworksCmd.java
index 51a6ddabd9f..27319ff3d67 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListPhysicalNetworksCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListPhysicalNetworksCmd.java
@@ -43,13 +43,13 @@ public class ListPhysicalNetworksCmd extends BaseListCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = PhysicalNetworkResponse.class, description = "list physical network by id")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = PhysicalNetworkResponse.class, description = "List physical network by id")
private Long id;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "the Zone ID for the physical network")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "The Zone ID for the physical network")
private Long zoneId;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "search by name")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "Search by name")
private String networkName;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListStorageNetworkIpRangeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListStorageNetworkIpRangeCmd.java
index 556162ca360..c269be93373 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListStorageNetworkIpRangeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListStorageNetworkIpRangeCmd.java
@@ -51,19 +51,19 @@ public class ListStorageNetworkIpRangeCmd extends BaseListCmd {
@Parameter(name = ApiConstants.ID,
type = CommandType.UUID,
entityType = StorageNetworkIpRangeResponse.class,
- description = "optional parameter. Storaget network IP range uuid, if specicied, using it to search the range.")
+ description = "Optional parameter. Storage network IP range UUID, if specified, using it to search the range.")
private Long rangeId;
@Parameter(name = ApiConstants.POD_ID,
type = CommandType.UUID,
entityType = PodResponse.class,
- description = "optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.")
+ description = "Optional parameter. Pod UUID, if specified and range UUID is absent, using it to search the range.")
private Long podId;
@Parameter(name = ApiConstants.ZONE_ID,
type = CommandType.UUID,
entityType = ZoneResponse.class,
- description = "optional parameter. Zone uuid, if specicied and both pod uuid and range uuid are absent, using it to search the range.")
+ description = "Optional parameter. Zone UUID, if specified and both pod UUID and range UUID are absent, using it to search the range.")
private Long zoneId;
/////////////////////////////////////////////////////
@@ -97,7 +97,7 @@ public class ListStorageNetworkIpRangeCmd extends BaseListCmd {
response.setResponseName(getCommandName());
this.setResponseObject(response);
} catch (Exception e) {
- logger.warn("Failed to list storage network ip range for rangeId=" + getRangeId() + " podId=" + getPodId() + " zoneId=" + getZoneId());
+ logger.warn("Failed to list storage Network IP range for rangeId=" + getRangeId() + " podId=" + getPodId() + " zoneId=" + getZoneId());
throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, e.getMessage());
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListSupportedNetworkServicesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListSupportedNetworkServicesCmd.java
index 120c6af41ad..227e9b68452 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListSupportedNetworkServicesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ListSupportedNetworkServicesCmd.java
@@ -40,10 +40,10 @@ import com.cloud.user.Account;
responseHasSensitiveInfo = false)
public class ListSupportedNetworkServicesCmd extends BaseListCmd {
- @Parameter(name = ApiConstants.PROVIDER, type = CommandType.STRING, description = "network service provider name")
+ @Parameter(name = ApiConstants.PROVIDER, type = CommandType.STRING, description = "Network service provider name")
private String providerName;
- @Parameter(name = ApiConstants.SERVICE, type = CommandType.STRING, description = "network service name to list providers and capabilities of")
+ @Parameter(name = ApiConstants.SERVICE, type = CommandType.STRING, description = "Network service name to list providers and capabilities of")
private String serviceName;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/MigrateNetworkCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/MigrateNetworkCmd.java
index 8ef853b99da..8ac9c8da691 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/MigrateNetworkCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/MigrateNetworkCmd.java
@@ -38,7 +38,7 @@ import com.cloud.offering.NetworkOffering;
import com.cloud.user.Account;
import com.cloud.user.User;
-@APICommand(name = "migrateNetwork", description = "moves a network to another physical network",
+@APICommand(name = "migrateNetwork", description = "Moves a network to another physical network",
responseObject = NetworkResponse.class,
responseView = ResponseView.Restricted,
entityType = {Network.class},
@@ -53,13 +53,13 @@ public class MigrateNetworkCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, required = true, description = "the ID of the network")
+ @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, required = true, description = "The ID of the network")
protected Long id;
- @Parameter(name = ApiConstants.NETWORK_OFFERING_ID, type = CommandType.UUID, entityType = NetworkOfferingResponse.class, required = true, description = "network offering ID")
+ @Parameter(name = ApiConstants.NETWORK_OFFERING_ID, type = CommandType.UUID, entityType = NetworkOfferingResponse.class, required = true, description = "Network offering ID")
private Long networkOfferingId;
- @Parameter(name = ApiConstants.RESUME, type = CommandType.BOOLEAN, description = "true if previous network migration cmd failed")
+ @Parameter(name = ApiConstants.RESUME, type = CommandType.BOOLEAN, description = "True if previous network migration cmd failed")
private Boolean resume;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/MigrateVPCCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/MigrateVPCCmd.java
index 3e0801be40b..edef1f846ed 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/MigrateVPCCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/MigrateVPCCmd.java
@@ -40,7 +40,7 @@ import com.cloud.user.Account;
import com.cloud.user.User;
@APICommand(name = "migrateVPC",
- description = "moves a vpc to another physical network",
+ description = "Moves a VPC to another physical network",
responseObject = VpcResponse.class,
responseView = ResponseObject.ResponseView.Restricted,
entityType = {Vpc.class},
@@ -56,16 +56,16 @@ public class MigrateVPCCmd extends BaseAsyncCmd {
/////////////////////////////////////////////////////
@ACL(accessType = SecurityChecker.AccessType.OperateEntry)
@Parameter(name= ApiConstants.VPC_ID, type=CommandType.UUID, entityType = VpcResponse.class,
- required=true, description = "the ID of the vpc")
+ required=true, description = "The ID of the VPC ")
protected Long id;
- @Parameter(name = ApiConstants.VPC_OFF_ID, type = CommandType.UUID, entityType = VpcOfferingResponse.class, required=true, description = "vpc offering ID")
+ @Parameter(name = ApiConstants.VPC_OFF_ID, type = CommandType.UUID, entityType = VpcOfferingResponse.class, required=true, description = "VPC offering ID")
private Long vpcOfferingId;
- @Parameter(name = ApiConstants.TIER_NETWORK_OFFERINGS, type = CommandType.MAP, description = "network offering ids for each network in the vpc. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2")
+ @Parameter(name = ApiConstants.TIER_NETWORK_OFFERINGS, type = CommandType.MAP, description = "Network offering IDs for each network in the VPC. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2")
private Map> tierNetworkOfferings;
- @Parameter(name = ApiConstants.RESUME, type = CommandType.BOOLEAN, description = "true if previous network migration cmd failed")
+ @Parameter(name = ApiConstants.RESUME, type = CommandType.BOOLEAN, description = "True if previous network migration cmd failed")
private Boolean resume;
/////////////////////////////////////////////////////
@@ -115,12 +115,12 @@ public class MigrateVPCCmd extends BaseAsyncCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to migrate vpc");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to migrate VPC");
}
}
@Override
- public String getEventDescription() { return "Migrating vpc: " + getId() + " to new vpc offering (" + vpcOfferingId + ")"; }
+ public String getEventDescription() { return "Migrating VPC : " + getId() + " to new VPC offering (" + vpcOfferingId + ")"; }
@Override
public String getEventType() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ReleaseDedicatedGuestVlanRangeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ReleaseDedicatedGuestVlanRangeCmd.java
index b3125ec3668..632ff9c6ac7 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ReleaseDedicatedGuestVlanRangeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/ReleaseDedicatedGuestVlanRangeCmd.java
@@ -44,7 +44,7 @@ public class ReleaseDedicatedGuestVlanRangeCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = GuestVlanRangeResponse.class,
required = true,
- description = "the ID of the dedicated guest vlan range")
+ description = "The ID of the dedicated guest VLAN range")
private Long id;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/UpdateNetworkCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/UpdateNetworkCmdByAdmin.java
index b3088a48840..5879a998b36 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/UpdateNetworkCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/UpdateNetworkCmdByAdmin.java
@@ -29,7 +29,7 @@ import com.cloud.network.Network;
@APICommand(name = "updateNetwork", description = "Updates a network", responseObject = NetworkResponse.class, responseView = ResponseView.Full, entityType = {Network.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class UpdateNetworkCmdByAdmin extends UpdateNetworkCmd implements AdminCmd {
- @Parameter(name= ApiConstants.HIDE_IP_ADDRESS_USAGE, type=CommandType.BOOLEAN, description="when true ip address usage for the network will not be exported by the listUsageRecords API")
+ @Parameter(name= ApiConstants.HIDE_IP_ADDRESS_USAGE, type=CommandType.BOOLEAN, description = "When true IP address usage for the Network will not be exported by the listUsageRecords API")
private Boolean hideIpAddressUsage;
public Boolean getHideIpAddressUsage() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/UpdateNetworkOfferingCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/UpdateNetworkOfferingCmd.java
index 75fb45e1f11..9af10262b2d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/UpdateNetworkOfferingCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/UpdateNetworkOfferingCmd.java
@@ -43,47 +43,47 @@ public class UpdateNetworkOfferingCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = NetworkOfferingResponse.class, description = "the id of the network offering")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = NetworkOfferingResponse.class, description = "The ID of the network offering")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the network offering")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the network offering")
private String networkOfferingName;
- @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "the display text of the network offering")
+ @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "The display text of the network offering")
private String displayText;
- @Parameter(name = ApiConstants.AVAILABILITY, type = CommandType.STRING, description = "the availability of network offering."
+ @Parameter(name = ApiConstants.AVAILABILITY, type = CommandType.STRING, description = "The availability of network offering."
+ " The value is Required makes this network offering default for Guest Virtual Networks. Only one network offering can have the value Required ")
private String availability;
- @Parameter(name = ApiConstants.SORT_KEY, type = CommandType.INTEGER, description = "sort key of the network offering, integer")
+ @Parameter(name = ApiConstants.SORT_KEY, type = CommandType.INTEGER, description = "Sort key of the network offering, integer")
private Integer sortKey;
- @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "update state for the network offering")
+ @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "Update state for the network offering")
private String state;
@Parameter(name = ApiConstants.KEEPALIVE_ENABLED,
type = CommandType.BOOLEAN,
required = false,
- description = "if true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.")
+ description = "If true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.")
private Boolean keepAliveEnabled;
@Parameter(name = ApiConstants.MAX_CONNECTIONS,
type = CommandType.INTEGER,
- description = "maximum number of concurrent connections supported by the network offering")
+ description = "Maximum number of concurrent connections supported by the network offering")
private Integer maxConnections;
- @Parameter(name = ApiConstants.TAGS, type = CommandType.STRING, description = "the tags for the network offering.", length = 4096)
+ @Parameter(name = ApiConstants.TAGS, type = CommandType.STRING, description = "The tags for the network offering.", length = 4096)
private String tags;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.STRING,
- description = "the ID of the containing domain(s) as comma separated string, public for public offerings")
+ description = "The ID of the containing domain(s) as comma separated string, public for public offerings")
private String domainIds;
@Parameter(name = ApiConstants.ZONE_ID,
type = CommandType.STRING,
- description = "the ID of the containing zone(s) as comma separated string, all for all zones offerings",
+ description = "The ID of the containing zone(s) as comma separated string, all for all zones offerings",
since = "4.13",
length = 4096)
private String zoneIds;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/UpdateNetworkServiceProviderCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/UpdateNetworkServiceProviderCmd.java
index b4801d9368e..db57abad248 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/UpdateNetworkServiceProviderCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/UpdateNetworkServiceProviderCmd.java
@@ -47,13 +47,13 @@ public class UpdateNetworkServiceProviderCmd extends BaseAsyncCmd {
@Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "Enabled/Disabled/Shutdown the physical network service provider")
private String state;
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ProviderResponse.class, required = true, description = "network service provider id")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ProviderResponse.class, required = true, description = "Network service provider ID")
private Long id;
@Parameter(name = ApiConstants.SERVICE_LIST,
type = CommandType.LIST,
collectionType = CommandType.STRING,
- description = "the list of services to be enabled for this physical network service provider")
+ description = "The list of services to be enabled for this physical network service provider")
private List enabledServices;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/UpdatePhysicalNetworkCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/UpdatePhysicalNetworkCmd.java
index 162116470bd..a9ad46fdd78 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/UpdatePhysicalNetworkCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/UpdatePhysicalNetworkCmd.java
@@ -38,19 +38,19 @@ public class UpdatePhysicalNetworkCmd extends BaseAsyncCmd {
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = PhysicalNetworkResponse.class, required = true, description = "physical network id")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = PhysicalNetworkResponse.class, required = true, description = "Physical Network ID")
private Long id;
- @Parameter(name = ApiConstants.NETWORK_SPEED, type = CommandType.STRING, description = "the speed for the physical network[1G/10G]")
+ @Parameter(name = ApiConstants.NETWORK_SPEED, type = CommandType.STRING, description = "The speed for the physical Network[1G/10G]")
private String speed;
- @Parameter(name = ApiConstants.TAGS, type = CommandType.LIST, collectionType = CommandType.STRING, description = "Tag the physical network")
+ @Parameter(name = ApiConstants.TAGS, type = CommandType.LIST, collectionType = CommandType.STRING, description = "Tag the physical Network")
private List tags;
@Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "Enabled/Disabled")
private String state;
- @Parameter(name = ApiConstants.VLAN, type = CommandType.STRING, description = "the VLAN for the physical network")
+ @Parameter(name = ApiConstants.VLAN, type = CommandType.STRING, description = "The VLAN for the physical Network")
private String vlan;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/UpdateStorageNetworkIpRangeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/UpdateStorageNetworkIpRangeCmd.java
index 65e2437417d..a1f4d2ed100 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/network/UpdateStorageNetworkIpRangeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/network/UpdateStorageNetworkIpRangeCmd.java
@@ -51,16 +51,16 @@ public class UpdateStorageNetworkIpRangeCmd extends BaseAsyncCmd {
description = "UUID of storage network ip range")
private Long id;
- @Parameter(name = ApiConstants.START_IP, type = CommandType.STRING, description = "the beginning IP address")
+ @Parameter(name = ApiConstants.START_IP, type = CommandType.STRING, description = "The beginning IP address")
private String startIp;
- @Parameter(name = ApiConstants.END_IP, type = CommandType.STRING, description = "the ending IP address")
+ @Parameter(name = ApiConstants.END_IP, type = CommandType.STRING, description = "The ending IP address")
private String endIp;
@Parameter(name = ApiConstants.VLAN, type = CommandType.INTEGER, description = "Optional. the vlan the ip range sits on")
private Integer vlan;
- @Parameter(name = ApiConstants.NETMASK, type = CommandType.STRING, description = "the netmask for storage network")
+ @Parameter(name = ApiConstants.NETMASK, type = CommandType.STRING, description = "The netmask for storage network")
private String netmask;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/offering/CreateDiskOfferingCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/offering/CreateDiskOfferingCmd.java
index c46e4cd6b44..38ccee70b57 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/offering/CreateDiskOfferingCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/offering/CreateDiskOfferingCmd.java
@@ -52,106 +52,106 @@ public class CreateDiskOfferingCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.DISK_SIZE, type = CommandType.LONG, required = false, description = "size of the disk offering in GB (1GB = 1,073,741,824 bytes)")
+ @Parameter(name = ApiConstants.DISK_SIZE, type = CommandType.LONG, required = false, description = "Size of the disk offering in GB (1GB = 1,073,741,824 bytes)")
private Long diskSize;
@Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "An alternate display text of the disk offering, defaults to 'name'.", length = 4096)
private String displayText;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "name of the disk offering")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "Name of the disk offering")
private String offeringName;
- @Parameter(name = ApiConstants.TAGS, type = CommandType.STRING, description = "tags for the disk offering", length = 4096)
+ @Parameter(name = ApiConstants.TAGS, type = CommandType.STRING, description = "Tags for the disk offering", length = 4096)
private String tags;
- @Parameter(name = ApiConstants.CUSTOMIZED, type = CommandType.BOOLEAN, description = "whether disk offering size is custom or not")
+ @Parameter(name = ApiConstants.CUSTOMIZED, type = CommandType.BOOLEAN, description = "Whether disk offering size is custom or not")
private Boolean customized;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = DomainResponse.class,
- description = "the ID of the containing domain(s), null for public offerings")
+ description = "The ID of the containing domain(s), null for public offerings")
private List domainIds;
@Parameter(name = ApiConstants.ZONE_ID,
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = ZoneResponse.class,
- description = "the ID of the containing zone(s), null for public offerings",
+ description = "The ID of the containing zone(s), null for public offerings",
since = "4.13")
private List zoneIds;
- @Parameter(name = ApiConstants.STORAGE_TYPE, type = CommandType.STRING, description = "the storage type of the disk offering. Values are local and shared.")
+ @Parameter(name = ApiConstants.STORAGE_TYPE, type = CommandType.STRING, description = "The storage type of the disk offering. Values are local and shared.")
private String storageType = ServiceOffering.StorageType.shared.toString();
@Parameter(name = ApiConstants.PROVISIONINGTYPE,
type = CommandType.STRING,
- description = "provisioning type used to create volumes. Valid values are thin, sparse, fat.")
+ description = "Provisioning type used to create volumes. Valid values are thin, sparse, fat.")
private String provisioningType = ProvisioningType.THIN.toString();
@Parameter(name = ApiConstants.DISPLAY_OFFERING,
type = CommandType.BOOLEAN,
- description = "an optional field, whether to display the offering to the end user or not.")
+ description = "An optional field, whether to display the offering to the end user or not.")
private Boolean displayOffering;
- @Parameter(name = ApiConstants.BYTES_READ_RATE, type = CommandType.LONG, required = false, description = "bytes read rate of the disk offering")
+ @Parameter(name = ApiConstants.BYTES_READ_RATE, type = CommandType.LONG, required = false, description = "Bytes read rate of the disk offering")
private Long bytesReadRate;
- @Parameter(name = ApiConstants.BYTES_READ_RATE_MAX, type = CommandType.LONG, required = false, description = "burst bytes read rate of the disk offering")
+ @Parameter(name = ApiConstants.BYTES_READ_RATE_MAX, type = CommandType.LONG, required = false, description = "Burst bytes read rate of the disk offering")
private Long bytesReadRateMax;
- @Parameter(name = ApiConstants.BYTES_READ_RATE_MAX_LENGTH, type = CommandType.LONG, required = false, description = "length (in seconds) of the burst")
+ @Parameter(name = ApiConstants.BYTES_READ_RATE_MAX_LENGTH, type = CommandType.LONG, required = false, description = "Length (in seconds) of the burst")
private Long bytesReadRateMaxLength;
- @Parameter(name = ApiConstants.BYTES_WRITE_RATE, type = CommandType.LONG, required = false, description = "bytes write rate of the disk offering")
+ @Parameter(name = ApiConstants.BYTES_WRITE_RATE, type = CommandType.LONG, required = false, description = "Bytes write rate of the disk offering")
private Long bytesWriteRate;
- @Parameter(name = ApiConstants.BYTES_WRITE_RATE_MAX, type = CommandType.LONG, required = false, description = "burst bytes write rate of the disk offering")
+ @Parameter(name = ApiConstants.BYTES_WRITE_RATE_MAX, type = CommandType.LONG, required = false, description = "Burst bytes write rate of the disk offering")
private Long bytesWriteRateMax;
- @Parameter(name = ApiConstants.BYTES_WRITE_RATE_MAX_LENGTH, type = CommandType.LONG, required = false, description = "length (in seconds) of the burst")
+ @Parameter(name = ApiConstants.BYTES_WRITE_RATE_MAX_LENGTH, type = CommandType.LONG, required = false, description = "Length (in seconds) of the burst")
private Long bytesWriteRateMaxLength;
- @Parameter(name = ApiConstants.IOPS_READ_RATE, type = CommandType.LONG, required = false, description = "io requests read rate of the disk offering")
+ @Parameter(name = ApiConstants.IOPS_READ_RATE, type = CommandType.LONG, required = false, description = "I/O requests read rate of the disk offering")
private Long iopsReadRate;
- @Parameter(name = ApiConstants.IOPS_READ_RATE_MAX, type = CommandType.LONG, required = false, description = "burst requests read rate of the disk offering")
+ @Parameter(name = ApiConstants.IOPS_READ_RATE_MAX, type = CommandType.LONG, required = false, description = "Burst requests read rate of the disk offering")
private Long iopsReadRateMax;
- @Parameter(name = ApiConstants.IOPS_READ_RATE_MAX_LENGTH, type = CommandType.LONG, required = false, description = "length (in seconds) of the burst")
+ @Parameter(name = ApiConstants.IOPS_READ_RATE_MAX_LENGTH, type = CommandType.LONG, required = false, description = "Length (in seconds) of the burst")
private Long iopsReadRateMaxLength;
- @Parameter(name = ApiConstants.IOPS_WRITE_RATE, type = CommandType.LONG, required = false, description = "io requests write rate of the disk offering")
+ @Parameter(name = ApiConstants.IOPS_WRITE_RATE, type = CommandType.LONG, required = false, description = "I/O requests write rate of the disk offering")
private Long iopsWriteRate;
- @Parameter(name = ApiConstants.IOPS_WRITE_RATE_MAX, type = CommandType.LONG, required = false, description = "burst io requests write rate of the disk offering")
+ @Parameter(name = ApiConstants.IOPS_WRITE_RATE_MAX, type = CommandType.LONG, required = false, description = "Burst I/O requests write rate of the disk offering")
private Long iopsWriteRateMax;
- @Parameter(name = ApiConstants.IOPS_WRITE_RATE_MAX_LENGTH, type = CommandType.LONG, required = false, description = "length (in seconds) of the burst")
+ @Parameter(name = ApiConstants.IOPS_WRITE_RATE_MAX_LENGTH, type = CommandType.LONG, required = false, description = "Length (in seconds) of the burst")
private Long iopsWriteRateMaxLength;
- @Parameter(name = ApiConstants.CUSTOMIZED_IOPS, type = CommandType.BOOLEAN, required = false, description = "whether disk offering iops is custom or not")
+ @Parameter(name = ApiConstants.CUSTOMIZED_IOPS, type = CommandType.BOOLEAN, required = false, description = "Whether disk offering IOPS is custom or not")
private Boolean customizedIops;
- @Parameter(name = ApiConstants.MIN_IOPS, type = CommandType.LONG, required = false, description = "min iops of the disk offering")
+ @Parameter(name = ApiConstants.MIN_IOPS, type = CommandType.LONG, required = false, description = "Min IOPS of the disk offering")
private Long minIops;
- @Parameter(name = ApiConstants.MAX_IOPS, type = CommandType.LONG, required = false, description = "max iops of the disk offering")
+ @Parameter(name = ApiConstants.MAX_IOPS, type = CommandType.LONG, required = false, description = "Max IOPS of the disk offering")
private Long maxIops;
@Parameter(name = ApiConstants.HYPERVISOR_SNAPSHOT_RESERVE,
type = CommandType.INTEGER,
required = false,
- description = "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)")
+ description = "Hypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)")
private Integer hypervisorSnapshotReserve;
@Parameter(name = ApiConstants.CACHE_MODE,
type = CommandType.STRING,
required = false,
- description = "the cache mode to use for this disk offering. none, writeback or writethrough",
+ description = "The cache mode to use for this disk offering. none, writeback or writethrough",
since = "4.14")
private String cacheMode;
@@ -164,7 +164,7 @@ public class CreateDiskOfferingCmd extends BaseCmd {
@Parameter(name = ApiConstants.ENCRYPT, type = CommandType.BOOLEAN, required=false, description = "Volumes using this offering should be encrypted", since = "4.18")
private Boolean encrypt;
- @Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "details to specify disk offering parameters", since = "4.16")
+ @Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "Details to specify disk offering parameters", since = "4.16")
private Map details;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/offering/CreateServiceOfferingCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/offering/CreateServiceOfferingCmd.java
index 8f6d5413d72..0c6671caf02 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/offering/CreateServiceOfferingCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/offering/CreateServiceOfferingCmd.java
@@ -51,143 +51,143 @@ public class CreateServiceOfferingCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.CPU_NUMBER, type = CommandType.INTEGER, required = false, description = "the CPU number of the service offering")
+ @Parameter(name = ApiConstants.CPU_NUMBER, type = CommandType.INTEGER, required = false, description = "The CPU number of the service offering")
private Integer cpuNumber;
@Parameter(name = ApiConstants.CPU_SPEED, type = CommandType.INTEGER, required = false, description = "For VMware and Xen based hypervisors this is the CPU speed of the service offering in MHz.\n" +
"For the KVM hypervisor," +
" the values of the parameters cpuSpeed and cpuNumber will be used to calculate the `shares` value. This value is used by the KVM hypervisor to calculate how much time" +
- " the VM will have access to the host's CPU. The `shares` value does not have a unit, and its purpose is being a weight value for the host to compare between its guest" +
- " VMs. For more information, see https://libvirt.org/formatdomain.html#cpu-tuning.")
+ " the Instance will have access to the host's CPU. The `shares` value does not have a unit, and its purpose is being a weight value for the host to compare between its guest" +
+ " Instances. For more information, see https://libvirt.org/formatdomain.html#cpu-tuning.")
private Integer cpuSpeed;
@Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "The display text of the service offering, defaults to 'name'.")
private String displayText;
- @Parameter(name = ApiConstants.PROVISIONINGTYPE, type = CommandType.STRING, description = "provisioning type used to create volumes. Valid values are thin, sparse, fat.")
+ @Parameter(name = ApiConstants.PROVISIONINGTYPE, type = CommandType.STRING, description = "Provisioning type used to create volumes. Valid values are thin, sparse, fat.")
private String provisioningType = Storage.ProvisioningType.THIN.toString();
- @Parameter(name = ApiConstants.MEMORY, type = CommandType.INTEGER, required = false, description = "the total memory of the service offering in MB")
+ @Parameter(name = ApiConstants.MEMORY, type = CommandType.INTEGER, required = false, description = "The total memory of the service offering in MB")
private Integer memory;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "the name of the service offering")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "The name of the service offering")
private String serviceOfferingName;
- @Parameter(name = ApiConstants.OFFER_HA, type = CommandType.BOOLEAN, description = "the HA for the service offering")
+ @Parameter(name = ApiConstants.OFFER_HA, type = CommandType.BOOLEAN, description = "The HA for the service offering")
private Boolean offerHa;
- @Parameter(name = ApiConstants.LIMIT_CPU_USE, type = CommandType.BOOLEAN, description = "restrict the CPU usage to committed service offering")
+ @Parameter(name = ApiConstants.LIMIT_CPU_USE, type = CommandType.BOOLEAN, description = "Restrict the CPU usage to committed service offering")
private Boolean limitCpuUse;
@Parameter(name = ApiConstants.IS_VOLATILE,
type = CommandType.BOOLEAN,
- description = "true if the virtual machine needs to be volatile so that on every reboot of VM, original root disk is dettached then destroyed and a fresh root disk is created and attached to VM")
+ description = "True if the Instance needs to be volatile so that on every reboot, the original root disk is detached, then destroyed and a fresh root disk is created and attached to the Instance")
private Boolean isVolatile;
- @Parameter(name = ApiConstants.STORAGE_TYPE, type = CommandType.STRING, description = "the storage type of the service offering. Values are local and shared.")
+ @Parameter(name = ApiConstants.STORAGE_TYPE, type = CommandType.STRING, description = "The storage type of the service offering. Values are local and shared.")
private String storageType;
- @Parameter(name = ApiConstants.TAGS, type = CommandType.STRING, description = "the tags for this service offering.")
+ @Parameter(name = ApiConstants.TAGS, type = CommandType.STRING, description = "The tags for this service offering.")
private String tags;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = DomainResponse.class,
- description = "the ID of the containing domain(s), null for public offerings")
+ description = "The ID of the containing domain(s), null for public offerings")
private List domainIds;
@Parameter(name = ApiConstants.ZONE_ID,
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = ZoneResponse.class,
- description = "the ID of the containing zone(s), null for public offerings",
+ description = "The ID of the containing zone(s), null for public offerings",
since = "4.13")
private List zoneIds;
- @Parameter(name = ApiConstants.HOST_TAGS, type = CommandType.STRING, description = "the host tag for this service offering.")
+ @Parameter(name = ApiConstants.HOST_TAGS, type = CommandType.STRING, description = "The host tag for this service offering.")
private String hostTag;
- @Parameter(name = ApiConstants.IS_SYSTEM_OFFERING, type = CommandType.BOOLEAN, description = "is this a system vm offering")
+ @Parameter(name = ApiConstants.IS_SYSTEM_OFFERING, type = CommandType.BOOLEAN, description = "Is this a system vm offering")
private Boolean isSystem;
@Parameter(name = ApiConstants.SYSTEM_VM_TYPE,
type = CommandType.STRING,
- description = "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".")
+ description = "The system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".")
private String systemVmType;
@Parameter(name = ApiConstants.NETWORKRATE,
type = CommandType.INTEGER,
- description = "data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype")
+ description = "Data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype")
private Integer networkRate;
@Parameter(name = ApiConstants.DEPLOYMENT_PLANNER,
type = CommandType.STRING,
- description = "The deployment planner heuristics used to deploy a VM of this offering. If null, value of global config vm.deployment.planner is used")
+ description = "The deployment planner heuristics used to deploy an Instance of this offering. If null, value of global config vm.deployment.planner is used")
private String deploymentPlanner;
- @Parameter(name = ApiConstants.SERVICE_OFFERING_DETAILS, type = CommandType.MAP, description = "details for planner, used to store specific parameters")
+ @Parameter(name = ApiConstants.SERVICE_OFFERING_DETAILS, type = CommandType.MAP, description = "Details for planner, used to store specific parameters")
private Map details;
- @Parameter(name = ApiConstants.ROOT_DISK_SIZE, type = CommandType.LONG, since = "4.15", description = "the Root disk size in GB.")
+ @Parameter(name = ApiConstants.ROOT_DISK_SIZE, type = CommandType.LONG, since = "4.15", description = "The Root disk size in GB.")
private Long rootDiskSize;
- @Parameter(name = ApiConstants.BYTES_READ_RATE, type = CommandType.LONG, required = false, description = "bytes read rate of the disk offering")
+ @Parameter(name = ApiConstants.BYTES_READ_RATE, type = CommandType.LONG, required = false, description = "Bytes read rate of the disk offering")
private Long bytesReadRate;
- @Parameter(name = ApiConstants.BYTES_READ_RATE_MAX, type = CommandType.LONG, required = false, description = "burst bytes read rate of the disk offering")
+ @Parameter(name = ApiConstants.BYTES_READ_RATE_MAX, type = CommandType.LONG, required = false, description = "Burst bytes read rate of the disk offering")
private Long bytesReadRateMax;
- @Parameter(name = ApiConstants.BYTES_READ_RATE_MAX_LENGTH, type = CommandType.LONG, required = false, description = "length (in seconds) of the burst")
+ @Parameter(name = ApiConstants.BYTES_READ_RATE_MAX_LENGTH, type = CommandType.LONG, required = false, description = "Length (in seconds) of the burst")
private Long bytesReadRateMaxLength;
- @Parameter(name = ApiConstants.BYTES_WRITE_RATE, type = CommandType.LONG, required = false, description = "bytes write rate of the disk offering")
+ @Parameter(name = ApiConstants.BYTES_WRITE_RATE, type = CommandType.LONG, required = false, description = "Bytes write rate of the disk offering")
private Long bytesWriteRate;
- @Parameter(name = ApiConstants.BYTES_WRITE_RATE_MAX, type = CommandType.LONG, required = false, description = "burst bytes write rate of the disk offering")
+ @Parameter(name = ApiConstants.BYTES_WRITE_RATE_MAX, type = CommandType.LONG, required = false, description = "Burst bytes write rate of the disk offering")
private Long bytesWriteRateMax;
- @Parameter(name = ApiConstants.BYTES_WRITE_RATE_MAX_LENGTH, type = CommandType.LONG, required = false, description = "length (in seconds) of the burst")
+ @Parameter(name = ApiConstants.BYTES_WRITE_RATE_MAX_LENGTH, type = CommandType.LONG, required = false, description = "Length (in seconds) of the burst")
private Long bytesWriteRateMaxLength;
- @Parameter(name = ApiConstants.IOPS_READ_RATE, type = CommandType.LONG, required = false, description = "io requests read rate of the disk offering")
+ @Parameter(name = ApiConstants.IOPS_READ_RATE, type = CommandType.LONG, required = false, description = "I/O requests read rate of the disk offering")
private Long iopsReadRate;
- @Parameter(name = ApiConstants.IOPS_READ_RATE_MAX, type = CommandType.LONG, required = false, description = "burst requests read rate of the disk offering")
+ @Parameter(name = ApiConstants.IOPS_READ_RATE_MAX, type = CommandType.LONG, required = false, description = "Burst requests read rate of the disk offering")
private Long iopsReadRateMax;
- @Parameter(name = ApiConstants.IOPS_READ_RATE_MAX_LENGTH, type = CommandType.LONG, required = false, description = "length (in seconds) of the burst")
+ @Parameter(name = ApiConstants.IOPS_READ_RATE_MAX_LENGTH, type = CommandType.LONG, required = false, description = "Length (in seconds) of the burst")
private Long iopsReadRateMaxLength;
- @Parameter(name = ApiConstants.IOPS_WRITE_RATE, type = CommandType.LONG, required = false, description = "io requests write rate of the disk offering")
+ @Parameter(name = ApiConstants.IOPS_WRITE_RATE, type = CommandType.LONG, required = false, description = "I/O requests write rate of the disk offering")
private Long iopsWriteRate;
- @Parameter(name = ApiConstants.IOPS_WRITE_RATE_MAX, type = CommandType.LONG, required = false, description = "burst io requests write rate of the disk offering")
+ @Parameter(name = ApiConstants.IOPS_WRITE_RATE_MAX, type = CommandType.LONG, required = false, description = "Burst io requests write rate of the disk offering")
private Long iopsWriteRateMax;
- @Parameter(name = ApiConstants.IOPS_WRITE_RATE_MAX_LENGTH, type = CommandType.LONG, required = false, description = "length (in seconds) of the burst")
+ @Parameter(name = ApiConstants.IOPS_WRITE_RATE_MAX_LENGTH, type = CommandType.LONG, required = false, description = "Length (in seconds) of the burst")
private Long iopsWriteRateMaxLength;
- @Parameter(name = ApiConstants.CUSTOMIZED_IOPS, type = CommandType.BOOLEAN, required = false, description = "whether compute offering iops is custom or not", since = "4.4")
+ @Parameter(name = ApiConstants.CUSTOMIZED_IOPS, type = CommandType.BOOLEAN, required = false, description = "Whether compute offering iops is custom or not", since = "4.4")
private Boolean customizedIops;
- @Parameter(name = ApiConstants.MIN_IOPS, type = CommandType.LONG, required = false, description = "min iops of the compute offering", since = "4.4")
+ @Parameter(name = ApiConstants.MIN_IOPS, type = CommandType.LONG, required = false, description = "Min iops of the compute offering", since = "4.4")
private Long minIops;
- @Parameter(name = ApiConstants.MAX_IOPS, type = CommandType.LONG, required = false, description = "max iops of the compute offering", since = "4.4")
+ @Parameter(name = ApiConstants.MAX_IOPS, type = CommandType.LONG, required = false, description = "Max iops of the compute offering", since = "4.4")
private Long maxIops;
@Parameter(name = ApiConstants.HYPERVISOR_SNAPSHOT_RESERVE,
type = CommandType.INTEGER,
required = false,
- description = "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)",
+ description = "Hypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)",
since = "4.4")
private Integer hypervisorSnapshotReserve;
@Parameter(name = ApiConstants.CACHE_MODE,
type = CommandType.STRING,
required = false,
- description = "the cache mode to use for this disk offering. none, writeback or writethrough",
+ description = "The cache mode to use for this disk offering. none, writeback or writethrough",
since = "4.14")
private String cacheMode;
@@ -226,14 +226,14 @@ public class CreateServiceOfferingCmd extends BaseCmd {
private Long storagePolicy;
@Parameter(name = ApiConstants.DYNAMIC_SCALING_ENABLED, type = CommandType.BOOLEAN, since = "4.16",
- description = "true if virtual machine needs to be dynamically scalable of cpu or memory")
+ description = "True if Instance needs to be dynamically scalable of cpu or memory")
protected Boolean isDynamicScalingEnabled;
@Parameter(name = ApiConstants.DISK_OFFERING_ID,
required = false,
type = CommandType.UUID,
entityType = DiskOfferingResponse.class,
- description = "the ID of the disk offering to which service offering should be mapped",
+ description = "The ID of the disk offering to which service offering should be mapped",
since = "4.17")
private Long diskOfferingId;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/offering/DeleteServiceOfferingCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/offering/DeleteServiceOfferingCmd.java
index 19203289d10..d08b4f144c2 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/offering/DeleteServiceOfferingCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/offering/DeleteServiceOfferingCmd.java
@@ -40,7 +40,7 @@ public class DeleteServiceOfferingCmd extends BaseCmd {
type = CommandType.UUID,
entityType = ServiceOfferingResponse.class,
required = true,
- description = "the ID of the service offering")
+ description = "The ID of the service offering")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/offering/UpdateDiskOfferingCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/offering/UpdateDiskOfferingCmd.java
index 370453804cf..2f07f85f983 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/offering/UpdateDiskOfferingCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/offering/UpdateDiskOfferingCmd.java
@@ -47,80 +47,80 @@ public class UpdateDiskOfferingCmd extends BaseCmd {
@Parameter(name = ApiConstants.DISPLAY_TEXT,
type = CommandType.STRING,
- description = "updates alternate display text of the disk offering with this value",
+ description = "Updates alternate display text of the disk offering with this value",
length = 4096)
private String displayText;
@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = DiskOfferingResponse.class, required = true, description = "ID of the disk offering")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "updates name of the disk offering with this value")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "Updates name of the disk offering with this value")
private String diskOfferingName;
- @Parameter(name = ApiConstants.SORT_KEY, type = CommandType.INTEGER, description = "sort key of the disk offering, integer")
+ @Parameter(name = ApiConstants.SORT_KEY, type = CommandType.INTEGER, description = "Sort key of the disk offering, integer")
private Integer sortKey;
@Parameter(name = ApiConstants.DISPLAY_OFFERING,
type = CommandType.BOOLEAN,
- description = "an optional field, whether to display the offering to the end user or not.")
+ description = "An optional field, whether to display the offering to the end user or not.")
private Boolean displayOffering;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.STRING,
- description = "the ID of the containing domain(s) as comma separated string, public for public offerings",
+ description = "The ID of the containing domain(s) as comma separated string, public for public offerings",
since = "4.13",
length = 4096)
private String domainIds;
@Parameter(name = ApiConstants.ZONE_ID,
type = CommandType.STRING,
- description = "the ID of the containing zone(s) as comma separated string, all for all zones offerings",
+ description = "The ID of the containing zone(s) as comma separated string, all for all zones offerings",
since = "4.13")
private String zoneIds;
@Parameter(name = ApiConstants.TAGS,
type = CommandType.STRING,
- description = "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags",
+ description = "Comma-separated list of tags for the disk offering, tags should match with existing storage pool tags",
since = "4.15")
private String tags;
- @Parameter(name = ApiConstants.BYTES_READ_RATE, type = CommandType.LONG, description = "bytes read rate of the disk offering", since = "4.15")
+ @Parameter(name = ApiConstants.BYTES_READ_RATE, type = CommandType.LONG, description = "Bytes read rate of the disk offering", since = "4.15")
private Long bytesReadRate;
- @Parameter(name = ApiConstants.BYTES_READ_RATE_MAX, type = CommandType.LONG, description = "burst bytes read rate of the disk offering", since = "4.15")
+ @Parameter(name = ApiConstants.BYTES_READ_RATE_MAX, type = CommandType.LONG, description = "Burst bytes read rate of the disk offering", since = "4.15")
private Long bytesReadRateMax;
- @Parameter(name = ApiConstants.BYTES_READ_RATE_MAX_LENGTH, type = CommandType.LONG, description = "length (in seconds) of the burst", since = "4.15")
+ @Parameter(name = ApiConstants.BYTES_READ_RATE_MAX_LENGTH, type = CommandType.LONG, description = "Length (in seconds) of the burst", since = "4.15")
private Long bytesReadRateMaxLength;
- @Parameter(name = ApiConstants.BYTES_WRITE_RATE, type = CommandType.LONG, description = "bytes write rate of the disk offering", since = "4.15")
+ @Parameter(name = ApiConstants.BYTES_WRITE_RATE, type = CommandType.LONG, description = "Bytes write rate of the disk offering", since = "4.15")
private Long bytesWriteRate;
- @Parameter(name = ApiConstants.BYTES_WRITE_RATE_MAX, type = CommandType.LONG, description = "burst bytes write rate of the disk offering", since = "4.15")
+ @Parameter(name = ApiConstants.BYTES_WRITE_RATE_MAX, type = CommandType.LONG, description = "Burst bytes write rate of the disk offering", since = "4.15")
private Long bytesWriteRateMax;
- @Parameter(name = ApiConstants.BYTES_WRITE_RATE_MAX_LENGTH, type = CommandType.LONG, description = "length (in seconds) of the burst", since = "4.15")
+ @Parameter(name = ApiConstants.BYTES_WRITE_RATE_MAX_LENGTH, type = CommandType.LONG, description = "Length (in seconds) of the burst", since = "4.15")
private Long bytesWriteRateMaxLength;
- @Parameter(name = ApiConstants.IOPS_READ_RATE, type = CommandType.LONG, description = "io requests read rate of the disk offering", since = "4.15")
+ @Parameter(name = ApiConstants.IOPS_READ_RATE, type = CommandType.LONG, description = "I/O requests read rate of the disk offering", since = "4.15")
private Long iopsReadRate;
- @Parameter(name = ApiConstants.IOPS_READ_RATE_MAX, type = CommandType.LONG, description = "burst requests read rate of the disk offering", since = "4.15")
+ @Parameter(name = ApiConstants.IOPS_READ_RATE_MAX, type = CommandType.LONG, description = "Burst requests read rate of the disk offering", since = "4.15")
private Long iopsReadRateMax;
- @Parameter(name = ApiConstants.IOPS_READ_RATE_MAX_LENGTH, type = CommandType.LONG, description = "length (in seconds) of the burst", since = "4.15")
+ @Parameter(name = ApiConstants.IOPS_READ_RATE_MAX_LENGTH, type = CommandType.LONG, description = "Length (in seconds) of the burst", since = "4.15")
private Long iopsReadRateMaxLength;
- @Parameter(name = ApiConstants.IOPS_WRITE_RATE, type = CommandType.LONG, description = "io requests write rate of the disk offering", since = "4.15")
+ @Parameter(name = ApiConstants.IOPS_WRITE_RATE, type = CommandType.LONG, description = "I/O requests write rate of the disk offering", since = "4.15")
private Long iopsWriteRate;
- @Parameter(name = ApiConstants.IOPS_WRITE_RATE_MAX, type = CommandType.LONG, description = "burst io requests write rate of the disk offering", since = "4.15")
+ @Parameter(name = ApiConstants.IOPS_WRITE_RATE_MAX, type = CommandType.LONG, description = "Burst io requests write rate of the disk offering", since = "4.15")
private Long iopsWriteRateMax;
- @Parameter(name = ApiConstants.IOPS_WRITE_RATE_MAX_LENGTH, type = CommandType.LONG, description = "length (in seconds) of the burst", since = "4.15")
+ @Parameter(name = ApiConstants.IOPS_WRITE_RATE_MAX_LENGTH, type = CommandType.LONG, description = "Length (in seconds) of the burst", since = "4.15")
private Long iopsWriteRateMaxLength;
- @Parameter(name = ApiConstants.CACHE_MODE, type = CommandType.STRING, description = "the cache mode to use for this disk offering", since = "4.15")
+ @Parameter(name = ApiConstants.CACHE_MODE, type = CommandType.STRING, description = "The cache mode to use for this disk offering", since = "4.15")
private String cacheMode;
@Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "state of the disk offering")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/offering/UpdateServiceOfferingCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/offering/UpdateServiceOfferingCmd.java
index e580f0d9f41..0dc97659b9d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/offering/UpdateServiceOfferingCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/offering/UpdateServiceOfferingCmd.java
@@ -48,39 +48,39 @@ public class UpdateServiceOfferingCmd extends BaseCmd {
type = CommandType.UUID,
entityType = ServiceOfferingResponse.class,
required = true,
- description = "the ID of the service offering to be updated")
+ description = "The ID of the service offering to be updated")
private Long id;
- @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "the display text of the service offering to be updated")
+ @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "The display text of the service offering to be updated")
private String displayText;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the service offering to be updated")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the service offering to be updated")
private String serviceOfferingName;
- @Parameter(name = ApiConstants.SORT_KEY, type = CommandType.INTEGER, description = "sort key of the service offering, integer")
+ @Parameter(name = ApiConstants.SORT_KEY, type = CommandType.INTEGER, description = "Sort key of the service offering, integer")
private Integer sortKey;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.STRING,
- description = "the ID of the containing domain(s) as comma separated string, public for public offerings",
+ description = "The ID of the containing domain(s) as comma separated string, public for public offerings",
length = 4096)
private String domainIds;
@Parameter(name = ApiConstants.ZONE_ID,
type = CommandType.STRING,
- description = "the ID of the containing zone(s) as comma separated string, all for all zones offerings",
+ description = "The ID of the containing zone(s) as comma separated string, all for all zones offerings",
since = "4.13")
private String zoneIds;
@Parameter(name = ApiConstants.STORAGE_TAGS,
type = CommandType.STRING,
- description = "comma-separated list of tags for the service offering, tags should match with existing storage pool tags",
+ description = "Comma-separated list of tags for the service offering, tags should match with existing storage pool tags",
since = "4.16")
private String storageTags;
@Parameter(name = ApiConstants.HOST_TAGS,
type = CommandType.STRING,
- description = "the host tag for this service offering.",
+ description = "The host tag for this service offering.",
since = "4.16")
private String hostTags;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/ChangeOutOfBandManagementPasswordCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/ChangeOutOfBandManagementPasswordCmd.java
index e2c31d6cf07..b2269776868 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/ChangeOutOfBandManagementPasswordCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/ChangeOutOfBandManagementPasswordCmd.java
@@ -53,10 +53,10 @@ public class ChangeOutOfBandManagementPasswordCmd extends BaseAsyncCmd {
/////////////////////////////////////////////////////
@Parameter(name = ApiConstants.HOST_ID, type = CommandType.UUID, entityType = HostResponse.class, required = true,
- validations = {ApiArgValidator.PositiveNumber}, description = "the ID of the host")
+ validations = {ApiArgValidator.PositiveNumber}, description = "The ID of the host")
private Long hostId;
- @Parameter(name = ApiConstants.PASSWORD, type = CommandType.STRING, description = "the new host management interface password of maximum length 16, if none is provided a random password would be used")
+ @Parameter(name = ApiConstants.PASSWORD, type = CommandType.STRING, description = "The new host management interface password of maximum length 16, if none is provided a random password would be used")
private String password;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/ConfigureOutOfBandManagementCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/ConfigureOutOfBandManagementCmd.java
index 157d3c627db..4052539a51d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/ConfigureOutOfBandManagementCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/ConfigureOutOfBandManagementCmd.java
@@ -54,22 +54,22 @@ public class ConfigureOutOfBandManagementCmd extends BaseCmd {
/////////////////////////////////////////////////////
@Parameter(name = ApiConstants.HOST_ID, type = CommandType.UUID, entityType = HostResponse.class, required = true,
- validations = {ApiArgValidator.PositiveNumber}, description = "the ID of the host")
+ validations = {ApiArgValidator.PositiveNumber}, description = "The ID of the host")
private Long hostId;
- @Parameter(name = ApiConstants.DRIVER, type = CommandType.STRING, required = true, description = "the host management interface driver, for example: ipmitool")
+ @Parameter(name = ApiConstants.DRIVER, type = CommandType.STRING, required = true, description = "The host management interface driver, for example: ipmitool")
private String driver;
- @Parameter(name = ApiConstants.ADDRESS, type = CommandType.STRING, required = true, description = "the host management interface IP address")
+ @Parameter(name = ApiConstants.ADDRESS, type = CommandType.STRING, required = true, description = "The host management interface IP address")
private String address;
- @Parameter(name = ApiConstants.PORT, type = CommandType.STRING, required = true, description = "the host management interface port")
+ @Parameter(name = ApiConstants.PORT, type = CommandType.STRING, required = true, description = "The host management interface port")
private String port;
- @Parameter(name = ApiConstants.USERNAME, type = CommandType.STRING, required = true, description = "the host management interface user")
+ @Parameter(name = ApiConstants.USERNAME, type = CommandType.STRING, required = true, description = "The host management interface user")
private String username;
- @Parameter(name = ApiConstants.PASSWORD, type = CommandType.STRING, required = true, description = "the host management interface password")
+ @Parameter(name = ApiConstants.PASSWORD, type = CommandType.STRING, required = true, description = "The host management interface password")
private String password;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/DisableOutOfBandManagementForClusterCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/DisableOutOfBandManagementForClusterCmd.java
index 445e7b92665..26b0eac6be4 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/DisableOutOfBandManagementForClusterCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/DisableOutOfBandManagementForClusterCmd.java
@@ -54,7 +54,7 @@ public class DisableOutOfBandManagementForClusterCmd extends BaseAsyncCmd {
/////////////////////////////////////////////////////
@Parameter(name = ApiConstants.CLUSTER_ID, type = BaseCmd.CommandType.UUID, required = true, entityType = ClusterResponse.class,
- validations = {ApiArgValidator.PositiveNumber}, description = "the ID of the cluster")
+ validations = {ApiArgValidator.PositiveNumber}, description = "The ID of the cluster")
private Long clusterId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/DisableOutOfBandManagementForHostCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/DisableOutOfBandManagementForHostCmd.java
index 7e4444e93fb..6c9b48ef28f 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/DisableOutOfBandManagementForHostCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/DisableOutOfBandManagementForHostCmd.java
@@ -54,7 +54,7 @@ public class DisableOutOfBandManagementForHostCmd extends BaseAsyncCmd {
/////////////////////////////////////////////////////
@Parameter(name = ApiConstants.HOST_ID, type = BaseCmd.CommandType.UUID, required = true, entityType = HostResponse.class,
- validations = {ApiArgValidator.PositiveNumber}, description = "the ID of the host")
+ validations = {ApiArgValidator.PositiveNumber}, description = "The ID of the host")
private Long hostId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/DisableOutOfBandManagementForZoneCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/DisableOutOfBandManagementForZoneCmd.java
index 2028f8fc2a0..4f262ca5c09 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/DisableOutOfBandManagementForZoneCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/DisableOutOfBandManagementForZoneCmd.java
@@ -54,7 +54,7 @@ public class DisableOutOfBandManagementForZoneCmd extends BaseAsyncCmd {
/////////////////////////////////////////////////////
@Parameter(name = ApiConstants.ZONE_ID, type = BaseCmd.CommandType.UUID, required = true, entityType = ZoneResponse.class,
- validations = {ApiArgValidator.PositiveNumber}, description = "the ID of the zone")
+ validations = {ApiArgValidator.PositiveNumber}, description = "The ID of the zone")
private Long zoneId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/EnableOutOfBandManagementForClusterCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/EnableOutOfBandManagementForClusterCmd.java
index 549743b3172..6620f86907e 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/EnableOutOfBandManagementForClusterCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/EnableOutOfBandManagementForClusterCmd.java
@@ -54,7 +54,7 @@ public class EnableOutOfBandManagementForClusterCmd extends BaseAsyncCmd {
/////////////////////////////////////////////////////
@Parameter(name = ApiConstants.CLUSTER_ID, type = BaseCmd.CommandType.UUID, required = true, entityType = ClusterResponse.class,
- validations = {ApiArgValidator.PositiveNumber}, description = "the ID of the cluster")
+ validations = {ApiArgValidator.PositiveNumber}, description = "The ID of the cluster")
private Long clusterId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/EnableOutOfBandManagementForHostCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/EnableOutOfBandManagementForHostCmd.java
index 834181a5e1c..3cfee31f78a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/EnableOutOfBandManagementForHostCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/EnableOutOfBandManagementForHostCmd.java
@@ -54,7 +54,7 @@ public class EnableOutOfBandManagementForHostCmd extends BaseAsyncCmd {
/////////////////////////////////////////////////////
@Parameter(name = ApiConstants.HOST_ID, type = BaseCmd.CommandType.UUID, required = true, entityType = HostResponse.class,
- validations = {ApiArgValidator.PositiveNumber}, description = "the ID of the host")
+ validations = {ApiArgValidator.PositiveNumber}, description = "The ID of the host")
private Long hostId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/EnableOutOfBandManagementForZoneCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/EnableOutOfBandManagementForZoneCmd.java
index de4c4d801de..99d2324b1b6 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/EnableOutOfBandManagementForZoneCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/EnableOutOfBandManagementForZoneCmd.java
@@ -54,7 +54,7 @@ public class EnableOutOfBandManagementForZoneCmd extends BaseAsyncCmd {
/////////////////////////////////////////////////////
@Parameter(name = ApiConstants.ZONE_ID, type = BaseCmd.CommandType.UUID, required = true, entityType = ZoneResponse.class,
- validations = {ApiArgValidator.PositiveNumber}, description = "the ID of the zone")
+ validations = {ApiArgValidator.PositiveNumber}, description = "The ID of the zone")
private Long zoneId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/IssueOutOfBandManagementPowerActionCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/IssueOutOfBandManagementPowerActionCmd.java
index 97a813c9d47..c63b03aad1b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/IssueOutOfBandManagementPowerActionCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/outofbandmanagement/IssueOutOfBandManagementPowerActionCmd.java
@@ -53,14 +53,14 @@ public class IssueOutOfBandManagementPowerActionCmd extends BaseAsyncCmd {
/////////////////////////////////////////////////////
@Parameter(name = ApiConstants.HOST_ID, type = CommandType.UUID, entityType = HostResponse.class, required = true,
- validations = {ApiArgValidator.PositiveNumber}, description = "the ID of the host")
+ 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")
+ @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")
+ description = "Out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS")
private String powerAction;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/pod/CreatePodCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/pod/CreatePodCmd.java
index c1d9a6db429..d693c756f2d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/pod/CreatePodCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/pod/CreatePodCmd.java
@@ -38,26 +38,26 @@ public class CreatePodCmd extends BaseCmd {
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "the name of the Pod")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "The name of the Pod")
private String podName;
@Parameter(name = ApiConstants.ZONE_ID,
type = CommandType.UUID,
entityType = ZoneResponse.class,
required = true,
- description = "the Zone ID in which the Pod will be created")
+ description = "The Zone ID in which the Pod will be created")
private Long zoneId;
- @Parameter(name = ApiConstants.START_IP, type = CommandType.STRING, description = "the starting IP address for the Pod")
+ @Parameter(name = ApiConstants.START_IP, type = CommandType.STRING, description = "The starting IP address for the Pod")
private String startIp;
- @Parameter(name = ApiConstants.END_IP, type = CommandType.STRING, description = "the ending IP address for the Pod")
+ @Parameter(name = ApiConstants.END_IP, type = CommandType.STRING, description = "The ending IP address for the Pod")
private String endIp;
- @Parameter(name = ApiConstants.NETMASK, type = CommandType.STRING, description = "the netmask for the Pod")
+ @Parameter(name = ApiConstants.NETMASK, type = CommandType.STRING, description = "The netmask for the Pod")
private String netmask;
- @Parameter(name = ApiConstants.GATEWAY, type = CommandType.STRING, description = "the gateway for the Pod")
+ @Parameter(name = ApiConstants.GATEWAY, type = CommandType.STRING, description = "The gateway for the Pod")
private String gateway;
@Parameter(name = ApiConstants.ALLOCATION_STATE, type = CommandType.STRING, description = "Allocation state of this Pod for allocation of new resources")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/pod/DeletePodCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/pod/DeletePodCmd.java
index c1de800d745..953fcc91fa7 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/pod/DeletePodCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/pod/DeletePodCmd.java
@@ -38,7 +38,7 @@ public class DeletePodCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = PodResponse.class, required = true, description = "the ID of the Pod")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = PodResponse.class, required = true, description = "The ID of the Pod")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/pod/ListPodsByCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/pod/ListPodsByCmd.java
index 5ad0b457ced..8dbf5bcf6d6 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/pod/ListPodsByCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/pod/ListPodsByCmd.java
@@ -40,19 +40,19 @@ public class ListPodsByCmd extends BaseListCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = PodResponse.class, description = "list Pods by ID")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = PodResponse.class, description = "List Pods by ID")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "list Pods by name")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "List Pods by name")
private String podName;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "list Pods by Zone ID")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "List Pods by Zone ID")
private Long zoneId;
- @Parameter(name = ApiConstants.ALLOCATION_STATE, type = CommandType.STRING, description = "list pods by allocation state")
+ @Parameter(name = ApiConstants.ALLOCATION_STATE, type = CommandType.STRING, description = "List pods by allocation state")
private String allocationState;
- @Parameter(name = ApiConstants.SHOW_CAPACITIES, type = CommandType.BOOLEAN, description = "flag to display the capacity of the pods")
+ @Parameter(name = ApiConstants.SHOW_CAPACITIES, type = CommandType.BOOLEAN, description = "Flag to display the capacity of the pods")
private Boolean showCapacities;
/////////////////////////////////////////////////////
@@ -86,8 +86,8 @@ public class ListPodsByCmd extends BaseListCmd {
@Override
public void execute() {
Pair, Integer> result = _mgr.searchForPods(this);
- ListResponse response = new ListResponse();
- List podResponses = new ArrayList();
+ ListResponse response = new ListResponse<>();
+ List podResponses = new ArrayList<>();
for (Pod pod : result.first()) {
PodResponse podResponse = _responseGenerator.createPodResponse(pod, showCapacities);
podResponse.setObjectName("pod");
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/pod/UpdatePodCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/pod/UpdatePodCmd.java
index 7dae6f4c7cf..24a549c623a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/pod/UpdatePodCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/pod/UpdatePodCmd.java
@@ -38,22 +38,22 @@ public class UpdatePodCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = PodResponse.class, required = true, description = "the ID of the Pod")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = PodResponse.class, required = true, description = "The ID of the Pod")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the Pod")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the Pod")
private String podName;
- @Parameter(name = ApiConstants.START_IP, type = CommandType.STRING, description = "the starting IP address for the Pod")
+ @Parameter(name = ApiConstants.START_IP, type = CommandType.STRING, description = "The starting IP address for the Pod")
private String startIp;
- @Parameter(name = ApiConstants.END_IP, type = CommandType.STRING, description = "the ending IP address for the Pod")
+ @Parameter(name = ApiConstants.END_IP, type = CommandType.STRING, description = "The ending IP address for the Pod")
private String endIp;
- @Parameter(name = ApiConstants.NETMASK, type = CommandType.STRING, description = "the netmask of the Pod")
+ @Parameter(name = ApiConstants.NETMASK, type = CommandType.STRING, description = "The netmask of the Pod")
private String netmask;
- @Parameter(name = ApiConstants.GATEWAY, type = CommandType.STRING, description = "the gateway for the Pod")
+ @Parameter(name = ApiConstants.GATEWAY, type = CommandType.STRING, description = "The gateway for the Pod")
private String gateway;
@Parameter(name = ApiConstants.ALLOCATION_STATE, type = CommandType.STRING, description = "Allocation state of this cluster for allocation of new resources")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/region/CreatePortableIpRangeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/region/CreatePortableIpRangeCmd.java
index fd103c83830..1142bdd3f43 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/region/CreatePortableIpRangeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/region/CreatePortableIpRangeCmd.java
@@ -36,7 +36,7 @@ import com.cloud.user.Account;
@APICommand(name = "createPortableIpRange",
responseObject = PortableIpRangeResponse.class,
- description = "adds a range of portable public IP's to a region",
+ description = "Adds a range of portable public IP's to a region",
since = "4.2.0",
requestHasSensitiveInfo = false,
responseHasSensitiveInfo = false)
@@ -51,16 +51,16 @@ public class CreatePortableIpRangeCmd extends BaseAsyncCreateCmd {
@Parameter(name = ApiConstants.REGION_ID, type = CommandType.INTEGER, entityType = RegionResponse.class, required = true, description = "Id of the Region")
private Integer regionId;
- @Parameter(name = ApiConstants.START_IP, type = CommandType.STRING, required = true, description = "the beginning IP address in the portable IP range")
+ @Parameter(name = ApiConstants.START_IP, type = CommandType.STRING, required = true, description = "The beginning IP address in the portable IP range")
private String startIp;
- @Parameter(name = ApiConstants.END_IP, type = CommandType.STRING, required = true, description = "the ending IP address in the portable IP range")
+ @Parameter(name = ApiConstants.END_IP, type = CommandType.STRING, required = true, description = "The ending IP address in the portable IP range")
private String endIp;
- @Parameter(name = ApiConstants.GATEWAY, type = CommandType.STRING, required = true, description = "the gateway for the portable IP range")
+ @Parameter(name = ApiConstants.GATEWAY, type = CommandType.STRING, required = true, description = "The gateway for the portable IP range")
private String gateway;
- @Parameter(name = ApiConstants.NETMASK, type = CommandType.STRING, required = true, description = "the netmask of the portable IP range")
+ @Parameter(name = ApiConstants.NETMASK, type = CommandType.STRING, required = true, description = "The netmask of the portable IP range")
private String netmask;
@Parameter(name = ApiConstants.VLAN, type = CommandType.STRING, description = "VLAN id, if not specified defaulted to untagged")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/region/DeletePortableIpRangeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/region/DeletePortableIpRangeCmd.java
index 3ff46fcc94d..da7293ea219 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/region/DeletePortableIpRangeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/region/DeletePortableIpRangeCmd.java
@@ -31,7 +31,7 @@ import org.apache.cloudstack.api.response.SuccessResponse;
import com.cloud.event.EventTypes;
import com.cloud.user.Account;
-@APICommand(name = "deletePortableIpRange", description = "deletes a range of portable public IP's associated with a region", responseObject = SuccessResponse.class,
+@APICommand(name = "deletePortableIpRange", description = "Deletes a range of portable public IP's associated with a region", responseObject = SuccessResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class DeletePortableIpRangeCmd extends BaseAsyncCmd {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/region/ListPortableIpRangesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/region/ListPortableIpRangesCmd.java
index e654da6df44..92a1cc3822e 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/region/ListPortableIpRangesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/region/ListPortableIpRangesCmd.java
@@ -32,7 +32,7 @@ import org.apache.cloudstack.region.PortableIpRange;
import com.cloud.user.Account;
-@APICommand(name = "listPortableIpRanges", description = "list portable IP ranges", responseObject = PortableIpRangeResponse.class,
+@APICommand(name = "listPortableIpRanges", description = "List portable IP ranges", responseObject = PortableIpRangeResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListPortableIpRangesCmd extends BaseListCmd {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/region/UpdateRegionCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/region/UpdateRegionCmd.java
index 4267f6a2c28..ec5bfdabf5e 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/region/UpdateRegionCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/region/UpdateRegionCmd.java
@@ -42,10 +42,10 @@ public class UpdateRegionCmd extends BaseCmd {
@Parameter(name = ApiConstants.ID, type = CommandType.INTEGER, required = true, description = "Id of region to update")
private Integer id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "updates region with this name")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "Updates region with this name")
private String regionName;
- @Parameter(name = ApiConstants.END_POINT, type = CommandType.STRING, description = "updates region with this end point")
+ @Parameter(name = ApiConstants.END_POINT, type = CommandType.STRING, description = "Updates region with this end point")
private String endPoint;
@Inject
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/ArchiveAlertsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/ArchiveAlertsCmd.java
index dc8c15cf09d..e495a168329 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/ArchiveAlertsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/ArchiveAlertsCmd.java
@@ -46,18 +46,18 @@ public class ArchiveAlertsCmd extends BaseCmd {
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = AlertResponse.class,
- description = "the IDs of the alerts")
+ description = "The IDs of the alerts")
private List ids;
- @Parameter(name = ApiConstants.END_DATE, type = CommandType.DATE, description = "end date range to archive alerts"
+ @Parameter(name = ApiConstants.END_DATE, type = CommandType.DATE, description = "End date range to archive alerts"
+ " (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")")
private Date endDate;
- @Parameter(name = ApiConstants.START_DATE, type = CommandType.DATE, description = "start date range to archive alerts"
+ @Parameter(name = ApiConstants.START_DATE, type = CommandType.DATE, description = "Start date range to archive alerts"
+ " (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")")
private Date startDate;
- @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, description = "archive by alert type")
+ @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, description = "Archive by alert type")
private String type;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/CleanVMReservationsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/CleanVMReservationsCmd.java
index 1ae8c944123..ba1b2be4008 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/CleanVMReservationsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/CleanVMReservationsCmd.java
@@ -27,7 +27,7 @@ import org.apache.cloudstack.context.CallContext;
import com.cloud.event.EventTypes;
import com.cloud.user.Account;
-@APICommand(name = "cleanVMReservations", description = "Cleanups VM reservations in the database.", responseObject = SuccessResponse.class,
+@APICommand(name = "cleanVMReservations", description = "Cleanups Instance reservations in the database.", responseObject = SuccessResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class CleanVMReservationsCmd extends BaseAsyncCmd {
@@ -63,7 +63,7 @@ public class CleanVMReservationsCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "cleaning vm reservations in database";
+ return "Cleaning Instance reservations in database";
}
@Override
@@ -73,7 +73,7 @@ public class CleanVMReservationsCmd extends BaseAsyncCmd {
SuccessResponse response = new SuccessResponse(getCommandName());
this.setResponseObject(response);
} catch (Exception ex) {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to clean vm reservations");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to clean Instance reservations");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/DeleteAlertsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/DeleteAlertsCmd.java
index 9262a120f72..f59a16d8373 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/DeleteAlertsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/DeleteAlertsCmd.java
@@ -46,18 +46,18 @@ public class DeleteAlertsCmd extends BaseCmd {
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = AlertResponse.class,
- description = "the IDs of the alerts")
+ description = "The IDs of the alerts")
private List ids;
- @Parameter(name = ApiConstants.END_DATE, type = CommandType.DATE, description = "end date range to delete alerts"
+ @Parameter(name = ApiConstants.END_DATE, type = CommandType.DATE, description = "End date range to delete alerts"
+ " (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")")
private Date endDate;
- @Parameter(name = ApiConstants.START_DATE, type = CommandType.DATE, description = "start date range to delete alerts"
+ @Parameter(name = ApiConstants.START_DATE, type = CommandType.DATE, description = "Start date range to delete alerts"
+ " (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")")
private Date startDate;
- @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, description = "delete by alert type")
+ @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, description = "Delete by alert type")
private String type;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/ListAlertsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/ListAlertsCmd.java
index 64cf691e6a7..e8889670323 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/ListAlertsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/ListAlertsCmd.java
@@ -39,13 +39,13 @@ public class ListAlertsCmd extends BaseListCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = AlertResponse.class, description = "the ID of the alert")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = AlertResponse.class, description = "The ID of the alert")
private Long id;
- @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, description = "list by alert type")
+ @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, description = "List by alert type")
private String type;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "list by alert name", since = "4.3")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "List by alert name", since = "4.3")
private String name;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/ListCapacityCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/ListCapacityCmd.java
index 6b31c4cc43c..e0d57795b71 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/ListCapacityCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/ListCapacityCmd.java
@@ -46,23 +46,23 @@ public class ListCapacityCmd extends BaseListCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "lists capacity by the Zone ID")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "Lists capacity by the Zone ID")
private Long zoneId;
- @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "lists capacity by the Pod ID")
+ @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "Lists capacity by the Pod ID")
private Long podId;
@Parameter(name = ApiConstants.CLUSTER_ID,
type = CommandType.UUID,
entityType = ClusterResponse.class,
since = "3.0.0",
- description = "lists capacity by the Cluster ID")
+ description = "Lists capacity by the Cluster ID")
private Long clusterId;
- @Parameter(name = ApiConstants.FETCH_LATEST, type = CommandType.BOOLEAN, since = "3.0.0", description = "recalculate capacities and fetch the latest")
+ @Parameter(name = ApiConstants.FETCH_LATEST, type = CommandType.BOOLEAN, since = "3.0.0", description = "Recalculate capacities and fetch the latest")
private Boolean fetchLatest;
- @Parameter(name = ApiConstants.TYPE, type = CommandType.INTEGER, description = "lists capacity by type" + "* CAPACITY_TYPE_MEMORY = 0" + "* CAPACITY_TYPE_CPU = 1"
+ @Parameter(name = ApiConstants.TYPE, type = CommandType.INTEGER, description = "Lists capacity by type" + "* CAPACITY_TYPE_MEMORY = 0" + "* CAPACITY_TYPE_CPU = 1"
+ "* CAPACITY_TYPE_STORAGE = 2" + "* CAPACITY_TYPE_STORAGE_ALLOCATED = 3" + "* CAPACITY_TYPE_VIRTUAL_NETWORK_PUBLIC_IP = 4" + "* CAPACITY_TYPE_PRIVATE_IP = 5"
+ "* CAPACITY_TYPE_SECONDARY_STORAGE = 6" + "* CAPACITY_TYPE_VLAN = 7" + "* CAPACITY_TYPE_DIRECT_ATTACHED_PUBLIC_IP = 8" + "* CAPACITY_TYPE_LOCAL_STORAGE = 9"
+ "* CAPACITY_TYPE_GPU = 19" + "* CAPACITY_TYPE_CPU_CORE = 90.")
@@ -132,14 +132,16 @@ public class ListCapacityCmd extends BaseListCmd {
Collections.sort(capacityResponses, new Comparator() {
public int compare(CapacityResponse resp1, CapacityResponse resp2) {
int res = resp1.getZoneName().compareTo(resp2.getZoneName());
+ // Group by zone
if (res != 0) {
return res;
- } else {
- return resp1.getCapacityType().compareTo(resp2.getCapacityType());
}
+ // Sort by capacity type only if not already sorted by usage
+ return (getSortBy() != null) ? 0 : resp1.getCapacityType().compareTo(resp2.getCapacityType());
}
});
+
response.setResponses(capacityResponses);
response.setResponseName(getCommandName());
this.setResponseObject(response);
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/StartRollingMaintenanceCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/StartRollingMaintenanceCmd.java
index 04fa1002611..3869b9cdf95 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/StartRollingMaintenanceCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/StartRollingMaintenanceCmd.java
@@ -60,31 +60,31 @@ public class StartRollingMaintenanceCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
@Parameter(name = ApiConstants.POD_IDS, type = CommandType.LIST, collectionType = CommandType.UUID,
- entityType = PodResponse.class, description = "the IDs of the pods to start maintenance on")
+ entityType = PodResponse.class, description = "The IDs of the pods to start maintenance on")
private List podIds;
@Parameter(name = ApiConstants.CLUSTER_IDS, type = CommandType.LIST, collectionType = CommandType.UUID,
- entityType = ClusterResponse.class, description = "the IDs of the clusters to start maintenance on")
+ entityType = ClusterResponse.class, description = "The IDs of the clusters to start maintenance on")
private List clusterIds;
@Parameter(name = ApiConstants.ZONE_ID_LIST, type = CommandType.LIST, collectionType = CommandType.UUID,
- entityType = ZoneResponse.class, description = "the IDs of the zones to start maintenance on")
+ entityType = ZoneResponse.class, description = "The IDs of the zones to start maintenance on")
private List zoneIds;
@Parameter(name = ApiConstants.HOST_IDS, type = CommandType.LIST, collectionType = CommandType.UUID,
- entityType = HostResponse.class, description = "the IDs of the hosts to start maintenance on")
+ entityType = HostResponse.class, description = "The IDs of the hosts to start maintenance on")
private List hostIds;
@Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN,
- description = "if rolling mechanism should continue in case of an error")
+ description = "If rolling mechanism should continue in case of an error")
private Boolean forced;
@Parameter(name = ApiConstants.PAYLOAD, type = CommandType.STRING,
- description = "the command to execute while hosts are on maintenance")
+ description = "The command to execute while hosts are on maintenance")
private String payload;
@Parameter(name = ApiConstants.TIMEOUT, type = CommandType.INTEGER,
- description = "optional operation timeout (in seconds) that overrides the global timeout setting")
+ description = "Optional operation timeout (in seconds) that overrides the global timeout setting")
private Integer timeout;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/icon/DeleteResourceIconCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/icon/DeleteResourceIconCmd.java
index e97a68bddcb..6289879c1a2 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/icon/DeleteResourceIconCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/icon/DeleteResourceIconCmd.java
@@ -31,7 +31,7 @@ import org.apache.cloudstack.context.CallContext;
import java.util.List;
-@APICommand(name = "deleteResourceIcon", description = "deletes the resource icon from the specified resource(s)",
+@APICommand(name = "deleteResourceIcon", description = "Deletes the resource icon from the specified resource(s)",
responseObject = SuccessResponse.class, since = "4.16.0.0", entityType = {ResourceIcon.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false,
authorized = {RoleType.Admin, RoleType.DomainAdmin, RoleType.ResourceAdmin, RoleType.User})
@@ -45,10 +45,10 @@ public class DeleteResourceIconCmd extends BaseCmd {
type = BaseCmd.CommandType.LIST,
required = true,
collectionType = BaseCmd.CommandType.STRING,
- description = "list of resources to upload the icon/image for")
+ description = "List of resources to upload the icon/image for")
private List resourceIds;
- @Parameter(name = ApiConstants.RESOURCE_TYPE, type = BaseCmd.CommandType.STRING, required = true, description = "type of the resource")
+ @Parameter(name = ApiConstants.RESOURCE_TYPE, type = BaseCmd.CommandType.STRING, required = true, description = "Type of the resource")
private String resourceType;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/icon/ListResourceIconCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/icon/ListResourceIconCmd.java
index 6cc3173cf15..7b9c9671d47 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/icon/ListResourceIconCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/icon/ListResourceIconCmd.java
@@ -42,10 +42,10 @@ public class ListResourceIconCmd extends BaseCmd {
type = BaseCmd.CommandType.LIST,
required = true,
collectionType = BaseCmd.CommandType.STRING,
- description = "list of resources to upload the icon/image for")
+ description = "List of resources to upload the icon/image for")
private List resourceIds;
- @Parameter(name = ApiConstants.RESOURCE_TYPE, type = BaseCmd.CommandType.STRING, required = true, description = "type of the resource")
+ @Parameter(name = ApiConstants.RESOURCE_TYPE, type = BaseCmd.CommandType.STRING, required = true, description = "Type of the resource")
private String resourceType;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/icon/UploadResourceIconCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/icon/UploadResourceIconCmd.java
index 5a6acd961bf..9201e345302 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/icon/UploadResourceIconCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/resource/icon/UploadResourceIconCmd.java
@@ -55,10 +55,10 @@ public class UploadResourceIconCmd extends BaseCmd {
type = BaseCmd.CommandType.LIST,
required = true,
collectionType = BaseCmd.CommandType.STRING,
- description = "list of resources to upload the icon/image for")
+ description = "List of resources to upload the icon/image for")
private List resourceIds;
- @Parameter(name = ApiConstants.RESOURCE_TYPE, type = BaseCmd.CommandType.STRING, required = true, description = "type of the resource")
+ @Parameter(name = ApiConstants.RESOURCE_TYPE, type = BaseCmd.CommandType.STRING, required = true, description = "Type of the resource")
private String resourceType;
@Parameter(name = ApiConstants.BASE64_IMAGE, type = BaseCmd.CommandType.STRING, required = true,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/router/ConfigureOvsElementCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/router/ConfigureOvsElementCmd.java
index 4a8c0bc3a3b..e4046214958 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/router/ConfigureOvsElementCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/router/ConfigureOvsElementCmd.java
@@ -48,7 +48,7 @@ public class ConfigureOvsElementCmd extends BaseAsyncCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = OvsProviderResponse.class, required = true, description = "the ID of the ovs provider")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = OvsProviderResponse.class, required = true, description = "The ID of the ovs provider")
private Long id;
@Parameter(name = ApiConstants.ENABLED, type = CommandType.BOOLEAN, required = true, description = "Enabled/Disabled the service provider")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/router/ConfigureVirtualRouterElementCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/router/ConfigureVirtualRouterElementCmd.java
index aa119f3aca7..7be41834cd5 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/router/ConfigureVirtualRouterElementCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/router/ConfigureVirtualRouterElementCmd.java
@@ -54,7 +54,7 @@ public class ConfigureVirtualRouterElementCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = VirtualRouterProviderResponse.class,
required = true,
- description = "the ID of the virtual router provider")
+ description = "The ID of the virtual router provider")
private Long id;
@Parameter(name = ApiConstants.ENABLED, type = CommandType.BOOLEAN, required = true, description = "Enabled/Disabled the service provider")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/router/CreateVirtualRouterElementCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/router/CreateVirtualRouterElementCmd.java
index e85531c83c4..7c17fd794da 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/router/CreateVirtualRouterElementCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/router/CreateVirtualRouterElementCmd.java
@@ -54,7 +54,7 @@ public class CreateVirtualRouterElementCmd extends BaseAsyncCreateCmd {
type = CommandType.UUID,
entityType = ProviderResponse.class,
required = true,
- description = "the network service provider ID of the virtual router element")
+ description = "The network service provider ID of the virtual router element")
private Long nspId;
@Parameter(name = ApiConstants.PROVIDER_TYPE,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/router/DestroyRouterCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/router/DestroyRouterCmd.java
index 39ccee47fbe..66fc2eb79e6 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/router/DestroyRouterCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/router/DestroyRouterCmd.java
@@ -42,7 +42,7 @@ public class DestroyRouterCmd extends BaseAsyncCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = DomainRouterResponse.class, required = true, description = "the ID of the router")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = DomainRouterResponse.class, required = true, description = "The ID of the router")
private Long id;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/router/GetRouterHealthCheckResultsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/router/GetRouterHealthCheckResultsCmd.java
index 4bef26e0555..6d4d62929de 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/router/GetRouterHealthCheckResultsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/router/GetRouterHealthCheckResultsCmd.java
@@ -52,10 +52,10 @@ public class GetRouterHealthCheckResultsCmd extends BaseCmd {
/////////////////////////////////////////////////////
@Parameter(name = ApiConstants.ROUTER_ID, type = CommandType.UUID, entityType = DomainRouterResponse.class,
- required = true, description = "the ID of the router")
+ required = true, description = "The ID of the router")
private Long routerId;
- @Parameter(name = ApiConstants.PERFORM_FRESH_CHECKS, type = CommandType.BOOLEAN, description = "if true is passed for this parameter, " +
+ @Parameter(name = ApiConstants.PERFORM_FRESH_CHECKS, type = CommandType.BOOLEAN, description = "If true is passed for this parameter, " +
"health checks are performed on the fly. Else last performed checks data is fetched")
private Boolean performFreshChecks;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/router/ListOvsElementsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/router/ListOvsElementsCmd.java
index a267aa52669..5ed3ae0e208 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/router/ListOvsElementsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/router/ListOvsElementsCmd.java
@@ -46,13 +46,13 @@ public class ListOvsElementsCmd extends BaseListCmd {
// ///////////////////////////////////////////////////
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = OvsProviderResponse.class, description = "list ovs elements by id")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = OvsProviderResponse.class, description = "List ovs elements by id")
private Long id;
- @Parameter(name = ApiConstants.NSP_ID, type = CommandType.UUID, entityType = ProviderResponse.class, description = "list ovs elements by network service provider id")
+ @Parameter(name = ApiConstants.NSP_ID, type = CommandType.UUID, entityType = ProviderResponse.class, description = "List ovs elements by network service provider id")
private Long nspId;
- @Parameter(name = ApiConstants.ENABLED, type = CommandType.BOOLEAN, description = "list network offerings by enabled state")
+ @Parameter(name = ApiConstants.ENABLED, type = CommandType.BOOLEAN, description = "List network offerings by enabled state")
private Boolean enabled;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/router/ListRoutersCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/router/ListRoutersCmd.java
index 9e34c05ce21..92ebd323169 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/router/ListRoutersCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/router/ListRoutersCmd.java
@@ -46,45 +46,45 @@ public class ListRoutersCmd extends BaseListProjectAndAccountResourcesCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.HOST_ID, type = CommandType.UUID, entityType = HostResponse.class, description = "the host ID of the router")
+ @Parameter(name = ApiConstants.HOST_ID, type = CommandType.UUID, entityType = HostResponse.class, description = "The host ID of the router")
private Long hostId;
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = UserVmResponse.class, description = "the ID of the disk router")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = UserVmResponse.class, description = "The ID of the disk router")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the router")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the router")
private String routerName;
- @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "the Pod ID of the router")
+ @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "The Pod ID of the router")
private Long podId;
- @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "the state of the router")
+ @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "The state of the router")
private String state;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "the Zone ID of the router")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "The Zone ID of the router")
private Long zoneId;
- @Parameter(name = ApiConstants.CLUSTER_ID, type = CommandType.UUID, entityType = ClusterResponse.class, description = "the cluster ID of the router")
+ @Parameter(name = ApiConstants.CLUSTER_ID, type = CommandType.UUID, entityType = ClusterResponse.class, description = "The cluster ID of the router")
private Long clusterId;
- @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "list by network id")
+ @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "List by network id")
private Long networkId;
@Parameter(name = ApiConstants.VPC_ID, type = CommandType.UUID, entityType = VpcResponse.class, description = "List networks by VPC")
private Long vpcId;
- @Parameter(name = ApiConstants.FOR_VPC, type = CommandType.BOOLEAN, description = "if true is passed for this parameter, list only VPC routers")
+ @Parameter(name = ApiConstants.FOR_VPC, type = CommandType.BOOLEAN, description = "If true is passed for this parameter, list only VPC routers")
private Boolean forVpc;
- @Parameter(name = ApiConstants.VERSION, type = CommandType.STRING, description = "list virtual router elements by version")
+ @Parameter(name = ApiConstants.VERSION, type = CommandType.STRING, description = "List virtual router elements by version")
private String version;
@Parameter(name = ApiConstants.HEALTHCHECK_FAILED, type = CommandType.BOOLEAN, since = "4.16",
- description = "if this parameter is passed, list only routers by health check results")
+ description = "If this parameter is passed, list only routers by health check results")
private Boolean healthCheckFailed;
@Parameter(name = ApiConstants.FETCH_ROUTER_HEALTH_CHECK_RESULTS, type = CommandType.BOOLEAN, since = "4.14",
- description = "if true is passed for this parameter, also fetch last executed health check results for the router. Default is false")
+ description = "If true is passed for this parameter, also fetch last executed health check results for the router. Default is false")
private Boolean fetchHealthCheckResults;
@Parameter(name = ApiConstants.ARCH, type = CommandType.STRING,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/router/ListVirtualRouterElementsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/router/ListVirtualRouterElementsCmd.java
index 424b8c29d04..6b175b10ebd 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/router/ListVirtualRouterElementsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/router/ListVirtualRouterElementsCmd.java
@@ -49,16 +49,16 @@ public class ListVirtualRouterElementsCmd extends BaseListCmd {
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VirtualRouterProviderResponse.class, description = "list virtual router elements by id")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VirtualRouterProviderResponse.class, description = "List virtual router elements by id")
private Long id;
@Parameter(name = ApiConstants.NSP_ID,
type = CommandType.UUID,
entityType = ProviderResponse.class,
- description = "list virtual router elements by network service provider id")
+ description = "List virtual router elements by network service provider id")
private Long nspId;
- @Parameter(name = ApiConstants.ENABLED, type = CommandType.BOOLEAN, description = "list network offerings by enabled state")
+ @Parameter(name = ApiConstants.ENABLED, type = CommandType.BOOLEAN, description = "List network offerings by enabled state")
private Boolean enabled;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/router/RebootRouterCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/router/RebootRouterCmd.java
index 1d97dd80309..36ffdcb42d0 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/router/RebootRouterCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/router/RebootRouterCmd.java
@@ -43,7 +43,7 @@ public class RebootRouterCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = DomainRouterResponse.class, required = true, description = "the ID of the router")
+ @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 reboot the router (Router is force Stopped and then Started)", since = "4.16.0")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/router/StartRouterCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/router/StartRouterCmd.java
index 24ab7881037..65849be0d68 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/router/StartRouterCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/router/StartRouterCmd.java
@@ -45,7 +45,7 @@ public class StartRouterCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = DomainRouterResponse.class, required = true, description = "the ID of the router")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = DomainRouterResponse.class, required = true, description = "The ID of the router")
private Long id;
/////////////////////////////////////////////////////
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 971086a57cf..775ffcb4d38 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
@@ -44,10 +44,10 @@ public class StopRouterCmd extends BaseAsyncCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = DomainRouterResponse.class, required = true, description = "the ID of the router")
+ @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 (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.")
+ @Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN, required = false, description = "Force stop the Instance (Instance 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 Instance 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/UpgradeRouterCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/router/UpgradeRouterCmd.java
index 3265a089d67..1428ecbaeca 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/router/UpgradeRouterCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/router/UpgradeRouterCmd.java
@@ -45,7 +45,7 @@ public class UpgradeRouterCmd extends BaseCmd {
type = CommandType.UUID,
entityType = ServiceOfferingResponse.class,
required = true,
- description = "the service offering ID to apply to the domain router")
+ description = "The service offering ID to apply to the domain router")
private Long serviceOfferingId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/router/UpgradeRouterTemplateCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/router/UpgradeRouterTemplateCmd.java
index 74464cab315..1bbc3a141db 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/router/UpgradeRouterTemplateCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/router/UpgradeRouterTemplateCmd.java
@@ -39,7 +39,7 @@ import com.cloud.exception.InsufficientCapacityException;
import com.cloud.exception.ResourceUnavailableException;
import com.cloud.user.Account;
-@APICommand(name = "upgradeRouterTemplate", description = "Upgrades router to use newer template", responseObject = BaseResponse.class,
+@APICommand(name = "upgradeRouterTemplate", description = "Upgrades router to use newer Template", responseObject = BaseResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class UpgradeRouterTemplateCmd extends org.apache.cloudstack.api.BaseCmd {
@@ -47,29 +47,29 @@ public class UpgradeRouterTemplateCmd extends org.apache.cloudstack.api.BaseCmd
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = DomainRouterResponse.class, description = "upgrades router with the specified Id")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = DomainRouterResponse.class, description = "Upgrades router with the specified Id")
private Long id;
@Parameter(name = ApiConstants.CLUSTER_ID,
type = CommandType.UUID,
entityType = ClusterResponse.class,
- description = "upgrades all routers within the specified cluster")
+ description = "Upgrades all routers within the specified cluster")
private Long clusterId;
- @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "upgrades all routers within the specified pod")
+ @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "Upgrades all routers within the specified Pod")
private Long podId;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "upgrades all routers within the specified zone")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "Upgrades all routers within the specified zone")
private Long zoneId;
@Parameter(name=ApiConstants.ACCOUNT, type=CommandType.STRING,
- description="upgrades all routers owned by the specified account")
+ description = "Upgrades all routers owned by the specified account")
private String account;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "upgrades all routers owned by the specified domain")
+ description = "Upgrades all routers owned by the specified domain")
private Long domainId;
/////////////////////////////////////////////////////
@@ -119,14 +119,14 @@ public class UpgradeRouterTemplateCmd extends org.apache.cloudstack.api.BaseCmd
@Override
public void execute() throws ConcurrentOperationException, ResourceUnavailableException, InsufficientCapacityException {
- CallContext.current().setEventDetails("Upgrading router template");
+ CallContext.current().setEventDetails("Upgrading router Template");
List result = _routerService.upgradeRouterTemplate(this);
if (result != null) {
ListResponse response = _responseGenerator.createUpgradeRouterTemplateResponse(result);
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to upgrade router template");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to upgrade router Template");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/AddImageStoreCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/AddImageStoreCmd.java
index 7c8f0e21afb..72e2e96fe57 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/AddImageStoreCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/AddImageStoreCmd.java
@@ -43,21 +43,21 @@ public class AddImageStoreCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name for the image store")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name for the image store")
private String name;
- @Parameter(name = ApiConstants.URL, type = CommandType.STRING, length = 2048, description = "the URL for the image store")
+ @Parameter(name = ApiConstants.URL, type = CommandType.STRING, length = 2048, description = "The URL for the image store")
private String url;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "the Zone ID for the image store")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "The Zone ID for the image store")
private Long zoneId;
- @Parameter(name = ApiConstants.PROVIDER, type = CommandType.STRING, required = true, description = "the image store provider name")
+ @Parameter(name = ApiConstants.PROVIDER, type = CommandType.STRING, required = true, description = "The image store provider name")
private String providerName;
@Parameter(name = ApiConstants.DETAILS,
type = CommandType.MAP,
- description = "the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss")
+ description = "The details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss")
private Map details;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/CancelPrimaryStorageMaintenanceCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/CancelPrimaryStorageMaintenanceCmd.java
index 7e925f286d0..35f7b19f709 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/CancelPrimaryStorageMaintenanceCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/CancelPrimaryStorageMaintenanceCmd.java
@@ -42,7 +42,7 @@ public class CancelPrimaryStorageMaintenanceCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = StoragePoolResponse.class, required = true, description = "the primary storage ID")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = StoragePoolResponse.class, required = true, description = "The primary storage ID")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/CreateSecondaryStagingStoreCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/CreateSecondaryStagingStoreCmd.java
index 5776eb6464c..e197e9f94f1 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/CreateSecondaryStagingStoreCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/CreateSecondaryStagingStoreCmd.java
@@ -34,7 +34,7 @@ import org.apache.cloudstack.api.response.ZoneResponse;
import com.cloud.storage.ImageStore;
import com.cloud.user.Account;
-@APICommand(name = "createSecondaryStagingStore", description = "create secondary staging store.", responseObject = ImageStoreResponse.class,
+@APICommand(name = "createSecondaryStagingStore", description = "Create secondary staging store.", responseObject = ImageStoreResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class CreateSecondaryStagingStoreCmd extends BaseCmd {
@@ -42,19 +42,19 @@ public class CreateSecondaryStagingStoreCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.URL, type = CommandType.STRING, required = true, length = 2048, description = "the URL for the staging store")
+ @Parameter(name = ApiConstants.URL, type = CommandType.STRING, required = true, length = 2048, description = "The URL for the staging store")
private String url;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "the Zone ID for the staging store")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "The Zone ID for the staging store")
private Long zoneId;
- @Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "the details for the staging store")
+ @Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "The details for the staging store")
private Map> details;
- @Parameter(name = ApiConstants.SCOPE, type = CommandType.STRING, required = false, description = "the scope of the staging store: zone only for now")
+ @Parameter(name = ApiConstants.SCOPE, type = CommandType.STRING, required = false, description = "The scope of the staging store: zone only for now")
private String scope;
- @Parameter(name = ApiConstants.PROVIDER, type = CommandType.STRING, required = false, description = "the staging store provider name")
+ @Parameter(name = ApiConstants.PROVIDER, type = CommandType.STRING, required = false, description = "The staging store provider name")
private String providerName;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/CreateStoragePoolCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/CreateStoragePoolCmd.java
index 75813a7aabf..0ac997d56e7 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/CreateStoragePoolCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/CreateStoragePoolCmd.java
@@ -46,46 +46,46 @@ public class CreateStoragePoolCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.CLUSTER_ID, type = CommandType.UUID, entityType = ClusterResponse.class, description = "the cluster ID for the storage pool")
+ @Parameter(name = ApiConstants.CLUSTER_ID, type = CommandType.UUID, entityType = ClusterResponse.class, description = "The cluster ID for the storage pool")
private Long clusterId;
- @Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "the details for the storage pool")
+ @Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "The details for the storage pool")
private Map details;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "the name for the storage pool")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "The name for the storage pool")
private String storagePoolName;
- @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "the Pod ID for the storage pool")
+ @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "The Pod ID for the storage pool")
private Long podId;
- @Parameter(name = ApiConstants.TAGS, type = CommandType.STRING, description = "the tags for the storage pool")
+ @Parameter(name = ApiConstants.TAGS, type = CommandType.STRING, description = "The tags for the storage pool")
private String tags;
- @Parameter(name = ApiConstants.URL, type = CommandType.STRING, required = true, description = "the URL of the storage pool")
+ @Parameter(name = ApiConstants.URL, type = CommandType.STRING, required = true, description = "The URL of the storage pool")
private String url;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, required = true, description = "the Zone ID for the storage pool")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, required = true, description = "The Zone ID for the storage pool")
private Long zoneId;
- @Parameter(name = ApiConstants.PROVIDER, type = CommandType.STRING, required = false, description = "the storage provider name")
+ @Parameter(name = ApiConstants.PROVIDER, type = CommandType.STRING, required = false, description = "The storage provider name")
private String storageProviderName;
- @Parameter(name = ApiConstants.SCOPE, type = CommandType.STRING, required = false, description = "the scope of the storage: cluster or zone")
+ @Parameter(name = ApiConstants.SCOPE, type = CommandType.STRING, required = false, description = "The scope of the storage: cluster or zone")
private String scope;
- @Parameter(name = ApiConstants.MANAGED, type = CommandType.BOOLEAN, required = false, description = "whether the storage should be managed by CloudStack")
+ @Parameter(name = ApiConstants.MANAGED, type = CommandType.BOOLEAN, required = false, description = "Whether the storage should be managed by CloudStack")
private Boolean managed;
@Parameter(name = ApiConstants.CAPACITY_IOPS, type = CommandType.LONG, required = false, description = "IOPS CloudStack can provision from this storage pool")
private Long capacityIops;
- @Parameter(name = ApiConstants.CAPACITY_BYTES, type = CommandType.LONG, required = false, description = "bytes CloudStack can provision from this storage pool")
+ @Parameter(name = ApiConstants.CAPACITY_BYTES, type = CommandType.LONG, required = false, description = "Bytes CloudStack can provision from this storage pool")
private Long capacityBytes;
@Parameter(name = ApiConstants.HYPERVISOR,
type = CommandType.STRING,
required = false,
- description = "hypervisor type of the hosts in zone that will be attached to this storage pool. KVM, VMware supported as of now.")
+ description = "Hypervisor type of the hosts in zone that will be attached to this storage pool. KVM, VMware supported as of now.")
private String hypervisor;
@Parameter(name = ApiConstants.IS_TAG_A_RULE, type = CommandType.BOOLEAN, description = ApiConstants.PARAMETER_DESCRIPTION_IS_TAG_A_RULE)
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/DeleteSecondaryStagingStoreCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/DeleteSecondaryStagingStoreCmd.java
index a0c2731ccda..68d9f37df3f 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/DeleteSecondaryStagingStoreCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/DeleteSecondaryStagingStoreCmd.java
@@ -37,7 +37,7 @@ public class DeleteSecondaryStagingStoreCmd extends BaseCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ImageStoreResponse.class, required = true, description = "the staging store ID")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ImageStoreResponse.class, required = true, description = "The staging store ID")
private Long id;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/FindStoragePoolsForMigrationCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/FindStoragePoolsForMigrationCmd.java
index a45f72766dc..7f5e864ed91 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/FindStoragePoolsForMigrationCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/FindStoragePoolsForMigrationCmd.java
@@ -43,7 +43,7 @@ public class FindStoragePoolsForMigrationCmd extends BaseListCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VolumeResponse.class, required = true, description = "the ID of the volume")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VolumeResponse.class, required = true, description = "The ID of the volume")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/ListImageStoresCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/ListImageStoresCmd.java
index 5270569de44..62d460c354c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/ListImageStoresCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/ListImageStoresCmd.java
@@ -33,22 +33,22 @@ public class ListImageStoresCmd extends BaseListCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the image store")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the image store")
private String storeName;
- @Parameter(name = ApiConstants.PROTOCOL, type = CommandType.STRING, description = "the image store protocol")
+ @Parameter(name = ApiConstants.PROTOCOL, type = CommandType.STRING, description = "The image store protocol")
private String protocol;
- @Parameter(name = ApiConstants.PROVIDER, type = CommandType.STRING, description = "the image store provider")
+ @Parameter(name = ApiConstants.PROVIDER, type = CommandType.STRING, description = "The image store provider")
private String provider;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "the Zone ID for the image store")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "The Zone ID for the image store")
private Long zoneId;
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ImageStoreResponse.class, description = "the ID of the storage pool")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ImageStoreResponse.class, description = "The ID of the storage pool")
private Long id;
- @Parameter(name = ApiConstants.READ_ONLY, type = CommandType.BOOLEAN, entityType = ImageStoreResponse.class, description = "read-only status of the image store", since = "4.15.0")
+ @Parameter(name = ApiConstants.READ_ONLY, type = CommandType.BOOLEAN, entityType = ImageStoreResponse.class, description = "Read-only status of the image store", since = "4.15.0")
private Boolean readonly;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/ListSecondaryStagingStoresCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/ListSecondaryStagingStoresCmd.java
index 0cad16a247f..31cd3519c5b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/ListSecondaryStagingStoresCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/ListSecondaryStagingStoresCmd.java
@@ -35,19 +35,19 @@ public class ListSecondaryStagingStoresCmd extends BaseListCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the staging store")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the staging store")
private String storeName;
- @Parameter(name = ApiConstants.PROTOCOL, type = CommandType.STRING, description = "the staging store protocol")
+ @Parameter(name = ApiConstants.PROTOCOL, type = CommandType.STRING, description = "The staging store protocol")
private String protocol;
- @Parameter(name = ApiConstants.PROVIDER, type = CommandType.STRING, description = "the staging store provider")
+ @Parameter(name = ApiConstants.PROVIDER, type = CommandType.STRING, description = "The staging store provider")
private String provider;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "the Zone ID for the staging store")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "The Zone ID for the staging store")
private Long zoneId;
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ImageStoreResponse.class, description = "the ID of the staging store")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ImageStoreResponse.class, description = "The ID of the staging store")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/ListStoragePoolsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/ListStoragePoolsCmd.java
index 57a87939b6b..47bedc22d73 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/ListStoragePoolsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/ListStoragePoolsCmd.java
@@ -41,32 +41,32 @@ public class ListStoragePoolsCmd extends BaseListCmd {
@Parameter(name = ApiConstants.CLUSTER_ID,
type = CommandType.UUID,
entityType = ClusterResponse.class,
- description = "list storage pools belongig to the specific cluster")
+ description = "List storage pools belonging to the specific cluster")
private Long clusterId;
- @Parameter(name = ApiConstants.IP_ADDRESS, type = CommandType.STRING, description = "the IP address for the storage pool")
+ @Parameter(name = ApiConstants.IP_ADDRESS, type = CommandType.STRING, description = "The IP address for the storage pool")
private String ipAddress;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the storage pool")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the storage pool")
private String storagePoolName;
- @Parameter(name = ApiConstants.PATH, type = CommandType.STRING, description = "the storage pool path")
+ @Parameter(name = ApiConstants.PATH, type = CommandType.STRING, description = "The storage pool path")
private String path;
- @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "the Pod ID for the storage pool")
+ @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "The Pod ID for the storage pool")
private Long podId;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "the Zone ID for the storage pool")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "The Zone ID for the storage pool")
private Long zoneId;
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = StoragePoolResponse.class, description = "the ID of the storage pool")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = StoragePoolResponse.class, description = "The ID of the storage pool")
private Long id;
- @Parameter(name = ApiConstants.SCOPE, type = CommandType.STRING, entityType = StoragePoolResponse.class, description = "the scope of the storage pool")
+ @Parameter(name = ApiConstants.SCOPE, type = CommandType.STRING, entityType = StoragePoolResponse.class, description = "The scope of the storage pool")
private String scope;
- @Parameter(name = ApiConstants.STATUS, type = CommandType.STRING, description = "the status of the storage pool")
+ @Parameter(name = ApiConstants.STATUS, type = CommandType.STRING, description = "The status of the storage pool")
private String status;
@Parameter(name = ApiConstants.HOST_ID, type = CommandType.UUID, entityType = HostResponse.class, description = "host ID of the storage pools")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/ListStorageProvidersCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/ListStorageProvidersCmd.java
index efe7a23b5cb..f7d4c107835 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/ListStorageProvidersCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/ListStorageProvidersCmd.java
@@ -40,7 +40,7 @@ import com.cloud.exception.ResourceUnavailableException;
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListStorageProvidersCmd extends BaseListCmd {
- @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, description = "the type of storage provider: either primary or image", required = true)
+ @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, description = "The type of storage provider: either primary or image", required = true)
private String type;
public String getType() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/MigrateSecondaryStorageDataCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/MigrateSecondaryStorageDataCmd.java
index 8f5a7aced3f..edd9c25fbc1 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/MigrateSecondaryStorageDataCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/MigrateSecondaryStorageDataCmd.java
@@ -32,7 +32,7 @@ import org.apache.cloudstack.context.CallContext;
import com.cloud.event.EventTypes;
@APICommand(name = "migrateSecondaryStorageData",
- description = "migrates data objects from one secondary storage to destination image store(s)",
+ description = "Migrates data objects from one secondary storage to destination image store(s)",
responseObject = MigrationResponse.class,
requestHasSensitiveInfo = false,
responseHasSensitiveInfo = false,
@@ -49,7 +49,7 @@ public class MigrateSecondaryStorageDataCmd extends BaseAsyncCmd {
@Parameter(name = ApiConstants.SRC_POOL,
type = CommandType.UUID,
entityType = ImageStoreResponse.class,
- description = "id of the image store from where the data is to be migrated",
+ description = "ID of the image store from where the data is to be migrated",
required = true)
private Long id;
@@ -57,7 +57,7 @@ public class MigrateSecondaryStorageDataCmd extends BaseAsyncCmd {
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = ImageStoreResponse.class,
- description = "id(s) of the destination secondary storage pool(s) to which the templates are to be migrated",
+ description = "ID(s) of the destination secondary storage pool(s) to which the Templates are to be migrated",
required = true)
private List migrateTo;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/UpdateCloudToUseObjectStoreCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/UpdateCloudToUseObjectStoreCmd.java
index 5ac34f27bad..022bbb9a905 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/UpdateCloudToUseObjectStoreCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/UpdateCloudToUseObjectStoreCmd.java
@@ -42,17 +42,17 @@ public class UpdateCloudToUseObjectStoreCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name=ApiConstants.NAME, type=CommandType.STRING, description="the name for the image store")
+ @Parameter(name=ApiConstants.NAME, type=CommandType.STRING, description = "The name for the image store")
private String name;
- @Parameter(name=ApiConstants.URL, type=CommandType.STRING, description="the URL for the image store")
+ @Parameter(name=ApiConstants.URL, type=CommandType.STRING, description = "The URL for the image store")
private String url;
@Parameter(name=ApiConstants.PROVIDER, type=CommandType.STRING,
- required=true, description="the image store provider name")
+ required=true, description = "The image store provider name")
private String providerName;
- @Parameter(name=ApiConstants.DETAILS, type=CommandType.MAP, description="the details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss")
+ @Parameter(name=ApiConstants.DETAILS, type=CommandType.MAP, description = "The details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss")
private Map details;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/UpdateStoragePoolCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/UpdateStoragePoolCmd.java
index f2d7bbeb189..4b0a6ba00b2 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/UpdateStoragePoolCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/storage/UpdateStoragePoolCmd.java
@@ -44,22 +44,22 @@ public class UpdateStoragePoolCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = StoragePoolResponse.class, required = true, description = "the Id of the storage pool")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = StoragePoolResponse.class, required = true, description = "The Id of the storage pool")
private Long id;
@Parameter(name = ApiConstants.NAME, type = CommandType.STRING, entityType = StoragePoolResponse.class, description = "Change the name of the storage pool", since = "4.15")
private String name;
- @Parameter(name = ApiConstants.TAGS, type = CommandType.LIST, collectionType = CommandType.STRING, description = "comma-separated list of tags for the storage pool")
+ @Parameter(name = ApiConstants.TAGS, type = CommandType.LIST, collectionType = CommandType.STRING, description = "Comma-separated list of tags for the storage pool")
private List tags;
@Parameter(name = ApiConstants.CAPACITY_IOPS, type = CommandType.LONG, required = false, description = "IOPS CloudStack can provision from this storage pool")
private Long capacityIops;
- @Parameter(name = ApiConstants.CAPACITY_BYTES, type = CommandType.LONG, required = false, description = "bytes CloudStack can provision from this storage pool")
+ @Parameter(name = ApiConstants.CAPACITY_BYTES, type = CommandType.LONG, required = false, description = "Bytes CloudStack can provision from this storage pool")
private Long capacityBytes;
- @Parameter(name = ApiConstants.ENABLED, type = CommandType.BOOLEAN, required = false, description = "false to disable the pool for allocation of new volumes, true to" +
+ @Parameter(name = ApiConstants.ENABLED, type = CommandType.BOOLEAN, required = false, description = "False to disable the pool for allocation of new volumes, true to" +
" enable it back.")
private Boolean enabled;
@@ -153,6 +153,8 @@ public class UpdateStoragePoolCmd extends BaseCmd {
if (ObjectUtils.anyNotNull(name, capacityIops, capacityBytes, url, isTagARule, tags) ||
MapUtils.isNotEmpty(details)) {
result = _storageService.updateStoragePool(this);
+ } else {
+ result = _storageService.getStoragePool(getId());
}
if (enabled != null) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/swift/AddSwiftCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/swift/AddSwiftCmd.java
index bd72f3213de..cc0c77348a9 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/swift/AddSwiftCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/swift/AddSwiftCmd.java
@@ -40,13 +40,13 @@ public class AddSwiftCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.URL, type = CommandType.STRING, required = true, description = "the URL for swift")
+ @Parameter(name = ApiConstants.URL, type = CommandType.STRING, required = true, description = "The URL for swift")
private String url;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "the account for swift")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "The account for swift")
private String account;
- @Parameter(name = ApiConstants.USERNAME, type = CommandType.STRING, description = "the username for swift")
+ @Parameter(name = ApiConstants.USERNAME, type = CommandType.STRING, description = "The username for swift")
private String username;
@Parameter(name = ApiConstants.KEY, type = CommandType.STRING, description = " key for the user for swift")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/swift/ListSwiftsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/swift/ListSwiftsCmd.java
index e21a23349bb..6645cd60023 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/swift/ListSwiftsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/swift/ListSwiftsCmd.java
@@ -35,7 +35,7 @@ public class ListSwiftsCmd extends BaseListCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.LONG, description = "the id of the swift")
+ @Parameter(name = ApiConstants.ID, type = CommandType.LONG, description = "The id of the swift")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/DestroySystemVmCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/DestroySystemVmCmd.java
index 7e0faab2fb5..3a7e1caa4dc 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/DestroySystemVmCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/DestroySystemVmCmd.java
@@ -33,7 +33,7 @@ import com.cloud.event.EventTypes;
import com.cloud.user.Account;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "destroySystemVm", responseObject = SystemVmResponse.class, description = "Destroys a system virtual machine.", entityType = {VirtualMachine.class},
+@APICommand(name = "destroySystemVm", responseObject = SystemVmResponse.class, description = "Destroys a System VM.", entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class DestroySystemVmCmd extends BaseAsyncCmd {
@@ -43,7 +43,7 @@ public class DestroySystemVmCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = SystemVmResponse.class,
required = true,
- description = "The ID of the system virtual machine")
+ description = "The ID of the System VM")
private Long id;
public Long getId() {
@@ -76,7 +76,7 @@ public class DestroySystemVmCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "destroying system vm: " + this._uuidMgr.getUuid(VirtualMachine.class, getId());
+ return "Destroying system Instance: " + this._uuidMgr.getUuid(VirtualMachine.class, getId());
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/ListSystemVMsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/ListSystemVMsCmd.java
index 13113e17ea4..d339df85016 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/ListSystemVMsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/ListSystemVMsCmd.java
@@ -36,7 +36,7 @@ import com.cloud.cpu.CPU;
import com.cloud.utils.Pair;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "listSystemVms", description = "List system virtual machines.", responseObject = SystemVmResponse.class, entityType = {VirtualMachine.class},
+@APICommand(name = "listSystemVms", description = "List System VMs.", responseObject = SystemVmResponse.class, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListSystemVMsCmd extends BaseListCmd {
@@ -45,33 +45,33 @@ public class ListSystemVMsCmd extends BaseListCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.HOST_ID, type = CommandType.UUID, entityType = HostResponse.class, description = "the host ID of the system VM")
+ @Parameter(name = ApiConstants.HOST_ID, type = CommandType.UUID, entityType = HostResponse.class, description = "The host ID of the system VM")
private Long hostId;
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = SystemVmResponse.class, description = "the ID of the system VM")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = SystemVmResponse.class, description = "The ID of the system VM")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the system VM")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the system VM")
private String systemVmName;
- @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "the Pod ID of the system VM")
+ @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "The Pod ID of the system VM")
private Long podId;
- @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "the state of the system VM")
+ @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "The state of the system VM")
private String state;
@Parameter(name = ApiConstants.SYSTEM_VM_TYPE,
type = CommandType.STRING,
- description = "the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".")
+ description = "The system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".")
private String systemVmType;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "the Zone ID of the system VM")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "The Zone ID of the system VM")
private Long zoneId;
@Parameter(name = ApiConstants.STORAGE_ID,
type = CommandType.UUID,
entityType = StoragePoolResponse.class,
- description = "the storage ID where vm's volumes belong to",
+ description = "The storage ID where Instance's volumes belong to",
since = "3.0.1")
private Long storageId;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/MigrateSystemVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/MigrateSystemVMCmd.java
index ccc6093aa83..8319883ec44 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/MigrateSystemVMCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/MigrateSystemVMCmd.java
@@ -43,7 +43,7 @@ import com.cloud.storage.StoragePool;
import com.cloud.user.Account;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "migrateSystemVm", description = "Attempts Migration of a system virtual machine to the host specified.", responseObject = SystemVmResponse.class, entityType = {VirtualMachine.class},
+@APICommand(name = "migrateSystemVm", description = "Attempts Migration of a System VM to the host specified.", responseObject = SystemVmResponse.class, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class MigrateSystemVMCmd extends BaseAsyncCmd {
@@ -55,7 +55,7 @@ public class MigrateSystemVMCmd extends BaseAsyncCmd {
@Parameter(name = ApiConstants.HOST_ID,
type = CommandType.UUID,
entityType = HostResponse.class,
- description = "destination Host ID to migrate VM to")
+ description = "Destination Host ID to migrate Instance to")
private Long hostId;
@ACL(accessType = AccessType.OperateEntry)
@@ -63,14 +63,14 @@ public class MigrateSystemVMCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = SystemVmResponse.class,
required = true,
- description = "the ID of the virtual machine")
+ description = "The ID of the Instance")
private Long virtualMachineId;
@Parameter(name = ApiConstants.STORAGE_ID,
since = "4.16.0",
type = CommandType.UUID,
entityType = StoragePoolResponse.class,
- description = "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume")
+ description = "Destination storage pool ID to migrate Instance volumes to. Required for migrating the root disk volume")
private Long storageId;
@Parameter(name = ApiConstants.AUTO_SELECT,
@@ -120,7 +120,7 @@ public class MigrateSystemVMCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "Attempting to migrate VM Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getVirtualMachineId()) + " to host Id: " + this._uuidMgr.getUuid(Host.class, getHostId());
+ return "Attempting to migrate Instance Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getVirtualMachineId()) + " to host Id: " + this._uuidMgr.getUuid(Host.class, getHostId());
}
@Override
@@ -136,7 +136,7 @@ public class MigrateSystemVMCmd extends BaseAsyncCmd {
// OfflineMigration performed when this parameter is specified
StoragePool destStoragePool = _storageService.getStoragePool(getStorageId());
if (destStoragePool == null) {
- throw new InvalidParameterValueException("Unable to find the storage pool to migrate the VM");
+ throw new InvalidParameterValueException("Unable to find the storage pool to migrate the Instance");
}
CallContext.current().setEventDetails("VM Id: " + getVirtualMachineId() + " to storage pool Id: " + getStorageId());
migratedVm = _userVmService.vmStorageMigration(getVirtualMachineId(), destStoragePool);
@@ -145,10 +145,10 @@ public class MigrateSystemVMCmd extends BaseAsyncCmd {
if (getHostId() != null) {
destinationHost =_resourceService.getHost(getHostId());
if (destinationHost == null) {
- throw new InvalidParameterValueException("Unable to find the host to migrate the VM, host id=" + getHostId());
+ throw new InvalidParameterValueException("Unable to find the host to migrate the Instance, host id=" + getHostId());
}
if (destinationHost.getType() != Host.Type.Routing) {
- throw new InvalidParameterValueException("The specified host(" + destinationHost.getName() + ") is not suitable to migrate the VM, please specify another one");
+ throw new InvalidParameterValueException("The specified host(" + destinationHost.getName() + ") is not suitable to migrate the Instance, please specify another one");
}
} else if (! isAutoSelect()) {
throw new InvalidParameterValueException("Please specify a host or storage as destination, or pass 'autoselect=true' to automatically select a destination host which do not require storage migration");
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/PatchSystemVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/PatchSystemVMCmd.java
index 4f4b2631667..28560789a83 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/PatchSystemVMCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/PatchSystemVMCmd.java
@@ -40,7 +40,7 @@ public class PatchSystemVMCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = SystemVmResponse.class,
- description = "patches systemVM - CPVM/SSVM with the specified ID")
+ description = "Patches System VM - CPVM/SSVM with the specified ID")
private Long id;
@Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/RebootSystemVmCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/RebootSystemVmCmd.java
index 30bd51184ac..81affc71452 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/RebootSystemVmCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/RebootSystemVmCmd.java
@@ -46,10 +46,10 @@ public class RebootSystemVmCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = SystemVmResponse.class,
required = true,
- description = "The ID of the system virtual machine")
+ description = "The ID of the System VM")
private Long id;
- @Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN, required = false, description = "Force reboot the system VM (System VM is Stopped and then Started)", since = "4.16.0")
+ @Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN, required = false, description = "Force reboot the System VM (System VM is Stopped and then Started)", since = "4.16.0")
private Boolean forced;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/ScaleSystemVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/ScaleSystemVMCmd.java
index 06e57674c53..eaf927ae0f7 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/ScaleSystemVMCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/ScaleSystemVMCmd.java
@@ -55,10 +55,10 @@ public class ScaleSystemVMCmd extends BaseAsyncCmd {
@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = SystemVmResponse.class, required = true, description = "The ID of the system vm")
private Long id;
- @Parameter(name = ApiConstants.SERVICE_OFFERING_ID, type = CommandType.UUID, entityType = ServiceOfferingResponse.class, required = true, description = "the service offering ID to apply to the system vm")
+ @Parameter(name = ApiConstants.SERVICE_OFFERING_ID, type = CommandType.UUID, entityType = ServiceOfferingResponse.class, required = true, description = "The service offering ID to apply to the system vm")
private Long serviceOfferingId;
- @Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value")
+ @Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "Name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value")
private Map details;
/////////////////////////////////////////////////////
@@ -74,7 +74,7 @@ public class ScaleSystemVMCmd extends BaseAsyncCmd {
}
public Map getDetails() {
- return details;
+ return convertDetailsToMap(details);
}
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/StartSystemVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/StartSystemVMCmd.java
index eac3d64ab59..bfb6a240a62 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/StartSystemVMCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/StartSystemVMCmd.java
@@ -33,7 +33,7 @@ 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},
+@APICommand(name = "startSystemVm", responseObject = SystemVmResponse.class, description = "Starts a System VM.", entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class StartSystemVMCmd extends BaseAsyncCmd {
@@ -46,7 +46,7 @@ public class StartSystemVMCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = SystemVmResponse.class,
required = true,
- description = "The ID of the system virtual machine")
+ description = "The ID of the System VM")
private Long id;
/////////////////////////////////////////////////////
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 1d84382f5d2..e86b6a28121 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
@@ -49,10 +49,10 @@ public class StopSystemVmCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = SystemVmResponse.class,
required = true,
- description = "The ID of the system virtual machine")
+ description = "The ID of the System VM")
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). To be used if the caller knows the VM is stopped and should be marked as such.")
+ @Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN, required = false, description = "Force stop the Instance (Instance 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 Instance is stopped and should be marked as such.")
private Boolean forced;
/////////////////////////////////////////////////////
@@ -89,7 +89,7 @@ public class StopSystemVmCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "stopping system vm: " + this._uuidMgr.getUuid(VirtualMachine.class, getId());
+ return "Stopping system vm: " + this._uuidMgr.getUuid(VirtualMachine.class, getId());
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/UpgradeSystemVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/UpgradeSystemVMCmd.java
index 5abe90e3f58..4567c25a0d1 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/UpgradeSystemVMCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/systemvm/UpgradeSystemVMCmd.java
@@ -46,13 +46,13 @@ public class UpgradeSystemVMCmd extends BaseCmd {
/////////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = SystemVmResponse.class, required = true, description = "The ID of the system vm")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = SystemVmResponse.class, required = true, description = "The ID of the System VM")
private Long id;
- @Parameter(name = ApiConstants.SERVICE_OFFERING_ID, type = CommandType.UUID, entityType = ServiceOfferingResponse.class, required = true, description = "the service offering ID to apply to the system vm")
+ @Parameter(name = ApiConstants.SERVICE_OFFERING_ID, type = CommandType.UUID, entityType = ServiceOfferingResponse.class, required = true, description = "The service offering ID to apply to the System VM")
private Long serviceOfferingId;
- @Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value")
+ @Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "Name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value")
private Map details;
/////////////////////////////////////////////////////
@@ -68,7 +68,7 @@ public class UpgradeSystemVMCmd extends BaseCmd {
}
public Map getDetails() {
- return details;
+ return convertDetailsToMap(details);
}
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/template/CopyTemplateCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/template/CopyTemplateCmdByAdmin.java
index b937e0b940c..8e2854db308 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/template/CopyTemplateCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/template/CopyTemplateCmdByAdmin.java
@@ -21,6 +21,6 @@ import org.apache.cloudstack.api.ResponseObject.ResponseView;
import org.apache.cloudstack.api.command.user.template.CopyTemplateCmd;
import org.apache.cloudstack.api.response.TemplateResponse;
-@APICommand(name = "copyTemplate", description = "Copies a template from one zone to another.", responseObject = TemplateResponse.class, responseView = ResponseView.Full,
+@APICommand(name = "copyTemplate", description = "Copies a Template from one zone to another.", responseObject = TemplateResponse.class, responseView = ResponseView.Full,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class CopyTemplateCmdByAdmin extends CopyTemplateCmd {}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/template/CreateTemplateCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/template/CreateTemplateCmdByAdmin.java
index 12609493b63..18a17c861ad 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/template/CreateTemplateCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/template/CreateTemplateCmdByAdmin.java
@@ -22,7 +22,7 @@ import org.apache.cloudstack.api.command.admin.AdminCmd;
import org.apache.cloudstack.api.command.user.template.CreateTemplateCmd;
import org.apache.cloudstack.api.response.TemplateResponse;
-@APICommand(name = "createTemplate", responseObject = TemplateResponse.class, description = "Creates a template of a virtual machine. " + "The virtual machine must be in a STOPPED state. "
- + "A template created from this command is automatically designated as a private template visible to the account that created it.", responseView = ResponseView.Full,
+@APICommand(name = "createTemplate", responseObject = TemplateResponse.class, description = "Creates a Template of an Instance. " + "The Instance must be in a STOPPED state. "
+ + "A Template created from this command is automatically designated as a private Template visible to the account that created it.", responseView = ResponseView.Full,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class CreateTemplateCmdByAdmin extends CreateTemplateCmd implements AdminCmd {}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/template/ListTemplatePermissionsCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/template/ListTemplatePermissionsCmdByAdmin.java
index ae0e220b495..a68958a64b1 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/template/ListTemplatePermissionsCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/template/ListTemplatePermissionsCmdByAdmin.java
@@ -22,7 +22,7 @@ import org.apache.cloudstack.api.command.admin.AdminCmd;
import org.apache.cloudstack.api.command.user.template.ListTemplatePermissionsCmd;
import org.apache.cloudstack.api.response.TemplatePermissionsResponse;
-@APICommand(name = "listTemplatePermissions", description = "List template visibility and all accounts that have permissions to view this template.", responseObject = TemplatePermissionsResponse.class, responseView = ResponseView.Full,
+@APICommand(name = "listTemplatePermissions", description = "List Template visibility and all accounts that have permissions to view this Template.", responseObject = TemplatePermissionsResponse.class, responseView = ResponseView.Full,
requestHasSensitiveInfo = false,
responseHasSensitiveInfo = false)
public class ListTemplatePermissionsCmdByAdmin extends ListTemplatePermissionsCmd implements AdminCmd {}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/template/ListTemplatesCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/template/ListTemplatesCmdByAdmin.java
index 22eb0ff0659..54c0c8f702d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/template/ListTemplatesCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/template/ListTemplatesCmdByAdmin.java
@@ -28,7 +28,7 @@ import org.apache.cloudstack.api.response.TemplateResponse;
import com.cloud.template.VirtualMachineTemplate;
-@APICommand(name = "listTemplates", description = "List all public, private, and privileged templates.",
+@APICommand(name = "listTemplates", description = "List all public, private, and privileged Templates.",
responseObject = TemplateResponse.class, entityType = {VirtualMachineTemplate.class},
responseView = ResponseView.Full, requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListTemplatesCmdByAdmin extends ListTemplatesCmd implements AdminCmd {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/template/PrepareTemplateCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/template/PrepareTemplateCmd.java
index 9a59efb19f2..136522d6bf8 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/template/PrepareTemplateCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/template/PrepareTemplateCmd.java
@@ -34,7 +34,7 @@ import org.apache.cloudstack.api.response.ZoneResponse;
import com.cloud.template.VirtualMachineTemplate;
import com.cloud.user.Account;
-@APICommand(name = "prepareTemplate", responseObject = TemplateResponse.class, description = "load template into primary storage", entityType = {VirtualMachineTemplate.class},
+@APICommand(name = "prepareTemplate", responseObject = TemplateResponse.class, description = "Load Template into primary storage", entityType = {VirtualMachineTemplate.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class PrepareTemplateCmd extends BaseCmd {
@@ -47,7 +47,7 @@ public class PrepareTemplateCmd extends BaseCmd {
type = CommandType.UUID,
entityType = ZoneResponse.class,
required = true,
- description = "zone ID of the template to be prepared in primary storage(s).")
+ description = "Zone ID of the Template to be prepared in primary storage(s).")
private Long zoneId;
@ACL(accessType = AccessType.OperateEntry)
@@ -55,7 +55,7 @@ public class PrepareTemplateCmd extends BaseCmd {
type = CommandType.UUID,
entityType = TemplateResponse.class,
required = true,
- description = "template ID of the template to be prepared in primary storage(s).")
+ description = "Template ID of the Template to be prepared in primary storage(s).")
private Long templateId;
@ACL(accessType = AccessType.OperateEntry)
@@ -63,7 +63,7 @@ public class PrepareTemplateCmd extends BaseCmd {
type = CommandType.UUID,
entityType = StoragePoolResponse.class,
required = false,
- description = "storage pool ID of the primary storage pool to which the template should be prepared. If it is not provided the template" +
+ description = "Storage pool ID of the primary storage pool to which the Template should be prepared. If it is not provided the Template" +
" is prepared on all the available primary storage pools.")
private Long storageId;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/template/RegisterTemplateCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/template/RegisterTemplateCmdByAdmin.java
index 91c0dd50e8e..3eeb9ba7c73 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/template/RegisterTemplateCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/template/RegisterTemplateCmdByAdmin.java
@@ -22,7 +22,7 @@ import org.apache.cloudstack.api.command.admin.AdminCmd;
import org.apache.cloudstack.api.command.user.template.RegisterTemplateCmd;
import org.apache.cloudstack.api.response.TemplateResponse;
-@APICommand(name = "registerTemplate", description = "Registers an existing template into the CloudStack cloud.", responseObject = TemplateResponse.class, responseView = ResponseView.Full,
+@APICommand(name = "registerTemplate", description = "Registers an existing Template into the CloudStack cloud.", responseObject = TemplateResponse.class, responseView = ResponseView.Full,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class RegisterTemplateCmdByAdmin extends RegisterTemplateCmd implements AdminCmd {
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/template/UpdateTemplateCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/template/UpdateTemplateCmdByAdmin.java
index b1dfae3ed83..b75a2c0755d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/template/UpdateTemplateCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/template/UpdateTemplateCmdByAdmin.java
@@ -22,7 +22,7 @@ import org.apache.cloudstack.api.command.admin.AdminCmd;
import org.apache.cloudstack.api.command.user.template.UpdateTemplateCmd;
import org.apache.cloudstack.api.response.TemplateResponse;
-@APICommand(name = "updateTemplate", description = "Updates attributes of a template.", responseObject = TemplateResponse.class, responseView = ResponseView.Full,
+@APICommand(name = "updateTemplate", description = "Updates attributes of a Template.", responseObject = TemplateResponse.class, responseView = ResponseView.Full,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class UpdateTemplateCmdByAdmin extends UpdateTemplateCmd implements AdminCmd {
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/usage/AddTrafficTypeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/usage/AddTrafficTypeCmd.java
index b1810676b74..2ba3b321887 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/usage/AddTrafficTypeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/usage/AddTrafficTypeCmd.java
@@ -46,10 +46,10 @@ public class AddTrafficTypeCmd extends BaseAsyncCreateCmd {
type = CommandType.UUID,
entityType = PhysicalNetworkResponse.class,
required = true,
- description = "the Physical Network ID")
+ description = "The Physical Network ID")
private Long physicalNetworkId;
- @Parameter(name = ApiConstants.TRAFFIC_TYPE, type = CommandType.STRING, required = true, description = "the trafficType to be added to the physical network")
+ @Parameter(name = ApiConstants.TRAFFIC_TYPE, type = CommandType.STRING, required = true, description = "The trafficType to be added to the physical network")
private String trafficType;
@Parameter(name = ApiConstants.XENSERVER_NETWORK_LABEL,
@@ -80,7 +80,7 @@ public class AddTrafficTypeCmd extends BaseAsyncCreateCmd {
@Parameter(name = ApiConstants.VLAN, type = CommandType.STRING, description = "The VLAN id to be used for Management traffic by VMware host")
private String vlan;
- @Parameter(name=ApiConstants.ISOLATION_METHOD, type=CommandType.STRING, description="Used if physical network has multiple isolation types and traffic type is public."
+ @Parameter(name=ApiConstants.ISOLATION_METHOD, type=CommandType.STRING, description = "Used if physical network has multiple isolation types and traffic type is public."
+ " Choose which isolation method. Valid options currently 'vlan' or 'vxlan', defaults to 'vlan'.")
private String isolationMethod;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/usage/DeleteTrafficTypeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/usage/DeleteTrafficTypeCmd.java
index a1e4ebda09a..d8813eefa6a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/usage/DeleteTrafficTypeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/usage/DeleteTrafficTypeCmd.java
@@ -38,7 +38,7 @@ public class DeleteTrafficTypeCmd extends BaseAsyncCmd {
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TrafficTypeResponse.class, required = true, description = "traffic type id")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TrafficTypeResponse.class, required = true, description = "Traffic type ID")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/usage/ListTrafficMonitorsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/usage/ListTrafficMonitorsCmd.java
index ed42bc42dbd..03e17631ba8 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/usage/ListTrafficMonitorsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/usage/ListTrafficMonitorsCmd.java
@@ -38,7 +38,7 @@ public class ListTrafficMonitorsCmd extends BaseListCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, required = true, description = "zone Id")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, required = true, description = "Zone ID")
private long zoneId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/usage/ListTrafficTypesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/usage/ListTrafficTypesCmd.java
index d106a736fca..28e2eefe52f 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/usage/ListTrafficTypesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/usage/ListTrafficTypesCmd.java
@@ -44,7 +44,7 @@ public class ListTrafficTypesCmd extends BaseListCmd {
type = CommandType.UUID,
entityType = PhysicalNetworkResponse.class,
required = true,
- description = "the Physical Network ID")
+ description = "The Physical Network ID")
private Long physicalNetworkId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/usage/UpdateTrafficTypeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/usage/UpdateTrafficTypeCmd.java
index c7b3c2b433b..0de4cfb7edd 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/usage/UpdateTrafficTypeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/usage/UpdateTrafficTypeCmd.java
@@ -39,7 +39,7 @@ public class UpdateTrafficTypeCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TrafficTypeResponse.class, required = true, description = "traffic type id")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TrafficTypeResponse.class, required = true, description = "Traffic type ID")
private Long id;
@Parameter(name = ApiConstants.XENSERVER_NETWORK_LABEL,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/user/CreateUserCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/user/CreateUserCmd.java
index e2a2baecc86..f03bb1c4ddd 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/user/CreateUserCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/user/CreateUserCmd.java
@@ -52,13 +52,13 @@ public class CreateUserCmd extends BaseCmd {
description = "Creates the user under the specified domain. Has to be accompanied with the account parameter")
private Long domainId;
- @Parameter(name = ApiConstants.EMAIL, type = CommandType.STRING, required = true, description = "email")
+ @Parameter(name = ApiConstants.EMAIL, type = CommandType.STRING, required = true, description = "Email")
private String email;
- @Parameter(name = ApiConstants.FIRSTNAME, type = CommandType.STRING, required = true, description = "firstname")
+ @Parameter(name = ApiConstants.FIRSTNAME, type = CommandType.STRING, required = true, description = "Firstname")
private String firstname;
- @Parameter(name = ApiConstants.LASTNAME, type = CommandType.STRING, required = true, description = "lastname")
+ @Parameter(name = ApiConstants.LASTNAME, type = CommandType.STRING, required = true, description = "Lastname")
private String lastname;
@Parameter(name = ApiConstants.PASSWORD,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/user/DeleteUserCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/user/DeleteUserCmd.java
index ddf21affb53..f954ac939c3 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/user/DeleteUserCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/user/DeleteUserCmd.java
@@ -42,7 +42,7 @@ public class DeleteUserCmd extends BaseCmd {
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = UserResponse.class, required = true, description = "id of the user to be deleted")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = UserResponse.class, required = true, description = "ID of the user to be deleted")
private Long id;
@Inject
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/user/ListUsersCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/user/ListUsersCmd.java
index 27a78c738c9..53e74204625 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/user/ListUsersCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/user/ListUsersCmd.java
@@ -60,7 +60,7 @@ public class ListUsersCmd extends BaseListAccountResourcesCmd implements UserCmd
private String apiKeyAccess;
@Parameter(name = ApiConstants.SHOW_RESOURCE_ICON, type = CommandType.BOOLEAN,
- description = "flag to display the resource icon for users")
+ description = "Flag to display the resource icon for users")
private Boolean showIcon;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/user/MoveUserCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/user/MoveUserCmd.java
index e57258a4571..a160486c51c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/user/MoveUserCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/user/MoveUserCmd.java
@@ -54,7 +54,7 @@ public class MoveUserCmd extends BaseCmd {
type = CommandType.UUID,
entityType = UserResponse.class,
required = true,
- description = "id of the user to be moved.")
+ description = "ID of the user to be moved.")
private Long id;
@Parameter(name = ApiConstants.ACCOUNT,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/user/UpdateUserCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/user/UpdateUserCmd.java
index 3d7f51ae220..cc0b2e4954c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/user/UpdateUserCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/user/UpdateUserCmd.java
@@ -46,16 +46,16 @@ public class UpdateUserCmd extends BaseCmd {
@Parameter(name = ApiConstants.USER_API_KEY, type = CommandType.STRING, description = "The API key for the user. Must be specified with userSecretKey")
private String apiKey;
- @Parameter(name = ApiConstants.EMAIL, type = CommandType.STRING, description = "email")
+ @Parameter(name = ApiConstants.EMAIL, type = CommandType.STRING, description = "Email")
private String email;
- @Parameter(name = ApiConstants.FIRSTNAME, type = CommandType.STRING, description = "first name")
+ @Parameter(name = ApiConstants.FIRSTNAME, type = CommandType.STRING, description = "First name")
private String firstname;
@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = UserResponse.class, required = true, description = "User uuid")
private Long id;
- @Parameter(name = ApiConstants.LASTNAME, type = CommandType.STRING, description = "last name")
+ @Parameter(name = ApiConstants.LASTNAME, type = CommandType.STRING, description = "Last name")
private String lastname;
@Parameter(name = ApiConstants.PASSWORD,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vlan/CreateVlanIpRangeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vlan/CreateVlanIpRangeCmd.java
index c0ba99a8233..abf7da6f962 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vlan/CreateVlanIpRangeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vlan/CreateVlanIpRangeCmd.java
@@ -17,6 +17,7 @@
package org.apache.cloudstack.api.command.admin.vlan;
import com.cloud.utils.net.NetUtils;
+import com.cloud.utils.StringUtils;
import org.apache.cloudstack.api.APICommand;
import org.apache.cloudstack.api.ApiConstants;
@@ -52,66 +53,66 @@ public class CreateVlanIpRangeCmd extends BaseCmd {
@Parameter(name = ApiConstants.ACCOUNT,
type = CommandType.STRING,
- description = "account who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted")
+ description = "Account who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted")
private String accountName;
@Parameter(name = ApiConstants.PROJECT_ID,
type = CommandType.UUID,
entityType = ProjectResponse.class,
- description = "project who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted")
+ description = "Project who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted")
private Long projectId;
- @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "domain ID of the account owning a VLAN")
+ @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "Domain ID of the Account owning a VLAN")
private Long domainId;
- @Parameter(name = ApiConstants.END_IP, type = CommandType.STRING, description = "the ending IP address in the VLAN IP range")
+ @Parameter(name = ApiConstants.END_IP, type = CommandType.STRING, description = "The ending IP address in the VLAN IP range")
private String endIp;
- @Parameter(name = ApiConstants.FOR_VIRTUAL_NETWORK, type = CommandType.BOOLEAN, description = "true if VLAN is of Virtual type, false if Direct")
+ @Parameter(name = ApiConstants.FOR_VIRTUAL_NETWORK, type = CommandType.BOOLEAN, description = "True if VLAN is of Virtual type, false if Direct")
private Boolean forVirtualNetwork;
- @Parameter(name = ApiConstants.GATEWAY, type = CommandType.STRING, description = "the gateway of the VLAN IP range")
+ @Parameter(name = ApiConstants.GATEWAY, type = CommandType.STRING, description = "The gateway of the VLAN IP range")
private String gateway;
- @Parameter(name = ApiConstants.NETMASK, type = CommandType.STRING, description = "the netmask of the VLAN IP range")
+ @Parameter(name = ApiConstants.NETMASK, type = CommandType.STRING, description = "The netmask of the VLAN IP range")
private String netmask;
@Parameter(name = ApiConstants.POD_ID,
type = CommandType.UUID,
entityType = PodResponse.class,
- description = "optional parameter. Have to be specified for Direct Untagged vlan only.")
+ description = "Optional parameter. Have to be specified for Direct Untagged vlan only.")
private Long podId;
- @Parameter(name = ApiConstants.START_IP, type = CommandType.STRING, description = "the beginning IP address in the VLAN IP range")
+ @Parameter(name = ApiConstants.START_IP, type = CommandType.STRING, description = "The beginning IP address in the VLAN IP range")
private String startIp;
- @Parameter(name = ApiConstants.VLAN, type = CommandType.STRING, description = "the ID or VID of the VLAN. If not specified,"
+ @Parameter(name = ApiConstants.VLAN, type = CommandType.STRING, description = "The ID or VID of the VLAN. If not specified,"
+ " will be defaulted to the vlan of the network or if vlan of the network is null - to Untagged")
private String vlan;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "the Zone ID of the VLAN IP range")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "The Zone ID of the VLAN IP range")
private Long zoneId;
- @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "the network id")
+ @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "The Network ID")
private Long networkID;
- @Parameter(name = ApiConstants.PHYSICAL_NETWORK_ID, type = CommandType.UUID, entityType = PhysicalNetworkResponse.class, description = "the physical network id")
+ @Parameter(name = ApiConstants.PHYSICAL_NETWORK_ID, type = CommandType.UUID, entityType = PhysicalNetworkResponse.class, description = "The physical network ID")
private Long physicalNetworkId;
- @Parameter(name = ApiConstants.START_IPV6, type = CommandType.STRING, description = "the beginning IPv6 address in the IPv6 network range")
+ @Parameter(name = ApiConstants.START_IPV6, type = CommandType.STRING, description = "The beginning IPv6 address in the IPv6 network range")
private String startIpv6;
- @Parameter(name = ApiConstants.END_IPV6, type = CommandType.STRING, description = "the ending IPv6 address in the IPv6 network range")
+ @Parameter(name = ApiConstants.END_IPV6, type = CommandType.STRING, description = "The ending IPv6 address in the IPv6 network range")
private String endIpv6;
- @Parameter(name = ApiConstants.IP6_GATEWAY, type = CommandType.STRING, description = "the gateway of the IPv6 network. Required "
+ @Parameter(name = ApiConstants.IP6_GATEWAY, type = CommandType.STRING, description = "The gateway of the IPv6 network. Required "
+ "for Shared networks and Isolated networks when it belongs to VPC")
private String ip6Gateway;
- @Parameter(name = ApiConstants.IP6_CIDR, type = CommandType.STRING, description = "the CIDR of IPv6 network, must be at least /64")
+ @Parameter(name = ApiConstants.IP6_CIDR, type = CommandType.STRING, description = "The CIDR of IPv6 network, must be at least /64")
private String ip6Cidr;
- @Parameter(name = ApiConstants.FOR_SYSTEM_VMS, type = CommandType.BOOLEAN, description = "true if IP range is set to system vms, false if not")
+ @Parameter(name = ApiConstants.FOR_SYSTEM_VMS, type = CommandType.BOOLEAN, description = "True if IP range is set to System VMs, false if not")
private Boolean forSystemVms;
@Parameter(name = ApiConstants.FOR_NSX, type = CommandType.BOOLEAN, description = "true if the IP range is used for NSX resource", since = "4.20.0")
@@ -162,7 +163,7 @@ public class CreateVlanIpRangeCmd extends BaseCmd {
}
public String getVlan() {
- if ((vlan == null || vlan.isEmpty()) && !isForNsx()) {
+ if (StringUtils.isBlank(vlan) && !isForNsx()) {
vlan = "untagged";
}
return vlan;
@@ -230,7 +231,7 @@ public class CreateVlanIpRangeCmd extends BaseCmd {
response.setResponseName(getCommandName());
this.setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create vlan ip range");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create VLAN IP range");
}
} catch (ConcurrentOperationException ex) {
logger.warn("Exception: ", ex);
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vlan/DedicatePublicIpRangeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vlan/DedicatePublicIpRangeCmd.java
index cac029f3aa1..d4872fa369a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vlan/DedicatePublicIpRangeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vlan/DedicatePublicIpRangeCmd.java
@@ -41,20 +41,20 @@ public class DedicatePublicIpRangeCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VlanIpRangeResponse.class, required = true, description = "the id of the VLAN IP range")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VlanIpRangeResponse.class, required = true, description = "The ID of the VLAN IP range")
private Long id;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "account who will own the VLAN")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "Account who will own the VLAN")
private String accountName;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "project who will own the VLAN")
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "Project who will own the VLAN")
private Long projectId;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
required = true,
- description = "domain ID of the account owning a VLAN")
+ description = "Domain ID of the account owning a VLAN")
private Long domainId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vlan/DeleteVlanIpRangeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vlan/DeleteVlanIpRangeCmd.java
index 7ab0b053004..768b6ecf419 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vlan/DeleteVlanIpRangeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vlan/DeleteVlanIpRangeCmd.java
@@ -37,7 +37,7 @@ public class DeleteVlanIpRangeCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VlanIpRangeResponse.class, required = true, description = "the id of the VLAN IP range")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VlanIpRangeResponse.class, required = true, description = "The ID of the VLAN IP range")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vlan/ListVlanIpRangesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vlan/ListVlanIpRangesCmd.java
index c11b505c684..875b36f5fe9 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vlan/ListVlanIpRangesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vlan/ListVlanIpRangesCmd.java
@@ -47,41 +47,41 @@ public class ListVlanIpRangesCmd extends BaseListCmd {
@Parameter(name = ApiConstants.ACCOUNT,
type = CommandType.STRING,
- description = "the account with which the VLAN IP range is associated. Must be used with the domainId parameter.")
+ description = "The account with which the VLAN IP range is associated. Must be used with the domainId parameter.")
private String accountName;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "project who will own the VLAN")
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "Project who will own the VLAN")
private Long projectId;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "the domain ID with which the VLAN IP range is associated. If used with the account parameter, " +
+ description = "The domain ID with which the VLAN IP range is associated. If used with the account parameter, " +
"returns all VLAN IP ranges for that account in the specified domain.")
private Long domainId;
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VlanIpRangeResponse.class, required = false, description = "the ID of the VLAN IP range")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VlanIpRangeResponse.class, required = false, description = "The ID of the VLAN IP range")
private Long id;
- @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "the Pod ID of the VLAN IP range")
+ @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "The Pod ID of the VLAN IP range")
private Long podId;
- @Parameter(name = ApiConstants.VLAN, type = CommandType.STRING, description = "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.")
+ @Parameter(name = ApiConstants.VLAN, type = CommandType.STRING, description = "The ID or VID of the VLAN. Default is an \"untagged\" VLAN.")
private String vlan;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "the Zone ID of the VLAN IP range")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "The Zone ID of the VLAN IP range")
private Long zoneId;
- @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "network id of the VLAN IP range")
+ @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "Network ID of the VLAN IP range")
private Long networkId;
- @Parameter(name = ApiConstants.FOR_VIRTUAL_NETWORK, type = CommandType.BOOLEAN, description = "true if VLAN is of Virtual type, false if Direct")
+ @Parameter(name = ApiConstants.FOR_VIRTUAL_NETWORK, type = CommandType.BOOLEAN, description = "True if VLAN is of Virtual type, false if Direct")
private Boolean forVirtualNetwork;
@Parameter(name = ApiConstants.PHYSICAL_NETWORK_ID,
type = CommandType.UUID,
entityType = PhysicalNetworkResponse.class,
- description = "physical network id of the VLAN IP range")
+ description = "Physical Network ID of the VLAN IP range")
private Long physicalNetworkId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vlan/ReleasePublicIpRangeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vlan/ReleasePublicIpRangeCmd.java
index be4cea41cd8..e369516f5ee 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vlan/ReleasePublicIpRangeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vlan/ReleasePublicIpRangeCmd.java
@@ -37,7 +37,7 @@ public class ReleasePublicIpRangeCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VlanIpRangeResponse.class, required = true, description = "the id of the Public IP range")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VlanIpRangeResponse.class, required = true, description = "The ID of the Public IP range")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vlan/UpdateVlanIpRangeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vlan/UpdateVlanIpRangeCmd.java
index df6d99f8e2a..be8e8b39d4e 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vlan/UpdateVlanIpRangeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vlan/UpdateVlanIpRangeCmd.java
@@ -45,35 +45,35 @@ public class UpdateVlanIpRangeCmd extends BaseCmd {
@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VlanIpRangeResponse.class, required = true,
- description = "the UUID of the VLAN IP range")
+ description = "The UUID of the VLAN IP range")
private Long id;
- @Parameter(name = ApiConstants.GATEWAY, type = CommandType.STRING, description = "the gateway of the VLAN IP range")
+ @Parameter(name = ApiConstants.GATEWAY, type = CommandType.STRING, description = "The gateway of the VLAN IP range")
private String gateway;
- @Parameter(name = ApiConstants.NETMASK, type = CommandType.STRING, description = "the netmask of the VLAN IP range")
+ @Parameter(name = ApiConstants.NETMASK, type = CommandType.STRING, description = "The netmask of the VLAN IP range")
private String netmask;
- @Parameter(name = ApiConstants.START_IP, type = CommandType.STRING, description = "the beginning IP address in the VLAN IP range")
+ @Parameter(name = ApiConstants.START_IP, type = CommandType.STRING, description = "The beginning IP address in the VLAN IP range")
private String startIp;
@Parameter(name = ApiConstants.END_IP, type = CommandType.STRING,
- description = "the ending IP address in the VLAN IP range")
+ description = "The ending IP address in the VLAN IP range")
private String endIp;
- @Parameter(name = ApiConstants.START_IPV6, type = CommandType.STRING, description = "the beginning IPv6 address in the IPv6 network range")
+ @Parameter(name = ApiConstants.START_IPV6, type = CommandType.STRING, description = "The beginning IPv6 address in the IPv6 Network range")
private String startIpv6;
- @Parameter(name = ApiConstants.END_IPV6, type = CommandType.STRING, description = "the ending IPv6 address in the IPv6 network range")
+ @Parameter(name = ApiConstants.END_IPV6, type = CommandType.STRING, description = "The ending IPv6 address in the IPv6 Network range")
private String endIpv6;
- @Parameter(name = ApiConstants.IP6_GATEWAY, type = CommandType.STRING, description = "the gateway of the IPv6 network")
+ @Parameter(name = ApiConstants.IP6_GATEWAY, type = CommandType.STRING, description = "The gateway of the IPv6 Network")
private String ip6Gateway;
- @Parameter(name = ApiConstants.IP6_CIDR, type = CommandType.STRING, description = "the CIDR of IPv6 network, must be at least /64")
+ @Parameter(name = ApiConstants.IP6_CIDR, type = CommandType.STRING, description = "The CIDR of IPv6 Network, must be at least /64")
private String ip6Cidr;
- @Parameter(name = ApiConstants.FOR_SYSTEM_VMS, type = CommandType.BOOLEAN, description = "true if IP range is set to system vms, false if not")
+ @Parameter(name = ApiConstants.FOR_SYSTEM_VMS, type = CommandType.BOOLEAN, description = "True if IP range is set to System VM, false if not")
private Boolean forSystemVms;
/////////////////////////////////////////////////////
@@ -144,7 +144,7 @@ public class UpdateVlanIpRangeCmd extends BaseCmd {
response.setResponseName(getCommandName());
this.setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to Update vlan ip range");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to Update VLAN IP range");
}
} catch (ConcurrentOperationException ex) {
logger.warn("Exception: ", ex);
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/AddNicToVMCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/AddNicToVMCmdByAdmin.java
index 7a8c409c8a8..ce421433d50 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/AddNicToVMCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/AddNicToVMCmdByAdmin.java
@@ -25,6 +25,6 @@ import org.apache.cloudstack.api.response.UserVmResponse;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "addNicToVirtualMachine", description = "Adds VM to specified network by creating a NIC", responseObject = UserVmResponse.class, responseView = ResponseView.Full, entityType = {VirtualMachine.class},
+@APICommand(name = "addNicToVirtualMachine", description = "Adds Instance to specified network by creating a NIC", responseObject = UserVmResponse.class, responseView = ResponseView.Full, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class AddNicToVMCmdByAdmin extends AddNicToVMCmd implements AdminCmd {}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/AssignVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/AssignVMCmd.java
index 6f6a5237b3d..e11d20d0646 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/AssignVMCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/AssignVMCmd.java
@@ -39,7 +39,7 @@ import com.cloud.uservm.UserVm;
import com.cloud.vm.VirtualMachine;
@APICommand(name = "assignVirtualMachine",
- description = "Change ownership of a VM from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign a VM from any account to any other account in any domain. A domain administrator can reassign a VM to any account in the same domain.",
+ description = "Change ownership of an Instance from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign an Instance from any account to any other account in any domain. A domain administrator can reassign an Instance to any account in the same domain.",
responseObject = UserVmResponse.class,
since = "3.0.0", entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false,
@@ -55,16 +55,16 @@ public class AssignVMCmd extends BaseCmd {
type = CommandType.UUID,
entityType = UserVmResponse.class,
required = true,
- description = "id of the VM to be moved")
+ description = "ID of the Instance to be moved")
private Long virtualMachineId;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "account name of the new VM owner.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "Account name of the new Instance owner.")
private String accountName;
- @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "domain id of the new VM owner.")
+ @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "Domain id of the new Instance owner.")
private Long domainId;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "an optional project for the new VM owner.")
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "An optional project for the new Instance owner.")
private Long projectId;
//Network information
@@ -72,7 +72,7 @@ public class AssignVMCmd extends BaseCmd {
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = NetworkResponse.class,
- description = "list of new network ids in which the moved VM will participate. In case no network ids are provided the VM will be part of the default network for that zone. "
+ description = "List of new network IDs in which the moved Instance will participate. In case no network ids are provided the Instance will be part of the default network for that zone. "
+
"In case there is no network yet created for the new account the default network will be created.")
private List networkIds;
@@ -81,8 +81,8 @@ public class AssignVMCmd extends BaseCmd {
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = SecurityGroupResponse.class,
- description = "list of security group ids to be applied on the virtual machine. " +
- "In case no security groups are provided the VM is part of the default security group.")
+ description = "List of security group ids to be applied on the Instance. " +
+ "In case no security groups are provided the Instance is part of the default security group.")
private List securityGroupIdList;
/////////////////////////////////////////////////////
@@ -126,7 +126,7 @@ public class AssignVMCmd extends BaseCmd {
setResponseObject(response);
} catch (Exception e) {
ApiErrorCode errorCode = e instanceof InvalidParameterValueException ? ApiErrorCode.PARAM_ERROR : ApiErrorCode.INTERNAL_ERROR;
- String msg = String.format("Failed to move VM [%s].", getVmId());
+ String msg = String.format("Failed to move Instance due to [%s].", getVmId());
logger.error(msg, e);
throw new ServerApiException(errorCode, msg);
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/DeployVMCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/DeployVMCmdByAdmin.java
index 6bb7657b86b..e64c8b3f46c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/DeployVMCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/DeployVMCmdByAdmin.java
@@ -30,15 +30,15 @@ import org.apache.cloudstack.api.response.UserVmResponse;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "deployVirtualMachine", description = "Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.", responseObject = UserVmResponse.class, responseView = ResponseView.Full, entityType = {VirtualMachine.class},
+@APICommand(name = "deployVirtualMachine", description = "Creates and automatically starts an Instance based on a service offering, disk offering, and Template.", responseObject = UserVmResponse.class, responseView = ResponseView.Full, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class DeployVMCmdByAdmin extends DeployVMCmd implements AdminCmd {
- @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "destination Pod ID to deploy the VM to - parameter available for root admin only", since = "4.13")
+ @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "Destination Pod ID to deploy the Instance to - parameter available for root admin only", since = "4.13")
private Long podId;
- @Parameter(name = ApiConstants.CLUSTER_ID, type = CommandType.UUID, entityType = ClusterResponse.class, description = "destination Cluster ID to deploy the VM to - parameter available for root admin only", since = "4.13")
+ @Parameter(name = ApiConstants.CLUSTER_ID, type = CommandType.UUID, entityType = ClusterResponse.class, description = "Destination Cluster ID to deploy the Instance to - parameter available for root admin only", since = "4.13")
private Long clusterId;
public Long getPodId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/DestroyVMCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/DestroyVMCmdByAdmin.java
index 08a13649bfa..93d4b610b90 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/DestroyVMCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/DestroyVMCmdByAdmin.java
@@ -24,7 +24,7 @@ import org.apache.cloudstack.api.response.UserVmResponse;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "destroyVirtualMachine", description = "Destroys a virtual machine. Once destroyed, only the administrator can recover it.", responseObject = UserVmResponse.class, responseView = ResponseView.Full, entityType = {VirtualMachine.class},
+@APICommand(name = "destroyVirtualMachine", description = "Destroys an Instance. Once destroyed, only the administrator can recover it.", responseObject = UserVmResponse.class, responseView = ResponseView.Full, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false,
responseHasSensitiveInfo = true)
public class DestroyVMCmdByAdmin extends DestroyVMCmd implements AdminCmd {}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ExpungeVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ExpungeVMCmd.java
index a964e873bad..74ebab59de4 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ExpungeVMCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ExpungeVMCmd.java
@@ -39,7 +39,7 @@ import com.cloud.uservm.UserVm;
import com.cloud.utils.exception.CloudRuntimeException;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "expungeVirtualMachine", description = "Expunge a virtual machine. Once expunged, it cannot be recoverd.", responseObject = SuccessResponse.class, entityType = {VirtualMachine.class},
+@APICommand(name = "expungeVirtualMachine", description = "Expunge an Instance. Once expunged, it cannot be recovered.", responseObject = SuccessResponse.class, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ExpungeVMCmd extends BaseAsyncCmd {
@@ -49,7 +49,7 @@ public class ExpungeVMCmd extends BaseAsyncCmd {
/////////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = UserVmResponse.class, required = true, description = "The ID of the virtual machine")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = UserVmResponse.class, required = true, description = "The ID of the Instance")
private Long id;
/////////////////////////////////////////////////////
@@ -81,7 +81,7 @@ public class ExpungeVMCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "Expunging vm: " + this._uuidMgr.getUuid(VirtualMachine.class, getId());
+ return "Expunging Instance: " + this._uuidMgr.getUuid(VirtualMachine.class, getId());
}
@Override
@@ -104,7 +104,7 @@ public class ExpungeVMCmd extends BaseAsyncCmd {
SuccessResponse response = new SuccessResponse(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to expunge vm");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to expunge Instance");
}
} catch (InvalidParameterValueException ipve) {
throw new ServerApiException(ApiErrorCode.PARAM_ERROR, ipve.getMessage());
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/GetVMUserDataCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/GetVMUserDataCmd.java
index 8745ef12ce4..2f0aba43ad0 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/GetVMUserDataCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/GetVMUserDataCmd.java
@@ -28,7 +28,7 @@ import org.apache.cloudstack.api.response.VMUserDataResponse;
import com.cloud.user.Account;
import com.cloud.uservm.UserVm;
-@APICommand(name = "getVirtualMachineUserData", description = "Returns user data associated with the VM", responseObject = VMUserDataResponse.class, since = "4.4",
+@APICommand(name = "getVirtualMachineUserData", description = "Returns user data associated with the Instance", responseObject = VMUserDataResponse.class, since = "4.4",
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class GetVMUserDataCmd extends BaseCmd {
@@ -36,7 +36,7 @@ public class GetVMUserDataCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID, type = CommandType.UUID, entityType = UserVmResponse.class, required = true, description = "The ID of the virtual machine")
+ @Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID, type = CommandType.UUID, entityType = UserVmResponse.class, required = true, description = "The ID of the Instance")
private Long vmId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ImportUnmanagedInstanceCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ImportUnmanagedInstanceCmd.java
index ae6ceff26c7..d60c627163b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ImportUnmanagedInstanceCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ImportUnmanagedInstanceCmd.java
@@ -56,7 +56,7 @@ import com.cloud.utils.net.NetUtils;
import com.cloud.vm.VmDetailConstants;
@APICommand(name = "importUnmanagedInstance",
- description = "Import unmanaged virtual machine from a given cluster.",
+ description = "Import unmanaged Instance from a given cluster.",
responseObject = UserVmResponse.class,
responseView = ResponseObject.ResponseView.Full,
requestHasSensitiveInfo = false,
@@ -76,83 +76,83 @@ public class ImportUnmanagedInstanceCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = ClusterResponse.class,
required = true,
- description = "the cluster ID")
+ description = "The cluster ID")
private Long clusterId;
@Parameter(name = ApiConstants.NAME,
type = CommandType.STRING,
required = true,
- description = "the name of the instance as it is known to the hypervisor")
+ description = "The name of the Instance as it is known to the hypervisor")
private String name;
@Parameter(name = ApiConstants.DISPLAY_NAME,
type = CommandType.STRING,
- description = "the display name of the instance")
+ description = "The display name of the Instance")
private String displayName;
@Parameter(name = ApiConstants.HOST_NAME,
type = CommandType.STRING,
- description = "the host name of the instance")
+ description = "The host name of the Instance")
private String hostName;
@Parameter(name = ApiConstants.ACCOUNT,
type = CommandType.STRING,
- description = "an optional account for the virtual machine. Must be used with domainId.")
+ description = "An optional account for the Instance. Must be used with domainId.")
private String accountName;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "import instance to the domain specified")
+ description = "Import Instance to the domain specified")
private Long domainId;
@Parameter(name = ApiConstants.PROJECT_ID,
type = CommandType.UUID,
entityType = ProjectResponse.class,
- description = "import instance for the project")
+ description = "Import Instance for the project")
private Long projectId;
@Parameter(name = ApiConstants.TEMPLATE_ID,
type = CommandType.UUID,
entityType = TemplateResponse.class,
- description = "the ID of the template for the virtual machine")
+ description = "The ID of the Template for the Instance")
private Long templateId;
@Parameter(name = ApiConstants.SERVICE_OFFERING_ID,
type = CommandType.UUID,
entityType = ServiceOfferingResponse.class,
required = true,
- description = "the service offering for the virtual machine")
+ description = "The service offering for the Instance")
private Long serviceOfferingId;
@Parameter(name = ApiConstants.NIC_NETWORK_LIST,
type = CommandType.MAP,
- description = "VM nic to network id mapping using keys nic and network")
+ description = "VM NIC to network id mapping using keys NIC and network")
private Map nicNetworkList;
@Parameter(name = ApiConstants.NIC_IP_ADDRESS_LIST,
type = CommandType.MAP,
- description = "VM nic to ip address mapping using keys nic, ip4Address")
+ description = "VM NIC to ip address mapping using keys NIC, ip4Address")
private Map nicIpAddressList;
@Parameter(name = ApiConstants.DATADISK_OFFERING_LIST,
type = CommandType.MAP,
- description = "datadisk template to disk-offering mapping using keys disk and diskOffering")
+ description = "Datadisk Template to disk-offering mapping using keys disk and diskOffering")
private Map dataDiskToDiskOfferingList;
@Parameter(name = ApiConstants.DETAILS,
type = CommandType.MAP,
- description = "used to specify the custom parameters.")
+ description = "Used to specify the custom parameters.")
private Map details;
@Parameter(name = ApiConstants.MIGRATE_ALLOWED,
type = CommandType.BOOLEAN,
- description = "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool")
+ description = "Instance and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool")
private Boolean migrateAllowed;
@Parameter(name = ApiConstants.FORCED,
type = CommandType.BOOLEAN,
- description = "VM is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated")
+ description = "Instance is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated")
private Boolean forced;
/////////////////////////////////////////////////////
@@ -202,7 +202,7 @@ public class ImportUnmanagedInstanceCmd extends BaseAsyncCmd {
String nic = entry.get(VmDetailConstants.NIC);
String networkUuid = entry.get(VmDetailConstants.NETWORK);
if (logger.isDebugEnabled()) {
- logger.debug(String.format("nic, '%s', goes on net, '%s'", nic, networkUuid));
+ logger.debug(String.format("NIC, '%s', goes on net, '%s'", nic, networkUuid));
}
if (StringUtils.isAnyEmpty(nic, networkUuid) || _entityMgr.findByUuid(Network.class, networkUuid) == null) {
throw new InvalidParameterValueException(String.format("Network ID: %s for NIC ID: %s is invalid", networkUuid, nic));
@@ -220,7 +220,7 @@ public class ImportUnmanagedInstanceCmd extends BaseAsyncCmd {
String nic = entry.get(VmDetailConstants.NIC);
String ipAddress = StringUtils.defaultIfEmpty(entry.get(VmDetailConstants.IP4_ADDRESS), null);
if (logger.isDebugEnabled()) {
- logger.debug(String.format("nic, '%s', gets ip, '%s'", nic, ipAddress));
+ logger.debug(String.format("NIC, '%s', gets IP, '%s'", nic, ipAddress));
}
if (StringUtils.isEmpty(nic)) {
throw new InvalidParameterValueException(String.format("NIC ID: '%s' is invalid for IP address mapping", nic));
@@ -278,7 +278,7 @@ public class ImportUnmanagedInstanceCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
String vmName = this.name;
- return String.format("Importing unmanaged VM: %s", vmName);
+ return String.format("Importing unmanaged Instance: %s", vmName);
}
public boolean isForced() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ListUnmanagedInstancesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ListUnmanagedInstancesCmd.java
index 6932aa383fa..1d628568447 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ListUnmanagedInstancesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ListUnmanagedInstancesCmd.java
@@ -41,7 +41,7 @@ import com.cloud.exception.ResourceUnavailableException;
import com.cloud.user.Account;
@APICommand(name = "listUnmanagedInstances",
- description = "Lists unmanaged virtual machines for a given cluster.",
+ description = "Lists unmanaged Instances for a given cluster.",
responseObject = UnmanagedInstanceResponse.class,
responseView = ResponseObject.ResponseView.Full,
entityType = {UnmanagedInstanceTO.class},
@@ -62,12 +62,12 @@ public class ListUnmanagedInstancesCmd extends BaseListCmd {
type = CommandType.UUID,
entityType = ClusterResponse.class,
required = true,
- description = "the cluster ID")
+ description = "The cluster ID")
private Long clusterId;
@Parameter(name = ApiConstants.NAME,
type = CommandType.STRING,
- description = "the hypervisor name of the instance")
+ description = "The hypervisor name of the Instance")
private String name;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ListVMsCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ListVMsCmdByAdmin.java
index b48941e7d17..52309855a7a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ListVMsCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ListVMsCmdByAdmin.java
@@ -30,7 +30,7 @@ import org.apache.cloudstack.api.response.UserVmResponse;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "listVirtualMachines", description = "List the virtual machines owned by the account.", responseObject = UserVmResponse.class, responseView = ResponseView.Full, entityType = {VirtualMachine.class},
+@APICommand(name = "listVirtualMachines", description = "List the Instances owned by the account.", responseObject = UserVmResponse.class, responseView = ResponseView.Full, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class ListVMsCmdByAdmin extends ListVMsCmd implements AdminCmd {
@@ -39,19 +39,19 @@ public class ListVMsCmdByAdmin extends ListVMsCmd implements AdminCmd {
/////////////////////////////////////////////////////
@Parameter(name=ApiConstants.HOST_ID, type=CommandType.UUID, entityType=HostResponse.class,
- description="the host ID")
+ description = "The host ID")
private Long hostId;
@Parameter(name=ApiConstants.POD_ID, type=CommandType.UUID, entityType=PodResponse.class,
- description="the pod ID")
+ description = "The pod ID")
private Long podId;
@Parameter(name=ApiConstants.STORAGE_ID, type=CommandType.UUID, entityType=StoragePoolResponse.class,
- description="the storage ID where vm's volumes belong to")
+ description = "The storage ID where Instance's volumes belong to")
private Long storageId;
@Parameter(name = ApiConstants.CLUSTER_ID, type = CommandType.UUID, entityType = ClusterResponse.class,
- description = "the cluster ID", since = "4.16.0")
+ description = "The cluster ID", since = "4.16.0")
private Long clusterId;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/MigrateVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/MigrateVMCmd.java
index 8881a2bc354..508b8b81631 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/MigrateVMCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/MigrateVMCmd.java
@@ -44,7 +44,7 @@ import com.cloud.uservm.UserVm;
import com.cloud.vm.VirtualMachine;
@APICommand(name = "migrateVirtualMachine",
- description = "Attempts Migration of a VM to a different host or Root volume of the vm to a different storage pool",
+ description = "Attempts Migration of an Instance to a different host or Root volume of the Instance to a different storage pool",
responseObject = UserVmResponse.class, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false,
responseHasSensitiveInfo = true)
@@ -59,21 +59,21 @@ public class MigrateVMCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = HostResponse.class,
required = false,
- description = "Destination Host ID to migrate VM to.")
+ description = "Destination Host ID to migrate Instance to.")
private Long hostId;
@Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID,
type = CommandType.UUID,
entityType = UserVmResponse.class,
required = true,
- description = "the ID of the virtual machine")
+ description = "The ID of the Instance")
private Long virtualMachineId;
@Parameter(name = ApiConstants.STORAGE_ID,
type = CommandType.UUID,
entityType = StoragePoolResponse.class,
required = false,
- description = "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume")
+ description = "Destination storage pool ID to migrate Instance volumes to. Required for migrating the root disk volume")
private Long storageId;
@Parameter(name = ApiConstants.AUTO_SELECT,
@@ -125,11 +125,11 @@ public class MigrateVMCmd extends BaseAsyncCmd {
public String getEventDescription() {
String eventDescription;
if (getHostId() != null) {
- eventDescription = String.format("Attempting to migrate VM id: %s to host Id: %s", getVirtualMachineId(), getHostId());
+ eventDescription = String.format("Attempting to migrate Instance id: %s to host Id: %s", getVirtualMachineId(), getHostId());
} else if (getStoragePoolId() != null) {
- eventDescription = String.format("Attempting to migrate VM id: %s to storage pool Id: %s", getVirtualMachineId(), getStoragePoolId());
+ eventDescription = String.format("Attempting to migrate Instance id: %s to storage pool Id: %s", getVirtualMachineId(), getStoragePoolId());
} else {
- eventDescription = String.format("Attempting to migrate VM id: %s", getVirtualMachineId());
+ eventDescription = String.format("Attempting to migrate Instance id: %s", getVirtualMachineId());
}
return eventDescription;
}
@@ -142,7 +142,7 @@ public class MigrateVMCmd extends BaseAsyncCmd {
UserVm userVm = _userVmService.getUserVm(getVirtualMachineId());
if (userVm == null) {
- throw new InvalidParameterValueException("Unable to find the VM by id=" + getVirtualMachineId());
+ throw new InvalidParameterValueException("Unable to find the Instance by id=" + getVirtualMachineId());
}
Host destinationHost = null;
@@ -151,18 +151,18 @@ public class MigrateVMCmd extends BaseAsyncCmd {
if (getStoragePoolId() != null) {
destStoragePool = _storageService.getStoragePool(getStoragePoolId());
if (destStoragePool == null) {
- throw new InvalidParameterValueException("Unable to find the storage pool to migrate the VM");
+ throw new InvalidParameterValueException("Unable to find the storage pool to migrate the Instance");
}
CallContext.current().setEventDetails("VM Id: " + getVirtualMachineId() + " to storage pool Id: " + getStoragePoolId());
} else if (getHostId() != null) {
destinationHost = _resourceService.getHost(getHostId());
if (destinationHost == null) {
- throw new InvalidParameterValueException("Unable to find the host to migrate the VM, host id=" + getHostId());
+ throw new InvalidParameterValueException("Unable to find the host to migrate the Instance, host id=" + getHostId());
}
if (destinationHost.getType() != Host.Type.Routing) {
- throw new InvalidParameterValueException("The specified host(" + destinationHost.getName() + ") is not suitable to migrate the VM, please specify another one");
+ throw new InvalidParameterValueException("The specified host(" + destinationHost.getName() + ") is not suitable to migrate the Instance, please specify another one");
}
- CallContext.current().setEventDetails("VM Id: " + getVirtualMachineId() + " to host Id: " + getHostId());
+ CallContext.current().setEventDetails("Instance Id: " + getVirtualMachineId() + " to host Id: " + getHostId());
} else if (! isAutoSelect()) {
throw new InvalidParameterValueException("Please specify a host or storage as destination, or pass 'autoselect=true' to automatically select a destination host which do not require storage migration");
}
@@ -179,7 +179,7 @@ public class MigrateVMCmd extends BaseAsyncCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to migrate vm");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to migrate Instance");
}
} catch (ResourceUnavailableException ex) {
logger.warn("Exception: ", ex);
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/MigrateVirtualMachineWithVolumeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/MigrateVirtualMachineWithVolumeCmd.java
index b736e860636..c92cda1a358 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/MigrateVirtualMachineWithVolumeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/MigrateVirtualMachineWithVolumeCmd.java
@@ -46,7 +46,7 @@ import com.cloud.uservm.UserVm;
import com.cloud.vm.VirtualMachine;
@APICommand(name = "migrateVirtualMachineWithVolume",
- description = "Attempts Migration of a VM with its volumes to a different host",
+ description = "Attempts Migration of an Instance with its volumes to a different host",
responseObject = UserVmResponse.class, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false,
responseHasSensitiveInfo = true)
@@ -60,14 +60,14 @@ public class MigrateVirtualMachineWithVolumeCmd extends BaseAsyncCmd {
@Parameter(name = ApiConstants.HOST_ID,
type = CommandType.UUID,
entityType = HostResponse.class,
- description = "Destination Host ID to migrate VM to.")
+ description = "Destination Host ID to migrate Instance to.")
private Long hostId;
@Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID,
type = CommandType.UUID,
entityType = UserVmResponse.class,
required = true,
- description = "the ID of the virtual machine")
+ description = "The ID of the Instance")
private Long virtualMachineId;
@Parameter(name = ApiConstants.MIGRATE_TO,
@@ -84,7 +84,7 @@ public class MigrateVirtualMachineWithVolumeCmd extends BaseAsyncCmd {
@Parameter(name = ApiConstants.AUTO_SELECT,
since = "4.19.0",
type = CommandType.BOOLEAN,
- description = "Automatically select a destination host for a running instance, if hostId is not specified. false by default")
+ description = "Automatically select a destination host for a running Instance, if hostId is not specified. false by default")
private Boolean autoSelect;
/////////////////////////////////////////////////////
@@ -135,7 +135,7 @@ public class MigrateVirtualMachineWithVolumeCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "Attempting to migrate VM Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getVirtualMachineId()) + " to host Id: " + this._uuidMgr.getUuid(Host.class, getHostId());
+ return "Attempting to migrate Instance Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getVirtualMachineId()) + " to host Id: " + this._uuidMgr.getUuid(Host.class, getHostId());
}
@Override
@@ -156,7 +156,7 @@ public class MigrateVirtualMachineWithVolumeCmd extends BaseAsyncCmd {
// OfflineVmwareMigration: destination host would have to not be a required parameter for stopped VMs
if (destinationHost == null) {
logger.error(String.format("Unable to find the host with ID [%s].", getHostId()));
- throw new InvalidParameterValueException("Unable to find the specified host to migrate the VM.");
+ throw new InvalidParameterValueException("Unable to find the specified host to migrate the Instance.");
}
return destinationHost;
}
@@ -164,7 +164,7 @@ public class MigrateVirtualMachineWithVolumeCmd extends BaseAsyncCmd {
@Override
public void execute() {
if (hostId == null && MapUtils.isEmpty(migrateVolumeTo) && !Boolean.TRUE.equals(autoSelect)) {
- throw new InvalidParameterValueException(String.format("Either %s or %s must be passed or %s must be true for migrating the VM.", ApiConstants.HOST_ID, ApiConstants.MIGRATE_TO, ApiConstants.AUTO_SELECT));
+ throw new InvalidParameterValueException(String.format("Either %s or %s must be passed or %s must be true for migrating the Instance.", ApiConstants.HOST_ID, ApiConstants.MIGRATE_TO, ApiConstants.AUTO_SELECT));
}
VirtualMachine virtualMachine = _userVmService.getVm(getVirtualMachineId());
@@ -188,7 +188,7 @@ public class MigrateVirtualMachineWithVolumeCmd extends BaseAsyncCmd {
if (migratedVm != null) {
setResponseBasedOnVmType(virtualMachine, migratedVm);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to migrate vm");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to migrate Instance");
}
} catch (ResourceUnavailableException ex) {
logger.warn("Exception: ", ex);
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/RebootVMCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/RebootVMCmdByAdmin.java
index 5f6a7ab384b..36fdc9d8ec1 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/RebootVMCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/RebootVMCmdByAdmin.java
@@ -24,6 +24,6 @@ import org.apache.cloudstack.api.response.UserVmResponse;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "rebootVirtualMachine", description = "Reboots a virtual machine.", responseObject = UserVmResponse.class, responseView = ResponseView.Full, entityType = {VirtualMachine.class},
+@APICommand(name = "rebootVirtualMachine", description = "Reboots an Instance.", responseObject = UserVmResponse.class, responseView = ResponseView.Full, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class RebootVMCmdByAdmin extends RebootVMCmd implements AdminCmd {}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/RecoverVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/RecoverVMCmd.java
index f34d555dc70..4f63e22b867 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/RecoverVMCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/RecoverVMCmd.java
@@ -34,7 +34,7 @@ import com.cloud.user.Account;
import com.cloud.uservm.UserVm;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "recoverVirtualMachine", description = "Recovers a virtual machine.", responseObject = UserVmResponse.class, entityType = {VirtualMachine.class},
+@APICommand(name = "recoverVirtualMachine", description = "Recovers an Instance.", responseObject = UserVmResponse.class, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class RecoverVMCmd extends BaseCmd {
@@ -44,7 +44,7 @@ public class RecoverVMCmd extends BaseCmd {
/////////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = UserVmResponse.class, required = true, description = "The ID of the virtual machine")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = UserVmResponse.class, required = true, description = "The ID of the Instance")
private Long id;
/////////////////////////////////////////////////////
@@ -87,7 +87,7 @@ public class RecoverVMCmd extends BaseCmd {
recoverVmResponse.setResponseName(getCommandName());
setResponseObject(recoverVmResponse);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to recover vm");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to recover Instance");
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/RemoveNicFromVMCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/RemoveNicFromVMCmdByAdmin.java
index 89726afe99b..e25c850e127 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/RemoveNicFromVMCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/RemoveNicFromVMCmdByAdmin.java
@@ -24,6 +24,6 @@ import org.apache.cloudstack.api.response.UserVmResponse;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "removeNicFromVirtualMachine", description = "Removes VM from specified network by deleting a NIC", responseObject = UserVmResponse.class, responseView = ResponseView.Full, entityType = {VirtualMachine.class},
+@APICommand(name = "removeNicFromVirtualMachine", description = "Removes Instance from specified network by deleting a NIC", responseObject = UserVmResponse.class, responseView = ResponseView.Full, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class RemoveNicFromVMCmdByAdmin extends RemoveNicFromVMCmd implements AdminCmd {}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ResetVMPasswordCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ResetVMPasswordCmdByAdmin.java
index d7ab0c61bbb..1b4af79d775 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ResetVMPasswordCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ResetVMPasswordCmdByAdmin.java
@@ -24,8 +24,8 @@ import org.apache.cloudstack.api.response.UserVmResponse;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "resetPasswordForVirtualMachine", responseObject=UserVmResponse.class, description="Resets the password for virtual machine. " +
- "The virtual machine must be in a \"Stopped\" state and the template must already " +
+@APICommand(name = "resetPasswordForVirtualMachine", responseObject=UserVmResponse.class, description = "Resets the password for Instance. " +
+ "The Instance must be in a \"Stopped\" state and the Template must already " +
"support this feature for this command to take effect. [async]", responseView = ResponseView.Full, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class ResetVMPasswordCmdByAdmin extends ResetVMPasswordCmd implements AdminCmd {}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ResetVMSSHKeyCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ResetVMSSHKeyCmdByAdmin.java
index ed9cc11fd5e..046a90892da 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ResetVMSSHKeyCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ResetVMSSHKeyCmdByAdmin.java
@@ -25,7 +25,7 @@ import org.apache.cloudstack.api.response.UserVmResponse;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "resetSSHKeyForVirtualMachine", responseObject = UserVmResponse.class, description = "Resets the SSH Key for virtual machine. " +
- "The virtual machine must be in a \"Stopped\" state. [async]", responseView = ResponseView.Full, entityType = {VirtualMachine.class},
+@APICommand(name = "resetSSHKeyForVirtualMachine", responseObject = UserVmResponse.class, description = "Resets the SSH Key for Instance. " +
+ "The Instance must be in a \"Stopped\" state. [async]", responseView = ResponseView.Full, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class ResetVMSSHKeyCmdByAdmin extends ResetVMSSHKeyCmd implements AdminCmd {}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ResetVMUserDataCmdAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ResetVMUserDataCmdAdmin.java
index 83e3481840b..6ae9cb837e5 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ResetVMUserDataCmdAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ResetVMUserDataCmdAdmin.java
@@ -23,8 +23,8 @@ import org.apache.cloudstack.api.command.admin.AdminCmd;
import org.apache.cloudstack.api.command.user.vm.ResetVMUserDataCmd;
import org.apache.cloudstack.api.response.UserVmResponse;
-@APICommand(name = "resetUserDataForVirtualMachine", responseObject = UserVmResponse.class, description = "Resets the UserData for virtual machine. " +
- "The virtual machine must be in a \"Stopped\" state. [async]", responseView = ResponseObject.ResponseView.Full, entityType = {VirtualMachine.class},
+@APICommand(name = "resetUserDataForVirtualMachine", responseObject = UserVmResponse.class, description = "Resets the UserData for Instance. " +
+ "The Instance must be in a \"Stopped\" state. [async]", responseView = ResponseObject.ResponseView.Full, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class ResetVMUserDataCmdAdmin extends ResetVMUserDataCmd implements AdminCmd {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/RestoreVMCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/RestoreVMCmdByAdmin.java
index b3ee39829ab..9a551653e62 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/RestoreVMCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/RestoreVMCmdByAdmin.java
@@ -24,7 +24,7 @@ import org.apache.cloudstack.api.response.UserVmResponse;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "restoreVirtualMachine", description = "Restore a VM to original template/ISO or new template/ISO", responseObject = UserVmResponse.class, since = "3.0.0", responseView = ResponseView.Full, entityType = {VirtualMachine.class},
+@APICommand(name = "restoreVirtualMachine", description = "Restore an Instance to original Template/ISO or new Template/ISO", responseObject = UserVmResponse.class, since = "3.0.0", responseView = ResponseView.Full, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false,
responseHasSensitiveInfo = true)
public class RestoreVMCmdByAdmin extends RestoreVMCmd implements AdminCmd {}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ScaleVMCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ScaleVMCmdByAdmin.java
index fd71a445954..6ed7a0cca8d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ScaleVMCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ScaleVMCmdByAdmin.java
@@ -25,6 +25,6 @@ import org.apache.cloudstack.api.response.SuccessResponse;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "scaleVirtualMachine", description = "Scales the virtual machine to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume.", responseObject = SuccessResponse.class, responseView = ResponseView.Full, entityType = {VirtualMachine.class},
+@APICommand(name = "scaleVirtualMachine", description = "Scales the Instance to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume.", responseObject = SuccessResponse.class, responseView = ResponseView.Full, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ScaleVMCmdByAdmin extends ScaleVMCmd implements AdminCmd {}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/StartVMCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/StartVMCmdByAdmin.java
index f87622cf734..30fab3b9382 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/StartVMCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/StartVMCmdByAdmin.java
@@ -24,6 +24,6 @@ import org.apache.cloudstack.api.response.UserVmResponse;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "startVirtualMachine", responseObject = UserVmResponse.class, description = "Starts a virtual machine.", responseView = ResponseView.Full, entityType = {VirtualMachine.class},
+@APICommand(name = "startVirtualMachine", responseObject = UserVmResponse.class, description = "Starts an Instance.", responseView = ResponseView.Full, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class StartVMCmdByAdmin extends StartVMCmd implements AdminCmd {}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/StopVMCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/StopVMCmdByAdmin.java
index 2f7cc2198ef..6dc1947712d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/StopVMCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/StopVMCmdByAdmin.java
@@ -24,6 +24,6 @@ import org.apache.cloudstack.api.response.UserVmResponse;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "stopVirtualMachine", responseObject = UserVmResponse.class, description = "Stops a virtual machine.", responseView = ResponseView.Full, entityType = {VirtualMachine.class},
+@APICommand(name = "stopVirtualMachine", responseObject = UserVmResponse.class, description = "Stops an Instance.", responseView = ResponseView.Full, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class StopVMCmdByAdmin extends StopVMCmd implements AdminCmd {}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/UnmanageVMInstanceCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/UnmanageVMInstanceCmd.java
index bbcb8840f66..81fbecce27a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/UnmanageVMInstanceCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/UnmanageVMInstanceCmd.java
@@ -44,7 +44,7 @@ import org.apache.cloudstack.vm.UnmanagedVMsManager;
import javax.inject.Inject;
@APICommand(name = "unmanageVirtualMachine",
- description = "Unmanage a guest virtual machine.",
+ description = "Unmanage a Guest Instance.",
entityType = {VirtualMachine.class},
responseObject = UnmanageVMInstanceResponse.class,
requestHasSensitiveInfo = false,
@@ -62,7 +62,7 @@ public class UnmanageVMInstanceCmd extends BaseAsyncCmd {
@Parameter(name = ApiConstants.ID, type = CommandType.UUID,
entityType = UserVmResponse.class, required = true,
- description = "The ID of the virtual machine to unmanage")
+ description = "The ID of the Instance to unmanage")
private Long vmId;
/////////////////////////////////////////////////////
@@ -80,7 +80,7 @@ public class UnmanageVMInstanceCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "unmanaging VM. VM ID = " + vmId;
+ return "Unmanaging Instance. Instance ID = " + vmId;
}
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/UpdateDefaultNicForVMCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/UpdateDefaultNicForVMCmdByAdmin.java
index 1c4dde93a22..a702eb264c8 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/UpdateDefaultNicForVMCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/UpdateDefaultNicForVMCmdByAdmin.java
@@ -24,6 +24,6 @@ import org.apache.cloudstack.api.response.UserVmResponse;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "updateDefaultNicForVirtualMachine", description = "Changes the default NIC on a VM", responseObject = UserVmResponse.class, responseView = ResponseView.Full, entityType = {VirtualMachine.class},
+@APICommand(name = "updateDefaultNicForVirtualMachine", description = "Changes the default NIC on an Instance", responseObject = UserVmResponse.class, responseView = ResponseView.Full, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class UpdateDefaultNicForVMCmdByAdmin extends UpdateDefaultNicForVMCmd implements AdminCmd {}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/UpdateVMCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/UpdateVMCmdByAdmin.java
index cb4bb0433d6..46f5824de25 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/UpdateVMCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/UpdateVMCmdByAdmin.java
@@ -25,8 +25,8 @@ import org.apache.cloudstack.api.response.UserVmResponse;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "updateVirtualMachine", description="Updates properties of a virtual machine. The VM has to be stopped and restarted for the " +
- "new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. " +
- "Therefore, stop the VM manually before issuing this call.", responseObject = UserVmResponse.class, responseView = ResponseView.Full, entityType = {VirtualMachine.class},
+@APICommand(name = "updateVirtualMachine", description = "Updates properties of an Instance. The Instance has to be stopped and restarted for the " +
+ "new properties to take effect. UpdateVirtualMachine does not first check whether the Instance is stopped. " +
+ "Therefore, stop the Instance manually before issuing this call.", responseObject = UserVmResponse.class, responseView = ResponseView.Full, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class UpdateVMCmdByAdmin extends UpdateVMCmd implements AdminCmd {}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/UpgradeVMCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/UpgradeVMCmdByAdmin.java
index f3230e64818..9bf8ccb454b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/UpgradeVMCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vm/UpgradeVMCmdByAdmin.java
@@ -25,8 +25,8 @@ import org.apache.cloudstack.api.response.UserVmResponse;
import com.cloud.vm.VirtualMachine;
@Deprecated(since = "4.18")
-@APICommand(name = "changeServiceForVirtualMachine", responseObject=UserVmResponse.class, description="(This API is deprecated, use scaleVirtualMachine API)" +
- "Changes the service offering for a virtual machine. The virtual machine must be in a \"Stopped\" state for " +
+@APICommand(name = "changeServiceForVirtualMachine", responseObject=UserVmResponse.class, description = "(This API is deprecated, use scaleVirtualMachine API)" +
+ "Changes the service offering for an Instance. The Instance must be in a \"Stopped\" state for " +
"this command to take effect.",
responseView = ResponseView.Full, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vmsnapshot/RevertToVMSnapshotCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vmsnapshot/RevertToVMSnapshotCmdByAdmin.java
index 8f286626b99..a57362d6205 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vmsnapshot/RevertToVMSnapshotCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vmsnapshot/RevertToVMSnapshotCmdByAdmin.java
@@ -22,6 +22,6 @@ import org.apache.cloudstack.api.command.admin.AdminCmd;
import org.apache.cloudstack.api.command.user.vmsnapshot.RevertToVMSnapshotCmd;
import org.apache.cloudstack.api.response.UserVmResponse;
-@APICommand(name = "revertToVMSnapshot", description = "Revert VM from a vmsnapshot.", responseObject = UserVmResponse.class, since = "4.2.0", responseView = ResponseView.Full,
+@APICommand(name = "revertToVMSnapshot", description = "Revert Instance from a vmsnapshot.", responseObject = UserVmResponse.class, since = "4.2.0", responseView = ResponseView.Full,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class RevertToVMSnapshotCmdByAdmin extends RevertToVMSnapshotCmd implements AdminCmd {}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/volume/AttachVolumeCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/volume/AttachVolumeCmdByAdmin.java
index 6f31df79e1c..20418d58940 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/volume/AttachVolumeCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/volume/AttachVolumeCmdByAdmin.java
@@ -24,6 +24,6 @@ import org.apache.cloudstack.api.response.VolumeResponse;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "attachVolume", description = "Attaches a disk volume to a virtual machine.", responseObject = VolumeResponse.class, responseView = ResponseView.Full, entityType = {VirtualMachine.class},
+@APICommand(name = "attachVolume", description = "Attaches a disk volume to an Instance.", responseObject = VolumeResponse.class, responseView = ResponseView.Full, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class AttachVolumeCmdByAdmin extends AttachVolumeCmd implements AdminCmd {}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/volume/CreateVolumeCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/volume/CreateVolumeCmdByAdmin.java
index c0dfe42acb5..e156475b29a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/volume/CreateVolumeCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/volume/CreateVolumeCmdByAdmin.java
@@ -25,7 +25,7 @@ import org.apache.cloudstack.api.response.VolumeResponse;
import com.cloud.storage.Volume;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "createVolume", responseObject = VolumeResponse.class, description = "Creates a disk volume from a disk offering. This disk volume must still be attached to a virtual machine to make use of it.", responseView = ResponseView.Full, entityType = {
+@APICommand(name = "createVolume", responseObject = VolumeResponse.class, description = "Creates a disk volume from a disk offering. This disk volume must still be attached to an Instance to make use of it.", responseView = ResponseView.Full, entityType = {
Volume.class, VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class CreateVolumeCmdByAdmin extends CreateVolumeCmd implements AdminCmd {}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/volume/DetachVolumeCmdByAdmin.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/volume/DetachVolumeCmdByAdmin.java
index 36a183bc89f..05f9fe6a31a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/volume/DetachVolumeCmdByAdmin.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/volume/DetachVolumeCmdByAdmin.java
@@ -24,6 +24,6 @@ import org.apache.cloudstack.api.response.VolumeResponse;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "detachVolume", description = "Detaches a disk volume from a virtual machine.", responseObject = VolumeResponse.class, responseView = ResponseView.Full, entityType = {VirtualMachine.class},
+@APICommand(name = "detachVolume", description = "Detaches a disk volume from an Instance.", responseObject = VolumeResponse.class, responseView = ResponseView.Full, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class DetachVolumeCmdByAdmin extends DetachVolumeCmd implements AdminCmd {}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vpc/CreatePrivateGatewayByAdminCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vpc/CreatePrivateGatewayByAdminCmd.java
index 1b2163853ec..09f0d21d9df 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vpc/CreatePrivateGatewayByAdminCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vpc/CreatePrivateGatewayByAdminCmd.java
@@ -44,13 +44,13 @@ public class CreatePrivateGatewayByAdminCmd extends CreatePrivateGatewayCmd impl
@Parameter(name = ApiConstants.PHYSICAL_NETWORK_ID,
type = CommandType.UUID,
entityType = PhysicalNetworkResponse.class,
- description = "the Physical Network ID the network belongs to")
+ description = "The Physical Network ID the network belongs to")
private Long physicalNetworkId;
- @Parameter(name = ApiConstants.VLAN, type = CommandType.STRING, description = "the network implementation uri for the private gateway")
+ @Parameter(name = ApiConstants.VLAN, type = CommandType.STRING, description = "The network implementation uri for the private gateway")
private String broadcastUri;
- @Parameter(name = ApiConstants.BYPASS_VLAN_OVERLAP_CHECK, type = CommandType.BOOLEAN, description = "when true bypasses VLAN id/range overlap check during private gateway creation")
+ @Parameter(name = ApiConstants.BYPASS_VLAN_OVERLAP_CHECK, type = CommandType.BOOLEAN, description = "When true bypasses VLAN id/range overlap check during private gateway creation")
private Boolean bypassVlanOverlapCheck;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vpc/CreateVPCOfferingCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vpc/CreateVPCOfferingCmd.java
index 73b4f5df196..76b1ee6ad77 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vpc/CreateVPCOfferingCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vpc/CreateVPCOfferingCmd.java
@@ -66,49 +66,49 @@ public class CreateVPCOfferingCmd extends BaseAsyncCreateCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "the name of the vpc offering")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "The name of the VPC offering")
private String vpcOfferingName;
- @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "the display text of the vpc offering, defaults to the 'name'")
+ @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "The display text of the VPC offering, defaults to the 'name'")
private String displayText;
@Parameter(name = ApiConstants.SUPPORTED_SERVICES,
type = CommandType.LIST,
collectionType = CommandType.STRING,
- description = "services supported by the vpc offering")
+ description = "Services supported by the VPC offering")
private List supportedServices;
- @Parameter(name = ApiConstants.SERVICE_PROVIDER_LIST, type = CommandType.MAP, description = "provider to service mapping. "
+ @Parameter(name = ApiConstants.SERVICE_PROVIDER_LIST, type = CommandType.MAP, description = "Provider to service mapping. "
+ "If not specified, the provider for the service will be mapped to the default provider on the physical network")
private Map> serviceProviderList;
- @Parameter(name = ApiConstants.SERVICE_CAPABILITY_LIST, type = CommandType.MAP, description = "desired service capabilities as part of vpc offering", since = "4.4")
+ @Parameter(name = ApiConstants.SERVICE_CAPABILITY_LIST, type = CommandType.MAP, description = "Desired service capabilities as part of VPC offering", since = "4.4")
private Map> serviceCapabilityList;
@Parameter(name = ApiConstants.INTERNET_PROTOCOL,
type = CommandType.STRING,
- description = "The internet protocol of the offering. Options are ipv4 and dualstack. Default is ipv4. dualstack will create an offering that supports both IPv4 and IPv6",
+ description = "The internet protocol of the offering. Options are IPv4 and dualstack. Default is IPv4. dualstack will create an offering that supports both IPv4 and IPv6",
since = "4.17.0")
private String internetProtocol;
@Parameter(name = ApiConstants.SERVICE_OFFERING_ID,
type = CommandType.UUID,
entityType = ServiceOfferingResponse.class,
- description = "the ID of the service offering for the VPC router appliance")
+ description = "The ID of the service offering for the VPC router appliance")
private Long serviceOfferingId;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = DomainResponse.class,
- description = "the ID of the containing domain(s), null for public offerings")
+ description = "The ID of the containing domain(s), null for public offerings")
private List domainIds;
@Parameter(name = ApiConstants.ZONE_ID,
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = ZoneResponse.class,
- description = "the ID of the containing zone(s), null for public offerings",
+ description = "The ID of the containing zone(s), null for public offerings",
since = "4.13")
private List zoneIds;
@@ -126,7 +126,7 @@ public class CreateVPCOfferingCmd extends BaseAsyncCreateCmd {
@Parameter(name = ApiConstants.ENABLE,
type = CommandType.BOOLEAN,
- description = "set to true if the offering is to be enabled during creation. Default is false",
+ description = "Set to true if the offering is to be enabled during creation. Default is false",
since = "4.16")
private Boolean enable;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vpc/DeletePrivateGatewayCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vpc/DeletePrivateGatewayCmd.java
index d104edc381b..cd88d81da67 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vpc/DeletePrivateGatewayCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vpc/DeletePrivateGatewayCmd.java
@@ -45,7 +45,7 @@ public class DeletePrivateGatewayCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = PrivateGatewayResponse.class, required = true, description = "the ID of the private gateway")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = PrivateGatewayResponse.class, required = true, description = "The ID of the private gateway")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vpc/DeleteVPCOfferingCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vpc/DeleteVPCOfferingCmd.java
index 6aa0c3f3afc..b322a6d5589 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vpc/DeleteVPCOfferingCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vpc/DeleteVPCOfferingCmd.java
@@ -38,7 +38,7 @@ public class DeleteVPCOfferingCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VpcOfferingResponse.class, required = true, description = "the ID of the VPC offering")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VpcOfferingResponse.class, required = true, description = "The ID of the VPC offering")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/vpc/UpdateVPCOfferingCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/vpc/UpdateVPCOfferingCmd.java
index b59837281ef..b8a8077b30b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/vpc/UpdateVPCOfferingCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/vpc/UpdateVPCOfferingCmd.java
@@ -44,31 +44,31 @@ public class UpdateVPCOfferingCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VpcOfferingResponse.class, required = true, description = "the id of the VPC offering")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VpcOfferingResponse.class, required = true, description = "The ID of the VPC offering")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the VPC offering")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the VPC offering")
private String vpcOffName;
- @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "the display text of the VPC offering")
+ @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "The display text of the VPC offering")
private String displayText;
- @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "update state for the VPC offering; " + "supported states - Enabled/Disabled")
+ @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "Update state for the VPC offering; " + "supported states - Enabled/Disabled")
private String state;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.STRING,
- description = "the ID of the containing domain(s) as comma separated string, public for public offerings",
+ description = "The ID of the containing domain(s) as comma separated string, public for public offerings",
length = 4096)
private String domainIds;
@Parameter(name = ApiConstants.ZONE_ID,
type = CommandType.STRING,
- description = "the ID of the containing zone(s) as comma separated string, all for all zones offerings",
+ description = "The ID of the containing zone(s) as comma separated string, all for all zones offerings",
since = "4.13")
private String zoneIds;
- @Parameter(name = ApiConstants.SORT_KEY, type = CommandType.INTEGER, description = "sort key of the VPC offering, integer")
+ @Parameter(name = ApiConstants.SORT_KEY, type = CommandType.INTEGER, description = "Sort key of the VPC offering, integer")
private Integer sortKey;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/zone/CreateZoneCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/zone/CreateZoneCmd.java
index 24660e41ed9..1066c614af8 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/zone/CreateZoneCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/zone/CreateZoneCmd.java
@@ -40,28 +40,28 @@ public class CreateZoneCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.DNS1, type = CommandType.STRING, required = true, description = "the first DNS for the Zone")
+ @Parameter(name = ApiConstants.DNS1, type = CommandType.STRING, required = true, description = "The first DNS for the Zone")
private String dns1;
- @Parameter(name = ApiConstants.DNS2, type = CommandType.STRING, description = "the second DNS for the Zone")
+ @Parameter(name = ApiConstants.DNS2, type = CommandType.STRING, description = "The second DNS for the Zone")
private String dns2;
- @Parameter(name = ApiConstants.IP6_DNS1, type = CommandType.STRING, description = "the first DNS for IPv6 network in the Zone")
+ @Parameter(name = ApiConstants.IP6_DNS1, type = CommandType.STRING, description = "The first DNS for IPv6 network in the Zone")
private String ip6Dns1;
- @Parameter(name = ApiConstants.IP6_DNS2, type = CommandType.STRING, description = "the second DNS for IPv6 network in the Zone")
+ @Parameter(name = ApiConstants.IP6_DNS2, type = CommandType.STRING, description = "The second DNS for IPv6 network in the Zone")
private String ip6Dns2;
- @Parameter(name = ApiConstants.GUEST_CIDR_ADDRESS, type = CommandType.STRING, description = "the guest CIDR address for the Zone")
+ @Parameter(name = ApiConstants.GUEST_CIDR_ADDRESS, type = CommandType.STRING, description = "The guest CIDR address for the Zone")
private String guestCidrAddress;
- @Parameter(name = ApiConstants.INTERNAL_DNS1, type = CommandType.STRING, required = true, description = "the first internal DNS for the Zone")
+ @Parameter(name = ApiConstants.INTERNAL_DNS1, type = CommandType.STRING, required = true, description = "The first internal DNS for the Zone")
private String internalDns1;
- @Parameter(name = ApiConstants.INTERNAL_DNS2, type = CommandType.STRING, description = "the second internal DNS for the Zone")
+ @Parameter(name = ApiConstants.INTERNAL_DNS2, type = CommandType.STRING, description = "The second internal DNS for the Zone")
private String internalDns2;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "the name of the Zone")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "The name of the Zone")
private String zoneName;
@Parameter(name = ApiConstants.DOMAIN, type = CommandType.STRING, description = "Network domain name for the networks in the zone")
@@ -70,22 +70,22 @@ public class CreateZoneCmd extends BaseCmd {
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "the ID of the containing domain, null for public zones")
+ description = "The ID of the containing domain, null for public zones")
private Long domainId;
- @Parameter(name = ApiConstants.NETWORK_TYPE, type = CommandType.STRING, required = true, description = "network type of the zone, can be Basic or Advanced")
+ @Parameter(name = ApiConstants.NETWORK_TYPE, type = CommandType.STRING, required = true, description = "Network type of the zone, can be Basic or Advanced")
private String networkType;
@Parameter(name = ApiConstants.ALLOCATION_STATE, type = CommandType.STRING, description = "Allocation state of this Zone for allocation of new resources")
private String allocationState;
- @Parameter(name = ApiConstants.SECURITY_GROUP_EANBLED, type = CommandType.BOOLEAN, description = "true if network is security group enabled, false otherwise")
+ @Parameter(name = ApiConstants.SECURITY_GROUP_EANBLED, type = CommandType.BOOLEAN, description = "True if network is security group enabled, false otherwise")
private Boolean securitygroupenabled;
- @Parameter(name = ApiConstants.LOCAL_STORAGE_ENABLED, type = CommandType.BOOLEAN, description = "true if local storage offering enabled, false otherwise")
+ @Parameter(name = ApiConstants.LOCAL_STORAGE_ENABLED, type = CommandType.BOOLEAN, description = "True if local storage offering enabled, false otherwise")
private Boolean localStorageEnabled;
- @Parameter(name = ApiConstants.IS_EDGE, type = CommandType.BOOLEAN, description = "true if the zone is an edge zone, false otherwise", since = "4.18.0")
+ @Parameter(name = ApiConstants.IS_EDGE, type = CommandType.BOOLEAN, description = "True if the zone is an edge zone, false otherwise", since = "4.18.0")
private Boolean isEdge;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/zone/DeleteZoneCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/zone/DeleteZoneCmd.java
index b89636c6fe5..565baab6e4c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/zone/DeleteZoneCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/zone/DeleteZoneCmd.java
@@ -38,7 +38,7 @@ public class DeleteZoneCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ZoneResponse.class, required = true, description = "the ID of the Zone")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ZoneResponse.class, required = true, description = "The ID of the Zone")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/admin/zone/UpdateZoneCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/admin/zone/UpdateZoneCmd.java
index 1b2793d3e15..3e7fffb5faf 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/admin/zone/UpdateZoneCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/admin/zone/UpdateZoneCmd.java
@@ -42,43 +42,43 @@ public class UpdateZoneCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.DNS1, type = CommandType.STRING, description = "the first DNS for the Zone")
+ @Parameter(name = ApiConstants.DNS1, type = CommandType.STRING, description = "The first DNS for the Zone")
private String dns1;
- @Parameter(name = ApiConstants.DNS2, type = CommandType.STRING, description = "the second DNS for the Zone")
+ @Parameter(name = ApiConstants.DNS2, type = CommandType.STRING, description = "The second DNS for the Zone")
private String dns2;
- @Parameter(name = ApiConstants.IP6_DNS1, type = CommandType.STRING, description = "the first DNS for IPv6 network in the Zone")
+ @Parameter(name = ApiConstants.IP6_DNS1, type = CommandType.STRING, description = "The first DNS for IPv6 network in the Zone")
private String ip6Dns1;
- @Parameter(name = ApiConstants.IP6_DNS2, type = CommandType.STRING, description = "the second DNS for IPv6 network in the Zone")
+ @Parameter(name = ApiConstants.IP6_DNS2, type = CommandType.STRING, description = "The second DNS for IPv6 network in the Zone")
private String ip6Dns2;
- @Parameter(name = ApiConstants.GUEST_CIDR_ADDRESS, type = CommandType.STRING, description = "the guest CIDR address for the Zone")
+ @Parameter(name = ApiConstants.GUEST_CIDR_ADDRESS, type = CommandType.STRING, description = "The guest CIDR address for the Zone")
private String guestCidrAddress;
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ZoneResponse.class, required = true, description = "the ID of the Zone")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ZoneResponse.class, required = true, description = "The ID of the Zone")
private Long id;
- @Parameter(name = ApiConstants.INTERNAL_DNS1, type = CommandType.STRING, description = "the first internal DNS for the Zone")
+ @Parameter(name = ApiConstants.INTERNAL_DNS1, type = CommandType.STRING, description = "The first internal DNS for the Zone")
private String internalDns1;
- @Parameter(name = ApiConstants.INTERNAL_DNS2, type = CommandType.STRING, description = "the second internal DNS for the Zone")
+ @Parameter(name = ApiConstants.INTERNAL_DNS2, type = CommandType.STRING, description = "The second internal DNS for the Zone")
private String internalDns2;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the Zone")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the Zone")
private String zoneName;
- @Parameter(name = ApiConstants.IS_PUBLIC, type = CommandType.BOOLEAN, description = "updates a private zone to public if set, but not vice-versa")
+ @Parameter(name = ApiConstants.IS_PUBLIC, type = CommandType.BOOLEAN, description = "Updates a private zone to public if set, but not vice-versa")
private Boolean isPublic;
@Parameter(name = ApiConstants.ALLOCATION_STATE, type = CommandType.STRING, description = "Allocation state of this cluster for allocation of new resources")
private String allocationState;
- @Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "the details for the Zone")
+ @Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "The details for the Zone")
private Map details;
- @Parameter(name = ApiConstants.DHCP_PROVIDER, type = CommandType.STRING, description = "the dhcp Provider for the Zone")
+ @Parameter(name = ApiConstants.DHCP_PROVIDER, type = CommandType.STRING, description = "The DHCP Provider for the Zone")
private String dhcpProvider;
@Parameter(name = ApiConstants.DOMAIN,
@@ -86,13 +86,13 @@ public class UpdateZoneCmd extends BaseCmd {
description = "Network domain name for the networks in the zone; empty string will update domain with NULL value")
private String domain;
- @Parameter(name = ApiConstants.DNS_SEARCH_ORDER, type = CommandType.LIST, collectionType = CommandType.STRING, description = "the dns search order list")
+ @Parameter(name = ApiConstants.DNS_SEARCH_ORDER, type = CommandType.LIST, collectionType = CommandType.STRING, description = "The DNS search order list")
private List dnsSearchOrder;
- @Parameter(name = ApiConstants.LOCAL_STORAGE_ENABLED, type = CommandType.BOOLEAN, description = "true if local storage offering enabled, false otherwise")
+ @Parameter(name = ApiConstants.LOCAL_STORAGE_ENABLED, type = CommandType.BOOLEAN, description = "True if local storage offering enabled, false otherwise")
private Boolean localStorageEnabled;
- @Parameter(name = ApiConstants.SORT_KEY, type = CommandType.INTEGER, description = "sort key of the zone, integer")
+ @Parameter(name = ApiConstants.SORT_KEY, type = CommandType.INTEGER, description = "Sort key of the zone, integer")
private Integer sortKey;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/account/AddAccountToProjectCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/account/AddAccountToProjectCmd.java
index 2fbcb6df1cc..93021487040 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/account/AddAccountToProjectCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/account/AddAccountToProjectCmd.java
@@ -40,7 +40,7 @@ import com.cloud.exception.InvalidParameterValueException;
import com.cloud.projects.Project;
import com.cloud.projects.ProjectAccount;
-@APICommand(name = "addAccountToProject", description = "Adds account to a project", responseObject = SuccessResponse.class, since = "3.0.0",
+@APICommand(name = "addAccountToProject", description = "Adds Account to a project", responseObject = SuccessResponse.class, since = "3.0.0",
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class AddAccountToProjectCmd extends BaseAsyncCmd {
@@ -53,13 +53,13 @@ public class AddAccountToProjectCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = ProjectResponse.class,
required = true,
- description = "ID of the project to add the account to")
+ description = "ID of the project to add the Account to")
private Long projectId;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "name of the account to be added to the project")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "Name of the Account to be added to the project")
private String accountName;
- @Parameter(name = ApiConstants.EMAIL, type = CommandType.STRING, description = "email to which invitation to the project is going to be sent")
+ @Parameter(name = ApiConstants.EMAIL, type = CommandType.STRING, description = "Email to which invitation to the project is going to be sent")
private String email;
@Parameter(name = ApiConstants.PROJECT_ROLE_ID, type = CommandType.UUID, entityType = ProjectRoleResponse.class,
@@ -67,7 +67,7 @@ public class AddAccountToProjectCmd extends BaseAsyncCmd {
private Long projectRoleId;
@Parameter(name = ApiConstants.ROLE_TYPE, type = BaseCmd.CommandType.STRING,
- description = "Project role type to be assigned to the user - Admin/Regular; default: Regular")
+ description = "Project role type to be assigned to the User - Admin/Regular; default: Regular")
private String roleType;
/////////////////////////////////////////////////////
@@ -117,7 +117,7 @@ public class AddAccountToProjectCmd extends BaseAsyncCmd {
SuccessResponse response = new SuccessResponse(getCommandName());
this.setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to add account to the project");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to add Account to the project");
}
}
@@ -147,7 +147,7 @@ public class AddAccountToProjectCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
if (accountName != null) {
- return "Adding account " + getAccountName() + " to project: " + getProjectId();
+ return "Adding Account " + getAccountName() + " to project: " + getProjectId();
} else {
return "Sending invitation to email " + email + " to join project: " + getProjectId();
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/account/AddUserToProjectCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/account/AddUserToProjectCmd.java
index 9cd845c774c..9bdc85bc5c7 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/account/AddUserToProjectCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/account/AddUserToProjectCmd.java
@@ -38,7 +38,7 @@ import com.cloud.event.EventTypes;
import com.cloud.exception.InvalidParameterValueException;
import com.cloud.projects.ProjectAccount;
-@APICommand(name = "addUserToProject", description = "Adds user to a project", responseObject = SuccessResponse.class, since = "4.14",
+@APICommand(name = "addUserToProject", description = "Adds User to a project", responseObject = SuccessResponse.class, since = "4.14",
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false, authorized = {RoleType.Admin, RoleType.DomainAdmin, RoleType.ResourceAdmin, RoleType.User})
public class AddUserToProjectCmd extends BaseAsyncCmd {
@@ -50,13 +50,13 @@ public class AddUserToProjectCmd extends BaseAsyncCmd {
type = BaseCmd.CommandType.UUID,
entityType = ProjectResponse.class,
required = true,
- description = "ID of the project to add the user to")
+ description = "ID of the project to add the User to")
private Long projectId;
- @Parameter(name = ApiConstants.USERNAME, type = CommandType.STRING, required = true, description = "Name of the user to be added to the project")
+ @Parameter(name = ApiConstants.USERNAME, type = CommandType.STRING, required = true, description = "Name of the User to be added to the project")
private String username;
- @Parameter(name = ApiConstants.EMAIL, type = CommandType.STRING, description = "email ID of user to which invitation to the project is going to be sent")
+ @Parameter(name = ApiConstants.EMAIL, type = CommandType.STRING, description = "Email ID of User to which invitation to the project is going to be sent")
private String email;
@Parameter(name = ApiConstants.PROJECT_ROLE_ID, type = BaseCmd.CommandType.UUID, entityType = ProjectRoleResponse.class,
@@ -64,7 +64,7 @@ public class AddUserToProjectCmd extends BaseAsyncCmd {
private Long projectRoleId;
@Parameter(name = ApiConstants.ROLE_TYPE, type = BaseCmd.CommandType.STRING,
- description = "Project role type to be assigned to the user - Admin/Regular")
+ description = "Project role type to be assigned to the User - Admin/Regular")
private String roleType;
/////////////////////////////////////////////////////
@@ -103,7 +103,7 @@ public class AddUserToProjectCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "Adding user " + getUsername() + " to project: " + getProjectId();
+ return "Adding User " + getUsername() + " to Project: " + getProjectId();
}
/////////////////////////////////////////////////////
@@ -118,7 +118,7 @@ public class AddUserToProjectCmd extends BaseAsyncCmd {
SuccessResponse response = new SuccessResponse(getCommandName());
this.setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to add account to the project");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to add Account to the project");
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/account/DeleteAccountFromProjectCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/account/DeleteAccountFromProjectCmd.java
index 5e0977938a3..510f97ff743 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/account/DeleteAccountFromProjectCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/account/DeleteAccountFromProjectCmd.java
@@ -34,7 +34,7 @@ import com.cloud.event.EventTypes;
import com.cloud.exception.InvalidParameterValueException;
import com.cloud.projects.Project;
-@APICommand(name = "deleteAccountFromProject", description = "Deletes account from the project", responseObject = SuccessResponse.class, since = "3.0.0",
+@APICommand(name = "deleteAccountFromProject", description = "Deletes Account from the project", responseObject = SuccessResponse.class, since = "3.0.0",
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class DeleteAccountFromProjectCmd extends BaseAsyncCmd {
@@ -46,10 +46,10 @@ public class DeleteAccountFromProjectCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = ProjectResponse.class,
required = true,
- description = "ID of the project to remove the account from")
+ description = "ID of the project to remove the Account from")
private Long projectId;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, required = true, description = "name of the account to be removed from the project")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, required = true, description = "Name of the Account to be removed from the project")
private String accountName;
/////////////////////////////////////////////////////
@@ -76,7 +76,7 @@ public class DeleteAccountFromProjectCmd extends BaseAsyncCmd {
SuccessResponse response = new SuccessResponse(getCommandName());
this.setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to delete account from the project");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to delete Account from the project");
}
}
@@ -103,7 +103,7 @@ public class DeleteAccountFromProjectCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "Removing account " + accountName + " from project: " + projectId;
+ return "Removing Account " + accountName + " from project: " + projectId;
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/account/DeleteUserFromProjectCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/account/DeleteUserFromProjectCmd.java
index 0731d837804..5db604fe05c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/account/DeleteUserFromProjectCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/account/DeleteUserFromProjectCmd.java
@@ -37,7 +37,7 @@ import com.cloud.event.EventTypes;
import com.cloud.exception.InvalidParameterValueException;
import com.cloud.projects.Project;
-@APICommand(name = "deleteUserFromProject", description = "Deletes user from the project", responseObject = SuccessResponse.class, since = "4.15.0",
+@APICommand(name = "deleteUserFromProject", description = "Deletes User from the project", responseObject = SuccessResponse.class, since = "4.15.0",
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false, authorized = {RoleType.Admin, RoleType.DomainAdmin, RoleType.ResourceAdmin, RoleType.User})
public class DeleteUserFromProjectCmd extends BaseAsyncCmd {
@@ -48,11 +48,11 @@ public class DeleteUserFromProjectCmd extends BaseAsyncCmd {
type = BaseCmd.CommandType.UUID,
entityType = ProjectResponse.class,
required = true,
- description = "ID of the project to remove the user from")
+ description = "ID of the project to remove the User from")
private Long projectId;
@Parameter(name = ApiConstants.USER_ID, type = BaseCmd.CommandType.UUID, entityType = UserResponse.class,
- required = true, description = "Id of the user to be removed from the project")
+ required = true, description = "Id of the User to be removed from the project")
private Long userId;
/////////////////////////////////////////////////////
@@ -78,7 +78,7 @@ public class DeleteUserFromProjectCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "Removing user " + userId + " from project: " + projectId;
+ return "Removing User " + userId + " from project: " + projectId;
}
@Override
@@ -107,13 +107,13 @@ public class DeleteUserFromProjectCmd extends BaseAsyncCmd {
@Override
public void execute() {
- CallContext.current().setEventDetails("Project ID: " + projectId + "; user ID: " + userId);
+ CallContext.current().setEventDetails("Project ID: " + projectId + "; User ID: " + userId);
boolean result = _projectService.deleteUserFromProject(getProjectId(), getUserId());
if (result) {
SuccessResponse response = new SuccessResponse(getCommandName());
this.setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to delete account from the project");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to delete Account from the project");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/account/ListAccountsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/account/ListAccountsCmd.java
index bd9ab30f4f1..dd0ece87890 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/account/ListAccountsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/account/ListAccountsCmd.java
@@ -39,7 +39,7 @@ import com.cloud.server.ResourceIcon;
import com.cloud.server.ResourceTag;
import com.cloud.user.Account;
-@APICommand(name = "listAccounts", description = "Lists accounts and provides detailed account information for listed accounts", responseObject = AccountResponse.class, responseView = ResponseView.Restricted, entityType = {Account.class},
+@APICommand(name = "listAccounts", description = "Lists Accounts and provides detailed Account information for listed Accounts", responseObject = AccountResponse.class, responseView = ResponseView.Restricted, entityType = {Account.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class ListAccountsCmd extends BaseListDomainResourcesCmd implements UserCmd {
private static final String s_name = "listaccountsresponse";
@@ -50,32 +50,32 @@ public class ListAccountsCmd extends BaseListDomainResourcesCmd implements UserC
@Parameter(name = ApiConstants.ACCOUNT_TYPE,
type = CommandType.INTEGER,
- description = "list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).")
+ description = "List Accounts by Account type. Valid Account types are 1 (admin), 2 (domain-admin), and 0 (user).")
private Integer accountType;
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = AccountResponse.class, description = "list account by account ID")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = AccountResponse.class, description = "List Account by Account ID")
private Long id;
- @Parameter(name = ApiConstants.IS_CLEANUP_REQUIRED, type = CommandType.BOOLEAN, description = "list accounts by cleanuprequired attribute (values are true or false)")
+ @Parameter(name = ApiConstants.IS_CLEANUP_REQUIRED, type = CommandType.BOOLEAN, description = "List accounts by cleanuprequired attribute (values are true or false)")
private Boolean cleanupRequired;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "list account by account name")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "List account by account name")
private String searchName;
- @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "list accounts by state. Valid states are enabled, disabled, and locked.")
+ @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "List accounts by state. Valid states are enabled, disabled, and locked.")
private String state;
@Parameter(name = ApiConstants.DETAILS,
type = CommandType.LIST,
collectionType = CommandType.STRING,
- description = "comma separated list of account details requested, value can be a list of [ all, resource, min]")
+ description = "Comma separated list of account details requested, value can be a list of [ all, resource, min]")
private List viewDetails;
@Parameter(name = ApiConstants.API_KEY_ACCESS, type = CommandType.STRING, description = "List accounts by the Api key access value", since = "4.20.1.0", authorized = {RoleType.Admin})
private String apiKeyAccess;
@Parameter(name = ApiConstants.SHOW_RESOURCE_ICON, type = CommandType.BOOLEAN,
- description = "flag to display the resource icon for accounts")
+ description = "Flag to display the resource icon for accounts")
private Boolean showIcon;
@Parameter(name = ApiConstants.TAG, type = CommandType.STRING, description = "Tag for resource type to return usage", since = "4.20.0")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/account/ListProjectAccountsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/account/ListProjectAccountsCmd.java
index 21aedc7d772..aeacf7c60d5 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/account/ListProjectAccountsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/account/ListProjectAccountsCmd.java
@@ -29,7 +29,7 @@ import org.apache.cloudstack.api.response.UserResponse;
import com.cloud.user.Account;
-@APICommand(name = "listProjectAccounts", description = "Lists project's accounts", responseObject = ProjectResponse.class, since = "3.0.0",
+@APICommand(name = "listProjectAccounts", description = "Lists project's Accounts", responseObject = ProjectResponse.class, since = "3.0.0",
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListProjectAccountsCmd extends BaseListCmd {
@@ -41,16 +41,16 @@ public class ListProjectAccountsCmd extends BaseListCmd {
@Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, required = true, description = "ID of the project")
private Long projectId;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "list accounts of the project by account name")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "List Accounts of the project by Account name")
private String accountName;
- @Parameter(name = ApiConstants.USER_ID, type = CommandType.UUID, entityType = UserResponse.class, description = "list invitation by user ID")
+ @Parameter(name = ApiConstants.USER_ID, type = CommandType.UUID, entityType = UserResponse.class, description = "List invitation by User ID")
private Long userId;
- @Parameter(name = ApiConstants.ROLE, type = CommandType.STRING, description = "list accounts of the project by role")
+ @Parameter(name = ApiConstants.ROLE, type = CommandType.STRING, description = "List Accounts of the project by role")
private String role;
- @Parameter(name = ApiConstants.PROJECT_ROLE_ID, type = CommandType.UUID, entityType = ProjectRoleResponse.class, description = "list accounts of the project by project role id")
+ @Parameter(name = ApiConstants.PROJECT_ROLE_ID, type = CommandType.UUID, entityType = ProjectRoleResponse.class, description = "List Accounts of the project by project role id")
private Long projectRoleId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/address/AssociateIPAddrCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/address/AssociateIPAddrCmd.java
index 5ea14478516..c18d08299c3 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/address/AssociateIPAddrCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/address/AssociateIPAddrCmd.java
@@ -58,7 +58,7 @@ import com.cloud.projects.Project;
import com.cloud.user.Account;
@APICommand(name = "associateIpAddress",
- description = "Acquires and associates a public IP to an account. Either of the parameters are required, i.e. either zoneId, or networkId, or vpcId ",
+ description = "Acquires and associates a public IP to an Account. Either of the parameters are required, i.e. either zoneId, or networkId, or vpcId ",
responseObject = IPAddressResponse.class,
responseView = ResponseView.Restricted,
requestHasSensitiveInfo = false,
@@ -72,58 +72,58 @@ public class AssociateIPAddrCmd extends BaseAsyncCreateCmd implements UserCmd {
@Parameter(name = ApiConstants.ACCOUNT,
type = CommandType.STRING,
- description = "the account to associate with this IP address")
+ description = "The Account to associate with this IP address")
private String accountName;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "the ID of the domain to associate with this IP address")
+ description = "The ID of the domain to associate with this IP address")
private Long domainId;
@Parameter(name = ApiConstants.ZONE_ID,
type = CommandType.UUID,
entityType = ZoneResponse.class,
- description = "the ID of the availability zone you want to acquire an public IP address from")
+ description = "The ID of the availability zone you want to acquire an public IP address from")
private Long zoneId;
@Parameter(name = ApiConstants.NETWORK_ID,
type = CommandType.UUID,
entityType = NetworkResponse.class,
- description = "The network this IP address should be associated to.")
+ description = "The Network this IP address should be associated to.")
private Long networkId;
@Parameter(name = ApiConstants.PROJECT_ID,
type = CommandType.UUID,
entityType = ProjectResponse.class,
- description = "Deploy VM for the project")
+ description = "Deploy Instance for the project")
private Long projectId;
@Parameter(name = ApiConstants.VPC_ID,
type = CommandType.UUID,
entityType = VpcResponse.class,
- description = "the VPC you want the IP address to be associated with")
+ description = "The VPC you want the IP address to be associated with")
private Long vpcId;
@Parameter(name = ApiConstants.IS_PORTABLE,
type = BaseCmd.CommandType.BOOLEAN,
- description = "should be set to true if public IP is required to be transferable across zones, if not specified defaults to false")
+ description = "Should be set to true if public IP is required to be transferable across zones, if not specified defaults to false")
private Boolean isPortable;
@Parameter(name = ApiConstants.REGION_ID,
type = CommandType.INTEGER,
entityType = RegionResponse.class,
required = false,
- description = "region ID from where portable IP is to be associated.")
+ description = "Region ID from where portable IP is to be associated.")
private Integer regionId;
@Parameter(name = ApiConstants.FOR_DISPLAY,
type = CommandType.BOOLEAN,
- description = "an optional field, whether to the display the IP to the end user or not", since = "4.4",
+ description = "An optional field, whether to the display the IP to the end User or not", since = "4.4",
authorized = {RoleType.Admin})
private Boolean display;
- @Parameter(name=ApiConstants.IP_ADDRESS, type=CommandType.STRING, description="IP Address to be associated")
+ @Parameter(name=ApiConstants.IP_ADDRESS, type=CommandType.STRING, description = "IP Address to be associated")
private String ipAddress;
/////////////////////////////////////////////////////
@@ -198,21 +198,21 @@ public class AssociateIPAddrCmd extends BaseAsyncCreateCmd implements UserCmd {
List networks = _networkService.getIsolatedNetworksOwnedByAccountInZone(getZoneId(), _accountService.getAccount(getEntityOwnerId()));
if (networks.size() == 0) {
String domain = _domainService.getDomain(getDomainId()).getName();
- throw new InvalidParameterValueException("Account name=" + getAccountName() + " domain=" + domain + " doesn't have virtual networks in zone=" +
+ throw new InvalidParameterValueException("Account name=" + getAccountName() + " domain=" + domain + " doesn't have virtual Networks in zone=" +
zone.getName());
}
if (networks.size() < 1) {
- throw new InvalidParameterValueException("Account doesn't have any isolated networks in the zone");
+ throw new InvalidParameterValueException("Account doesn't have any isolated Networks in the zone");
} else if (networks.size() > 1) {
- throw new InvalidParameterValueException("Account has more than one isolated network in the zone");
+ throw new InvalidParameterValueException("Account has more than one isolated Network in the zone");
}
return networks.get(0).getId();
} else {
Network defaultGuestNetwork = _networkService.getExclusiveGuestNetwork(zoneId);
if (defaultGuestNetwork == null) {
- throw new InvalidParameterValueException("Unable to find a default guest network for account " + getAccountName() + " in domain ID=" + getDomainId());
+ throw new InvalidParameterValueException("Unable to find a default guest Network for Account " + getAccountName() + " in domain ID=" + getDomainId());
} else {
return defaultGuestNetwork.getId();
}
@@ -253,7 +253,7 @@ public class AssociateIPAddrCmd extends BaseAsyncCreateCmd implements UserCmd {
} else if (networkId != null) {
Network network = _networkService.getNetwork(networkId);
if (network == null) {
- throw new InvalidParameterValueException("Unable to find network by network id specified");
+ throw new InvalidParameterValueException("Unable to find Network by network id specified");
}
NetworkOffering offering = _entityMgr.findById(NetworkOffering.class, network.getNetworkOfferingId());
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/address/DisassociateIPAddrCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/address/DisassociateIPAddrCmd.java
index f4c06e512f0..531f9bb8649 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/address/DisassociateIPAddrCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/address/DisassociateIPAddrCmd.java
@@ -35,7 +35,7 @@ import com.cloud.exception.InvalidParameterValueException;
import com.cloud.network.IpAddress;
import com.cloud.user.Account;
-@APICommand(name = "disassociateIpAddress", description = "Disassociates an IP address from the account.", responseObject = SuccessResponse.class,
+@APICommand(name = "disassociateIpAddress", description = "Disassociates an IP address from the Account.", responseObject = SuccessResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false, entityType = { IpAddress.class })
public class DisassociateIPAddrCmd extends BaseAsyncCmd {
@@ -44,7 +44,7 @@ public class DisassociateIPAddrCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = IPAddressResponse.class, description = "the ID of the public IP address"
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = IPAddressResponse.class, description = "The ID of the public IP address"
+ " to disassociate. Mutually exclusive with the ipaddress parameter")
private Long id;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/address/ListPublicIpAddressesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/address/ListPublicIpAddressesCmd.java
index 5760ca3ba1c..b9730507621 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/address/ListPublicIpAddressesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/address/ListPublicIpAddressesCmd.java
@@ -50,59 +50,59 @@ public class ListPublicIpAddressesCmd extends BaseListRetrieveOnlyResourceCountC
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ALLOCATED_ONLY, type = CommandType.BOOLEAN, description = "limits search results to allocated public IP addresses")
+ @Parameter(name = ApiConstants.ALLOCATED_ONLY, type = CommandType.BOOLEAN, description = "Limits search results to allocated public IP addresses")
private Boolean allocatedOnly;
- @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "lists all public IP addresses by state")
+ @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "Lists all public IP addresses by state")
private String state;
- @Parameter(name = ApiConstants.FOR_VIRTUAL_NETWORK, type = CommandType.BOOLEAN, description = "the virtual network for the IP address")
+ @Parameter(name = ApiConstants.FOR_VIRTUAL_NETWORK, type = CommandType.BOOLEAN, description = "The virtual Network for the IP address")
private Boolean forVirtualNetwork;
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = IPAddressResponse.class, description = "lists IP address by ID")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = IPAddressResponse.class, description = "Lists IP address by ID")
private Long id;
- @Parameter(name = ApiConstants.IP_ADDRESS, type = CommandType.STRING, description = "lists the specified IP address")
+ @Parameter(name = ApiConstants.IP_ADDRESS, type = CommandType.STRING, description = "Lists the specified IP address")
private String ipAddress;
- @Parameter(name = ApiConstants.VLAN_ID, type = CommandType.UUID, entityType = VlanIpRangeResponse.class, description = "lists all public IP addresses by VLAN ID")
+ @Parameter(name = ApiConstants.VLAN_ID, type = CommandType.UUID, entityType = VlanIpRangeResponse.class, description = "Lists all public IP addresses by VLAN ID")
private Long vlanId;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "lists all public IP addresses by zone ID")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "Lists all public IP addresses by zone ID")
private Long zoneId;
- @Parameter(name = ApiConstants.FOR_LOAD_BALANCING, type = CommandType.BOOLEAN, description = "list only IPs used for load balancing")
+ @Parameter(name = ApiConstants.FOR_LOAD_BALANCING, type = CommandType.BOOLEAN, description = "List only IPs used for load balancing")
private Boolean forLoadBalancing;
@Parameter(name = ApiConstants.PHYSICAL_NETWORK_ID,
type = CommandType.UUID,
entityType = PhysicalNetworkResponse.class,
- description = "lists all public IP addresses by physical network ID")
+ description = "Lists all public IP addresses by physical Network ID")
private Long physicalNetworkId;
@Parameter(name = ApiConstants.ASSOCIATED_NETWORK_ID,
type = CommandType.UUID,
entityType = NetworkResponse.class,
- description = "lists all public IP addresses associated to the network specified")
+ description = "Lists all public IP addresses associated to the Network specified")
private Long associatedNetworkId;
@Parameter(name = ApiConstants.NETWORK_ID,
type = CommandType.UUID,
entityType = NetworkResponse.class,
- description = "lists all public IP addresses by source network ID",
+ description = "Lists all public IP addresses by source Network ID",
since = "4.13.0")
private Long networkId;
- @Parameter(name = ApiConstants.IS_SOURCE_NAT, type = CommandType.BOOLEAN, description = "list only source NAT IP addresses")
+ @Parameter(name = ApiConstants.IS_SOURCE_NAT, type = CommandType.BOOLEAN, description = "List only source NAT IP addresses")
private Boolean isSourceNat;
- @Parameter(name = ApiConstants.IS_STATIC_NAT, type = CommandType.BOOLEAN, description = "list only static NAT IP addresses")
+ @Parameter(name = ApiConstants.IS_STATIC_NAT, type = CommandType.BOOLEAN, description = "List only static NAT IP addresses")
private Boolean isStaticNat;
@Parameter(name = ApiConstants.VPC_ID, type = CommandType.UUID, entityType = VpcResponse.class, description = "List IPs belonging to the VPC")
private Long vpcId;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "list resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "List resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
@Parameter(name = ApiConstants.FOR_SYSTEM_VMS, type = CommandType.BOOLEAN, description = "true if range is dedicated for system VMs", since = "4.20.0")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/address/ReleaseIPAddrCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/address/ReleaseIPAddrCmd.java
index effe45c51ed..0d2ff89930d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/address/ReleaseIPAddrCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/address/ReleaseIPAddrCmd.java
@@ -33,7 +33,7 @@ import com.cloud.exception.InvalidParameterValueException;
import com.cloud.network.IpAddress;
@APICommand(name = "releaseIpAddress",
- description = "Releases an IP address from the account.",
+ description = "Releases an IP address from the Account.",
since = "4.17",
responseObject = SuccessResponse.class,
requestHasSensitiveInfo = false,
@@ -46,7 +46,7 @@ public class ReleaseIPAddrCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = IPAddressResponse.class, required = true, description = "the ID of the public IP address"
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = IPAddressResponse.class, required = true, description = "The ID of the public IP address"
+ " to release")
private Long id;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/address/ReserveIPAddrCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/address/ReserveIPAddrCmd.java
index e323d413b9a..7d102abc07f 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/address/ReserveIPAddrCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/address/ReserveIPAddrCmd.java
@@ -42,7 +42,7 @@ import com.cloud.projects.Project;
import com.cloud.user.Account;
@APICommand(name = "reserveIpAddress",
- description = "Reserve a public IP to an account.",
+ description = "Reserve a public IP to an Account.",
since = "4.17",
responseObject = IPAddressResponse.class,
responseView = ResponseView.Restricted,
@@ -57,24 +57,24 @@ public class ReserveIPAddrCmd extends BaseCmd implements UserCmd {
@Parameter(name = ApiConstants.ACCOUNT,
type = CommandType.STRING,
- description = "the account to reserve with this IP address")
+ description = "The Account to reserve with this IP address")
private String accountName;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "the ID of the domain to reserve with this IP address")
+ description = "The ID of the domain to reserve with this IP address")
private Long domainId;
@Parameter(name = ApiConstants.PROJECT_ID,
type = CommandType.UUID,
entityType = ProjectResponse.class,
- description = "the ID of the project to reserve with this IP address")
+ description = "The ID of the project to reserve with this IP address")
private Long projectId;
@Parameter(name = ApiConstants.FOR_DISPLAY,
type = CommandType.BOOLEAN,
- description = "an optional field, whether to the display the IP to the end user or not",
+ description = "An optional field, whether to the display the IP to the end User or not",
authorized = {RoleType.Admin})
private Boolean display;
@@ -82,7 +82,7 @@ public class ReserveIPAddrCmd extends BaseCmd implements UserCmd {
type = CommandType.UUID,
entityType = IPAddressResponse.class,
required = true,
- description = "the ID of the public IP address to reserve")
+ description = "The ID of the public IP address to reserve")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/address/UpdateIPAddrCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/address/UpdateIPAddrCmd.java
index 194967e2e4a..5e7308685a6 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/address/UpdateIPAddrCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/address/UpdateIPAddrCmd.java
@@ -46,14 +46,14 @@ public class UpdateIPAddrCmd extends BaseAsyncCustomIdCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = IPAddressResponse.class, required = true, description = "the ID of the public IP address"
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = IPAddressResponse.class, required = true, description = "The ID of the public IP address"
+ " to update")
private Long id;
// unexposed parameter needed for events logging
@Parameter(name = ApiConstants.ACCOUNT_ID, type = CommandType.UUID, entityType = AccountResponse.class, expose = false)
private Long ownerId;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the IP to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the IP to the end User or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/affinitygroup/CreateAffinityGroupCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/affinitygroup/CreateAffinityGroupCmd.java
index ee0a38ef35d..9647fd36564 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/affinitygroup/CreateAffinityGroupCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/affinitygroup/CreateAffinityGroupCmd.java
@@ -42,25 +42,25 @@ public class CreateAffinityGroupCmd extends BaseAsyncCreateCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "an account for the affinity group. Must be used with domainId.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "An account for the affinity group. Must be used with domainId.")
private String accountName;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
- description = "domainId of the account owning the affinity group",
+ description = "DomainId of the account owning the affinity group",
entityType = DomainResponse.class)
private Long domainId;
@Parameter(name = ApiConstants.PROJECT_ID,
type = CommandType.UUID,
entityType = ProjectResponse.class,
- description = "create affinity group for project")
+ description = "Create affinity group for project")
private Long projectId;
- @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "optional description of the affinity group")
+ @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "Optional description of the affinity group")
private String description;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "name of the affinity group")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "Name of the affinity group")
private String affinityGroupName;
@Parameter(name = ApiConstants.TYPE,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/affinitygroup/DeleteAffinityGroupCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/affinitygroup/DeleteAffinityGroupCmd.java
index 2f24158cadb..6eb75c7c183 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/affinitygroup/DeleteAffinityGroupCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/affinitygroup/DeleteAffinityGroupCmd.java
@@ -44,12 +44,12 @@ public class DeleteAffinityGroupCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "the account of the affinity group. Must be specified with domain ID")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "The account of the affinity group. Must be specified with domain ID")
private String accountName;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
- description = "the domain ID of account owning the affinity group",
+ description = "The domain ID of account owning the affinity group",
entityType = DomainResponse.class)
private Long domainId;
@@ -63,7 +63,7 @@ public class DeleteAffinityGroupCmd extends BaseAsyncCmd {
@Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the affinity group. Mutually exclusive with ID parameter")
private String name;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, description = "the project of the affinity group", entityType = ProjectResponse.class)
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, description = "The project of the affinity group", entityType = ProjectResponse.class)
private Long projectId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/affinitygroup/ListAffinityGroupsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/affinitygroup/ListAffinityGroupsCmd.java
index ee23e3794ce..2f30d8d8eee 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/affinitygroup/ListAffinityGroupsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/affinitygroup/ListAffinityGroupsCmd.java
@@ -36,19 +36,19 @@ public class ListAffinityGroupsCmd extends BaseListProjectAndAccountResourcesCmd
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "lists affinity groups by name")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "Lists affinity groups by name")
private String affinityGroupName;
@Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID,
type = CommandType.UUID,
- description = "lists affinity groups by virtual machine ID",
+ description = "Lists affinity groups by Instance ID",
entityType = UserVmResponse.class)
private Long virtualMachineId;
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, description = "list the affinity group by the ID provided", entityType = AffinityGroupResponse.class)
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, description = "List the affinity group by the ID provided", entityType = AffinityGroupResponse.class)
private Long id;
- @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, description = "lists affinity groups by type")
+ @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, description = "Lists affinity groups by type")
private String affinityGroupType;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/affinitygroup/UpdateVMAffinityGroupCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/affinitygroup/UpdateVMAffinityGroupCmd.java
index 6cd9bce6259..e522747780f 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/affinitygroup/UpdateVMAffinityGroupCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/affinitygroup/UpdateVMAffinityGroupCmd.java
@@ -46,7 +46,7 @@ import com.cloud.uservm.UserVm;
import com.cloud.vm.VirtualMachine;
@APICommand(name = "updateVMAffinityGroup",
- description = "Updates the affinity/anti-affinity group associations of a virtual machine. The VM has to be stopped and restarted for the "
+ description = "Updates the affinity/anti-affinity group associations of an Instance. The Instance has to be stopped and restarted for the "
+ "new properties to take effect.",
responseObject = UserVmResponse.class,
responseView = ResponseView.Restricted,
@@ -61,7 +61,7 @@ public class UpdateVMAffinityGroupCmd extends BaseAsyncCmd implements UserCmd {
/////////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = UserVmResponse.class, required = true, description = "The ID of the virtual machine")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = UserVmResponse.class, required = true, description = "The ID of the Instance")
private Long id;
@ACL
@@ -69,8 +69,8 @@ public class UpdateVMAffinityGroupCmd extends BaseAsyncCmd implements UserCmd {
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = AffinityGroupResponse.class,
- description = "comma separated list of affinity groups id that are going to be applied to the virtual machine. "
- + "Should be passed only when vm is created from a zone with Basic Network support." + " Mutually exclusive with securitygroupnames parameter")
+ description = "Comma separated list of affinity groups id that are going to be applied to the Instance. "
+ + "Should be passed only when Instance is created from a zone with Basic Network support." + " Mutually exclusive with securitygroupnames parameter")
private List affinityGroupIdList;
@ACL
@@ -78,8 +78,8 @@ public class UpdateVMAffinityGroupCmd extends BaseAsyncCmd implements UserCmd {
type = CommandType.LIST,
collectionType = CommandType.STRING,
entityType = AffinityGroupResponse.class,
- description = "comma separated list of affinity groups names that are going to be applied to the virtual machine."
- + " Should be passed only when vm is created from a zone with Basic Network support. " + "Mutually exclusive with securitygroupids parameter")
+ description = "Comma separated list of affinity groups names that are going to be applied to the Instance."
+ + " Should be passed only when Instance is created from a zone with Basic Network support. " + "Mutually exclusive with securitygroupids parameter")
private List affinityGroupNameList;
/////////////////////////////////////////////////////
@@ -152,7 +152,7 @@ public class UpdateVMAffinityGroupCmd extends BaseAsyncCmd implements UserCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update VM's affinity groups");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update Instance's affinity groups");
}
}
@@ -163,7 +163,7 @@ public class UpdateVMAffinityGroupCmd extends BaseAsyncCmd implements UserCmd {
@Override
public String getEventDescription() {
- return "updating VM affinity group";
+ return "Updating Instance affinity group";
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/CreateAutoScalePolicyCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/CreateAutoScalePolicyCmd.java
index a000e265f93..e160a1a9010 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/CreateAutoScalePolicyCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/CreateAutoScalePolicyCmd.java
@@ -37,7 +37,7 @@ import com.cloud.network.as.Condition;
import com.cloud.user.Account;
@APICommand(name = "createAutoScalePolicy",
- description = "Creates an autoscale policy for a provision or deprovision action, the action is taken when the all the conditions evaluates to true for the specified duration. The policy is in effect once it is attached to a autscale vm group.",
+ description = "Creates an autoscale policy for a provision or deprovision action, the action is taken when the all the conditions evaluates to true for the specified duration. The policy is in effect once it is attached to a autscale Instance group.",
responseObject = AutoScalePolicyResponse.class, entityType = {AutoScalePolicy.class},
requestHasSensitiveInfo = false,
responseHasSensitiveInfo = false)
@@ -51,25 +51,25 @@ public class CreateAutoScalePolicyCmd extends BaseAsyncCreateCmd {
@Parameter(name = ApiConstants.NAME,
type = CommandType.STRING,
- description = "the name of the autoscale policy",
+ description = "The name of the autoscale policy",
since = "4.18.0")
private String name;
@Parameter(name = ApiConstants.ACTION,
type = CommandType.STRING,
required = true,
- description = "the action to be executed if all the conditions evaluate to true for the specified duration.")
+ description = "The action to be executed if all the conditions evaluate to true for the specified duration.")
private String action;
@Parameter(name = ApiConstants.DURATION,
type = CommandType.INTEGER,
required = true,
- description = "the duration in which the conditions have to be true before action is taken")
+ description = "The duration in which the conditions have to be true before action is taken")
private int duration;
@Parameter(name = ApiConstants.QUIETTIME,
type = CommandType.INTEGER,
- description = "the cool down period in which the policy should not be evaluated after the action has been taken")
+ description = "The cool down period in which the policy should not be evaluated after the action has been taken")
private Integer quietTime;
@Parameter(name = ApiConstants.CONDITION_IDS,
@@ -77,7 +77,7 @@ public class CreateAutoScalePolicyCmd extends BaseAsyncCreateCmd {
collectionType = CommandType.UUID,
entityType = ConditionResponse.class,
required = true,
- description = "the list of IDs of the conditions that are being evaluated on every interval")
+ description = "The list of IDs of the conditions that are being evaluated on every interval")
private List conditionIds;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/CreateAutoScaleVmGroupCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/CreateAutoScaleVmGroupCmd.java
index 7c9362d4b69..66a1a56fbe2 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/CreateAutoScaleVmGroupCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/CreateAutoScaleVmGroupCmd.java
@@ -39,7 +39,7 @@ import com.cloud.network.as.AutoScaleVmGroup;
import com.cloud.network.rules.LoadBalancer;
@APICommand(name = "createAutoScaleVmGroup",
- description = "Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.",
+ description = "Creates and automatically starts an Instance based on a service offering, disk offering, and Template.",
responseObject = AutoScaleVmGroupResponse.class, entityType = {AutoScaleVmGroup.class},
requestHasSensitiveInfo = false,
responseHasSensitiveInfo = false)
@@ -55,28 +55,28 @@ public class CreateAutoScaleVmGroupCmd extends BaseAsyncCreateCmd {
type = CommandType.UUID,
entityType = FirewallRuleResponse.class,
required = true,
- description = "the ID of the load balancer rule")
+ description = "The ID of the load balancer rule")
private long lbRuleId;
@Parameter(name = ApiConstants.NAME,
type = CommandType.STRING,
- description = "the name of the autoscale vmgroup",
+ description = "The name of the autoscale Instance Group",
since = "4.18.0")
private String name;
@Parameter(name = ApiConstants.MIN_MEMBERS,
type = CommandType.INTEGER,
required = true,
- description = "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.")
+ description = "The minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.")
private int minMembers;
@Parameter(name = ApiConstants.MAX_MEMBERS,
type = CommandType.INTEGER,
required = true,
- description = "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.")
+ description = "The maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.")
private int maxMembers;
- @Parameter(name = ApiConstants.INTERVAL, type = CommandType.INTEGER, description = "the frequency in which the performance counters to be collected")
+ @Parameter(name = ApiConstants.INTERVAL, type = CommandType.INTEGER, description = "The frequency in which the performance counters to be collected")
private Integer interval;
@Parameter(name = ApiConstants.SCALEUP_POLICY_IDS,
@@ -84,7 +84,7 @@ public class CreateAutoScaleVmGroupCmd extends BaseAsyncCreateCmd {
collectionType = CommandType.UUID,
entityType = AutoScalePolicyResponse.class,
required = true,
- description = "list of scaleup autoscale policies")
+ description = "List of scaleup autoscale policies")
private List scaleUpPolicyIds;
@Parameter(name = ApiConstants.SCALEDOWN_POLICY_IDS,
@@ -92,17 +92,17 @@ public class CreateAutoScaleVmGroupCmd extends BaseAsyncCreateCmd {
collectionType = CommandType.UUID,
entityType = AutoScalePolicyResponse.class,
required = true,
- description = "list of scaledown autoscale policies")
+ description = "List of scaledown autoscale policies")
private List scaleDownPolicyIds;
@Parameter(name = ApiConstants.VMPROFILE_ID,
type = CommandType.UUID,
entityType = AutoScaleVmProfileResponse.class,
required = true,
- description = "the autoscale profile that contains information about the vms in the vm group.")
+ description = "The autoscale profile that contains information about the Instances in the Instance group.")
private long profileId;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the group to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the group to the end user or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
// ///////////////////////////////////////////////////
@@ -180,12 +180,12 @@ public class CreateAutoScaleVmGroupCmd extends BaseAsyncCreateCmd {
@Override
public String getCreateEventDescription() {
- return "creating AutoScale Vm Group";
+ return "Creating AutoScale Instance Group";
}
@Override
public String getEventDescription() {
- return "configuring AutoScale Vm Group. Vm Group Id: " + getEntityId();
+ return "Configuring AutoScale Instance Group. Instance Group Id: " + getEntityId();
}
@Override
@@ -213,7 +213,7 @@ public class CreateAutoScaleVmGroupCmd extends BaseAsyncCreateCmd {
setEntityId(result.getId());
setEntityUuid(result.getUuid());
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create Autoscale Vm Group");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create Autoscale Instance Group");
}
}
@@ -231,11 +231,11 @@ public class CreateAutoScaleVmGroupCmd extends BaseAsyncCreateCmd {
}
} catch (Exception ex) {
// TODO what will happen if Resource Layer fails in a step in between
- logger.warn("Failed to create autoscale vm group", ex);
+ logger.warn("Failed to create autoscale Instance group", ex);
} finally {
if (!success || vmGroup == null) {
_autoScaleService.deleteAutoScaleVmGroup(getEntityId(), true);
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create Autoscale Vm Group");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create Autoscale Instance Group");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/CreateAutoScaleVmProfileCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/CreateAutoScaleVmProfileCmd.java
index 2d84b20c582..4ecce59fa45 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/CreateAutoScaleVmProfileCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/CreateAutoScaleVmProfileCmd.java
@@ -44,7 +44,7 @@ import com.cloud.exception.ResourceAllocationException;
import com.cloud.network.as.AutoScaleVmProfile;
@APICommand(name = "createAutoScaleVmProfile",
- description = "Creates a profile that contains information about the virtual machine which will be provisioned automatically by autoscale feature.",
+ description = "Creates a profile that contains information about the Instance which will be provisioned automatically by autoscale feature.",
responseObject = AutoScaleVmProfileResponse.class, entityType = {AutoScaleVmProfile.class},
requestHasSensitiveInfo = false,
responseHasSensitiveInfo = false)
@@ -61,33 +61,33 @@ public class CreateAutoScaleVmProfileCmd extends BaseAsyncCreateCmd {
type = CommandType.UUID,
entityType = ZoneResponse.class,
required = true,
- description = "availability zone for the auto deployed virtual machine")
+ description = "Availability zone for the auto deployed Instance")
private Long zoneId;
@Parameter(name = ApiConstants.SERVICE_OFFERING_ID,
type = CommandType.UUID,
entityType = ServiceOfferingResponse.class,
required = true,
- description = "the service offering of the auto deployed virtual machine")
+ description = "The service offering of the auto deployed Instance")
private Long serviceOfferingId;
@Parameter(name = ApiConstants.TEMPLATE_ID,
type = CommandType.UUID,
entityType = TemplateResponse.class,
required = true,
- description = "the template of the auto deployed virtual machine")
+ description = "The Template of the auto deployed Instance")
private Long templateId;
@Parameter(name = ApiConstants.OTHER_DEPLOY_PARAMS,
type = CommandType.MAP,
- description = "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine.\n"
+ description = "Parameters other than zoneId/serviceOfferringId/templateId of the auto deployed Instance.\n"
+ "Example: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\n"
+ "Possible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".")
private Map> otherDeployParams;
@Parameter(name = ApiConstants.AUTOSCALE_EXPUNGE_VM_GRACE_PERIOD,
type = CommandType.INTEGER,
- description = "the time allowed for existing connections to get closed before a vm is expunged")
+ description = "The time allowed for existing connections to get closed before an Instance is expunged")
private Integer expungeVmGracePeriod;
@Parameter(name = ApiConstants.COUNTERPARAM_LIST,
@@ -97,7 +97,7 @@ public class CreateAutoScaleVmProfileCmd extends BaseAsyncCreateCmd {
@Parameter(name = ApiConstants.USER_DATA,
type = CommandType.STRING,
- description = "an optional binary data that can be sent to the virtual machine upon a successful deployment. " +
+ description = "An optional binary data that can be sent to the Instance upon a successful deployment. " +
"This binary data must be base64 encoded before adding it to the request. " +
"Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. " +
"Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. " +
@@ -115,19 +115,19 @@ public class CreateAutoScaleVmProfileCmd extends BaseAsyncCreateCmd {
@Parameter(name = ApiConstants.AUTOSCALE_USER_ID,
type = CommandType.UUID,
entityType = UserResponse.class,
- description = "the ID of the user used to launch and destroy the VMs")
+ description = "The ID of the user used to launch and destroy the Instances")
private Long autoscaleUserId;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the profile to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the profile to the end user or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "account that will own the autoscale VM profile")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "Account that will own the autoscale Instance profile")
private String accountName;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "an optional project for the autoscale VM profile")
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "An optional project for the autoscale Instance profile")
private Long projectId;
- @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "domain ID of the account owning a autoscale VM profile")
+ @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "Domain ID of the Account owning an autoscale Instance profile")
private Long domainId;
// ///////////////////////////////////////////////////
@@ -247,7 +247,7 @@ public class CreateAutoScaleVmProfileCmd extends BaseAsyncCreateCmd {
@Override
public String getEventDescription() {
- return "creating AutoScale Vm Profile";
+ return "Creating AutoScale Instance Profile";
}
@Override
@@ -271,7 +271,7 @@ public class CreateAutoScaleVmProfileCmd extends BaseAsyncCreateCmd {
setEntityId(result.getId());
setEntityUuid(result.getUuid());
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create Autoscale Vm Profile");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create Autoscale Instance Profile");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/CreateConditionCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/CreateConditionCmd.java
index 0ffb9afdac4..9d42706cb7d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/CreateConditionCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/CreateConditionCmd.java
@@ -35,7 +35,7 @@ import com.cloud.event.EventTypes;
import com.cloud.exception.ResourceAllocationException;
import com.cloud.network.as.Condition;
-@APICommand(name = "createCondition", description = "Creates a condition for VM auto scaling", responseObject = ConditionResponse.class, entityType = {Condition.class},
+@APICommand(name = "createCondition", description = "Creates a condition for Instance auto scaling", responseObject = ConditionResponse.class, entityType = {Condition.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class CreateConditionCmd extends BaseAsyncCreateCmd {
private static final String s_name = "conditionresponse";
@@ -53,13 +53,13 @@ public class CreateConditionCmd extends BaseAsyncCreateCmd {
@Parameter(name = ApiConstants.THRESHOLD, type = CommandType.LONG, required = true, description = "Value for which the Counter will be evaluated with the Operator selected.")
private Long threshold;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "the account of the condition. " + "Must be used with the domainId parameter.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "The account of the condition. " + "Must be used with the domainId parameter.")
private String accountName;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "an optional project for condition")
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "An optional project for condition")
private Long projectId;
- @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "the domain ID of the account.")
+ @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "The domain ID of the account.")
private Long domainId;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/DeleteAutoScalePolicyCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/DeleteAutoScalePolicyCmd.java
index cee9460dbe6..98e2e2a771a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/DeleteAutoScalePolicyCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/DeleteAutoScalePolicyCmd.java
@@ -46,7 +46,7 @@ public class DeleteAutoScalePolicyCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = AutoScalePolicyResponse.class,
required = true,
- description = "the ID of the autoscale policy")
+ description = "The ID of the autoscale policy")
private Long id;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/DeleteAutoScaleVmGroupCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/DeleteAutoScaleVmGroupCmd.java
index 6bf2157533e..274aac90262 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/DeleteAutoScaleVmGroupCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/DeleteAutoScaleVmGroupCmd.java
@@ -34,7 +34,7 @@ import com.cloud.event.EventTypes;
import com.cloud.network.as.AutoScaleVmGroup;
import com.cloud.user.Account;
-@APICommand(name = "deleteAutoScaleVmGroup", description = "Deletes a autoscale vm group.", responseObject = SuccessResponse.class, entityType = {AutoScaleVmGroup.class},
+@APICommand(name = "deleteAutoScaleVmGroup", description = "Deletes an autoscale Instance group.", responseObject = SuccessResponse.class, entityType = {AutoScaleVmGroup.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class DeleteAutoScaleVmGroupCmd extends BaseAsyncCmd {
// ///////////////////////////////////////////////////
@@ -46,12 +46,12 @@ public class DeleteAutoScaleVmGroupCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = AutoScaleVmGroupResponse.class,
required = true,
- description = "the ID of the autoscale group")
+ description = "The ID of the autoscale group")
private Long id;
@Parameter(name = ApiConstants.CLEANUP,
type = CommandType.BOOLEAN,
- description = "true if all VMs have to be cleaned up, false otherwise",
+ description = "True if all VMs have to be cleaned up, false otherwise",
since = "4.18.0")
private Boolean cleanup;
@@ -89,19 +89,19 @@ public class DeleteAutoScaleVmGroupCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "deleting autoscale vm group: " + getId();
+ return "Deleting autoscale Instance group: " + getId();
}
@Override
public void execute() {
- CallContext.current().setEventDetails("AutoScale Vm Group Id: " + getId());
+ CallContext.current().setEventDetails("AutoScale Instance Group Id: " + getId());
boolean result = _autoScaleService.deleteAutoScaleVmGroup(id, getCleanup());
if (result) {
SuccessResponse response = new SuccessResponse(getCommandName());
setResponseObject(response);
} else {
- logger.warn("Failed to delete autoscale vm group " + getId());
+ logger.warn("Failed to delete autoscale Instance group " + getId());
throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to delete autoscale vm group");
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/DeleteAutoScaleVmProfileCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/DeleteAutoScaleVmProfileCmd.java
index b90f6aa8ffa..a4fbd709610 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/DeleteAutoScaleVmProfileCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/DeleteAutoScaleVmProfileCmd.java
@@ -34,7 +34,7 @@ import com.cloud.event.EventTypes;
import com.cloud.network.as.AutoScaleVmProfile;
import com.cloud.user.Account;
-@APICommand(name = "deleteAutoScaleVmProfile", description = "Deletes a autoscale vm profile.", responseObject = SuccessResponse.class, entityType = {AutoScaleVmProfile.class},
+@APICommand(name = "deleteAutoScaleVmProfile", description = "Deletes a autoscale Instance profile.", responseObject = SuccessResponse.class, entityType = {AutoScaleVmProfile.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class DeleteAutoScaleVmProfileCmd extends BaseAsyncCmd {
// ///////////////////////////////////////////////////
@@ -46,7 +46,7 @@ public class DeleteAutoScaleVmProfileCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = AutoScaleVmProfileResponse.class,
required = true,
- description = "the ID of the autoscale profile")
+ description = "The ID of the autoscale profile")
private Long id;
// ///////////////////////////////////////////////////
@@ -79,19 +79,19 @@ public class DeleteAutoScaleVmProfileCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "deleting autoscale vm profile: " + getId();
+ return "Deleting autoscale Instance profile: " + getId();
}
@Override
public void execute() {
- CallContext.current().setEventDetails("AutoScale VM Profile Id: " + getId());
+ CallContext.current().setEventDetails("AutoScale Instance Profile Id: " + getId());
boolean result = _autoScaleService.deleteAutoScaleVmProfile(id);
if (result) {
SuccessResponse response = new SuccessResponse(getCommandName());
setResponseObject(response);
} else {
- logger.warn("Failed to delete autoscale vm profile " + getId());
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to delete autoscale vm profile");
+ logger.warn("Failed to delete autoscale Instance profile " + getId());
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to delete autoscale Instance profile");
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/DeleteConditionCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/DeleteConditionCmd.java
index 9590012e037..7b73a76fbbf 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/DeleteConditionCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/DeleteConditionCmd.java
@@ -35,7 +35,7 @@ import com.cloud.exception.ResourceInUseException;
import com.cloud.network.as.Condition;
import com.cloud.user.Account;
-@APICommand(name = "deleteCondition", description = "Removes a condition for VM auto scaling", responseObject = SuccessResponse.class, entityType = {Condition.class},
+@APICommand(name = "deleteCondition", description = "Removes a condition for Instance auto scaling", responseObject = SuccessResponse.class, entityType = {Condition.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class DeleteConditionCmd extends BaseAsyncCmd {
@@ -44,7 +44,7 @@ public class DeleteConditionCmd extends BaseAsyncCmd {
// ///////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ConditionResponse.class, required = true, description = "the ID of the condition.")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ConditionResponse.class, required = true, description = "The ID of the condition.")
private Long id;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/DisableAutoScaleVmGroupCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/DisableAutoScaleVmGroupCmd.java
index 2414c0d82b6..814f35c9f70 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/DisableAutoScaleVmGroupCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/DisableAutoScaleVmGroupCmd.java
@@ -33,7 +33,7 @@ import com.cloud.event.EventTypes;
import com.cloud.network.as.AutoScaleVmGroup;
import com.cloud.user.Account;
-@APICommand(name = "disableAutoScaleVmGroup", description = "Disables an AutoScale Vm Group", responseObject = AutoScaleVmGroupResponse.class, entityType = {AutoScaleVmGroup.class},
+@APICommand(name = "disableAutoScaleVmGroup", description = "Disables an AutoScale Instance Group", responseObject = AutoScaleVmGroupResponse.class, entityType = {AutoScaleVmGroup.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class DisableAutoScaleVmGroupCmd extends BaseAsyncCmd {
private static final String s_name = "disableautoscalevmGroupresponse";
@@ -47,7 +47,7 @@ public class DisableAutoScaleVmGroupCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = AutoScaleVmGroupResponse.class,
required = true,
- description = "the ID of the autoscale group")
+ description = "The ID of the autoscale group")
private Long id;
// ///////////////////////////////////////////////////
@@ -62,7 +62,7 @@ public class DisableAutoScaleVmGroupCmd extends BaseAsyncCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to disable AutoScale Vm Group");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to disable AutoScale Instance Group");
}
}
@@ -96,7 +96,7 @@ public class DisableAutoScaleVmGroupCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "Disabling AutoScale Vm Group. Vm Group Id: " + getId();
+ return "Disabling AutoScale Instance Group. Instance Group Id: " + getId();
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/EnableAutoScaleVmGroupCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/EnableAutoScaleVmGroupCmd.java
index 96d329d3e0c..962c5af0e2c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/EnableAutoScaleVmGroupCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/EnableAutoScaleVmGroupCmd.java
@@ -33,7 +33,7 @@ import com.cloud.event.EventTypes;
import com.cloud.network.as.AutoScaleVmGroup;
import com.cloud.user.Account;
-@APICommand(name = "enableAutoScaleVmGroup", description = "Enables an AutoScale Vm Group", responseObject = AutoScaleVmGroupResponse.class, entityType = {AutoScaleVmGroup.class},
+@APICommand(name = "enableAutoScaleVmGroup", description = "Enables an AutoScale Instance Group", responseObject = AutoScaleVmGroupResponse.class, entityType = {AutoScaleVmGroup.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class EnableAutoScaleVmGroupCmd extends BaseAsyncCmd {
private static final String s_name = "enableautoscalevmGroupresponse";
@@ -47,7 +47,7 @@ public class EnableAutoScaleVmGroupCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = AutoScaleVmGroupResponse.class,
required = true,
- description = "the ID of the autoscale group")
+ description = "The ID of the autoscale group")
private Long id;
// ///////////////////////////////////////////////////
@@ -62,7 +62,7 @@ public class EnableAutoScaleVmGroupCmd extends BaseAsyncCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to enable AutoScale Vm Group");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to enable AutoScale Instance Group");
}
}
@@ -96,7 +96,7 @@ public class EnableAutoScaleVmGroupCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "Enabling AutoScale Vm Group. Vm Group Id: " + getId();
+ return "Enabling AutoScale Instance Group. Instance Group Id: " + getId();
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/ListAutoScalePoliciesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/ListAutoScalePoliciesCmd.java
index 4935889c525..5ce0aa7f5b7 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/ListAutoScalePoliciesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/ListAutoScalePoliciesCmd.java
@@ -40,21 +40,21 @@ public class ListAutoScalePoliciesCmd extends BaseListProjectAndAccountResources
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = AutoScalePolicyResponse.class, description = "the ID of the autoscale policy")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = AutoScalePolicyResponse.class, description = "The ID of the autoscale policy")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the autoscale policy", since = "4.18.0")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the autoscale policy", since = "4.18.0")
private String name;
- @Parameter(name = ApiConstants.CONDITION_ID, type = CommandType.UUID, entityType = ConditionResponse.class, description = "the ID of the condition of the policy")
+ @Parameter(name = ApiConstants.CONDITION_ID, type = CommandType.UUID, entityType = ConditionResponse.class, description = "The ID of the condition of the policy")
private Long conditionId;
@Parameter(name = ApiConstants.ACTION,
type = CommandType.STRING,
- description = "the action to be executed if all the conditions evaluate to true for the specified duration.")
+ description = "The action to be executed if all the conditions evaluate to true for the specified duration.")
private String action;
- @Parameter(name = ApiConstants.VMGROUP_ID, type = CommandType.UUID, entityType = AutoScaleVmGroupResponse.class, description = "the ID of the autoscale vm group")
+ @Parameter(name = ApiConstants.VMGROUP_ID, type = CommandType.UUID, entityType = AutoScaleVmGroupResponse.class, description = "The ID of the autoscale Instance group")
private Long vmGroupId;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/ListAutoScaleVmGroupsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/ListAutoScaleVmGroupsCmd.java
index 6aa4abcccd8..4bb0ef09148 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/ListAutoScaleVmGroupsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/ListAutoScaleVmGroupsCmd.java
@@ -35,7 +35,7 @@ import org.apache.cloudstack.api.response.ZoneResponse;
import com.cloud.exception.InvalidParameterValueException;
import com.cloud.network.as.AutoScaleVmGroup;
-@APICommand(name = "listAutoScaleVmGroups", description = "Lists autoscale vm groups.", responseObject = AutoScaleVmGroupResponse.class, entityType = {AutoScaleVmGroup.class},
+@APICommand(name = "listAutoScaleVmGroups", description = "Lists autoscale Instance groups.", responseObject = AutoScaleVmGroupResponse.class, entityType = {AutoScaleVmGroup.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListAutoScaleVmGroupsCmd extends BaseListProjectAndAccountResourcesCmd {
@@ -44,25 +44,25 @@ public class ListAutoScaleVmGroupsCmd extends BaseListProjectAndAccountResources
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = AutoScaleVmGroupResponse.class, description = "the ID of the autoscale vm group")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = AutoScaleVmGroupResponse.class, description = "The ID of the autoscale Instance group")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the autoscale vmgroup", since = "4.18.0")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the autoscale vmgroup", since = "4.18.0")
private String name;
- @Parameter(name = ApiConstants.LBID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, description = "the ID of the loadbalancer")
+ @Parameter(name = ApiConstants.LBID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, description = "The ID of the loadbalancer")
private Long loadBalancerId;
- @Parameter(name = ApiConstants.VMPROFILE_ID, type = CommandType.UUID, entityType = AutoScaleVmProfileResponse.class, description = "the ID of the profile")
+ @Parameter(name = ApiConstants.VMPROFILE_ID, type = CommandType.UUID, entityType = AutoScaleVmProfileResponse.class, description = "The ID of the profile")
private Long profileId;
- @Parameter(name = ApiConstants.POLICY_ID, type = CommandType.UUID, entityType = AutoScalePolicyResponse.class, description = "the ID of the policy")
+ @Parameter(name = ApiConstants.POLICY_ID, type = CommandType.UUID, entityType = AutoScalePolicyResponse.class, description = "The ID of the policy")
private Long policyId;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "the availability zone ID")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "The availability zone ID")
private Long zoneId;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "list resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "List resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/ListAutoScaleVmProfilesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/ListAutoScaleVmProfilesCmd.java
index bcaea273ce8..4c95e7a4edc 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/ListAutoScaleVmProfilesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/ListAutoScaleVmProfilesCmd.java
@@ -33,7 +33,7 @@ import org.apache.cloudstack.api.response.ZoneResponse;
import com.cloud.network.as.AutoScaleVmProfile;
-@APICommand(name = "listAutoScaleVmProfiles", description = "Lists autoscale vm profiles.", responseObject = AutoScaleVmProfileResponse.class, entityType = {AutoScaleVmProfile.class},
+@APICommand(name = "listAutoScaleVmProfiles", description = "Lists autoscale Instance profiles.", responseObject = AutoScaleVmProfileResponse.class, entityType = {AutoScaleVmProfile.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListAutoScaleVmProfilesCmd extends BaseListProjectAndAccountResourcesCmd {
@@ -42,22 +42,22 @@ public class ListAutoScaleVmProfilesCmd extends BaseListProjectAndAccountResourc
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = AutoScaleVmProfileResponse.class, description = "the ID of the autoscale vm profile")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = AutoScaleVmProfileResponse.class, description = "The ID of the autoscale Instance profile")
private Long id;
- @Parameter(name = ApiConstants.TEMPLATE_ID, type = CommandType.UUID, entityType = TemplateResponse.class, description = "the templateid of the autoscale vm profile")
+ @Parameter(name = ApiConstants.TEMPLATE_ID, type = CommandType.UUID, entityType = TemplateResponse.class, description = "The templateid of the autoscale Instance profile")
private Long templateId;
- @Parameter(name = ApiConstants.SERVICE_OFFERING_ID, type = CommandType.UUID, entityType = ServiceOfferingResponse.class, description = "list profiles by service offering id", since = "4.4")
+ @Parameter(name = ApiConstants.SERVICE_OFFERING_ID, type = CommandType.UUID, entityType = ServiceOfferingResponse.class, description = "List profiles by service offering id", since = "4.4")
private Long serviceOffId;
- @Parameter(name = ApiConstants.OTHER_DEPLOY_PARAMS, type = CommandType.STRING, description = "the otherdeployparameters of the autoscale vm profile")
+ @Parameter(name = ApiConstants.OTHER_DEPLOY_PARAMS, type = CommandType.STRING, description = "The otherdeployparameters of the autoscale Instance profile")
private String otherDeployParams;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, since = "4.4", description = "availability zone for the auto deployed virtual machine")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, since = "4.4", description = "Availability zone for the auto deployed Instance")
private Long zoneId;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "list resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "List resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/ListConditionsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/ListConditionsCmd.java
index febf937d75f..02e54a15ac3 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/ListConditionsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/ListConditionsCmd.java
@@ -32,7 +32,7 @@ import org.apache.cloudstack.api.response.ListResponse;
import com.cloud.network.as.Condition;
-@APICommand(name = "listConditions", description = "List Conditions for VM auto scaling", responseObject = ConditionResponse.class,
+@APICommand(name = "listConditions", description = "List Conditions for Instance auto scaling", responseObject = ConditionResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListConditionsCmd extends BaseListProjectAndAccountResourcesCmd {
@@ -50,7 +50,7 @@ public class ListConditionsCmd extends BaseListProjectAndAccountResourcesCmd {
description = "Counter-id of the condition.")
private Long counterId;
- @Parameter(name = ApiConstants.POLICY_ID, type = CommandType.UUID, entityType = AutoScalePolicyResponse.class, description = "the ID of the policy")
+ @Parameter(name = ApiConstants.POLICY_ID, type = CommandType.UUID, entityType = AutoScalePolicyResponse.class, description = "The ID of the policy")
private Long policyId;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/ListCountersCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/ListCountersCmd.java
index d03584fd63d..983c13f07a2 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/ListCountersCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/ListCountersCmd.java
@@ -31,7 +31,7 @@ import org.apache.cloudstack.api.response.ListResponse;
import com.cloud.network.as.Counter;
import com.cloud.user.Account;
-@APICommand(name = "listCounters", description = "List the counters for VM auto scaling", responseObject = CounterResponse.class,
+@APICommand(name = "listCounters", description = "List the counters for Instance auto scaling", responseObject = CounterResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListCountersCmd extends BaseListCmd {
private static final String s_name = "counterresponse";
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/UpdateAutoScalePolicyCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/UpdateAutoScalePolicyCmd.java
index 927a9191fcc..368f9c01fe1 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/UpdateAutoScalePolicyCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/UpdateAutoScalePolicyCmd.java
@@ -48,23 +48,23 @@ public class UpdateAutoScalePolicyCmd extends BaseAsyncCmd {
@Parameter(name = ApiConstants.NAME,
type = CommandType.STRING,
- description = "the name of the autoscale policy",
+ description = "The name of the autoscale policy",
since = "4.18.0")
private String name;
- @Parameter(name = ApiConstants.DURATION, type = CommandType.INTEGER, description = "the duration in which the conditions have to be true before action is taken")
+ @Parameter(name = ApiConstants.DURATION, type = CommandType.INTEGER, description = "The duration in which the conditions have to be true before action is taken")
private Integer duration;
@Parameter(name = ApiConstants.QUIETTIME,
type = CommandType.INTEGER,
- description = "the cool down period in which the policy should not be evaluated after the action has been taken")
+ description = "The cool down period in which the policy should not be evaluated after the action has been taken")
private Integer quietTime;
@Parameter(name = ApiConstants.CONDITION_IDS,
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = ConditionResponse.class,
- description = "the list of IDs of the conditions that are being evaluated on every interval")
+ description = "The list of IDs of the conditions that are being evaluated on every interval")
private List conditionIds;
@ACL(accessType = AccessType.OperateEntry)
@@ -72,7 +72,7 @@ public class UpdateAutoScalePolicyCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = AutoScalePolicyResponse.class,
required = true,
- description = "the ID of the autoscale policy")
+ description = "The ID of the autoscale policy")
private Long id;
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/UpdateAutoScaleVmGroupCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/UpdateAutoScaleVmGroupCmd.java
index 69ae8aa36aa..128a1368c52 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/UpdateAutoScaleVmGroupCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/UpdateAutoScaleVmGroupCmd.java
@@ -38,7 +38,7 @@ import com.cloud.event.EventTypes;
import com.cloud.network.as.AutoScaleVmGroup;
import com.cloud.user.Account;
-@APICommand(name = "updateAutoScaleVmGroup", description = "Updates an existing autoscale vm group.", responseObject = AutoScaleVmGroupResponse.class, entityType = {AutoScaleVmGroup.class},
+@APICommand(name = "updateAutoScaleVmGroup", description = "Updates an existing autoscale Instance group.", responseObject = AutoScaleVmGroupResponse.class, entityType = {AutoScaleVmGroup.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class UpdateAutoScaleVmGroupCmd extends BaseAsyncCustomIdCmd {
@@ -49,35 +49,35 @@ public class UpdateAutoScaleVmGroupCmd extends BaseAsyncCustomIdCmd {
@Parameter(name = ApiConstants.NAME,
type = CommandType.STRING,
- description = "the name of the autoscale vmgroup",
+ description = "The name of the autoscale vmgroup",
since = "4.18.0")
private String name;
@Parameter(name = ApiConstants.MIN_MEMBERS,
type = CommandType.INTEGER,
- description = "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.")
+ description = "The minimum number of members in the vmgroup, the number of Instances in the Instance group will be equal to or more than this number.")
private Integer minMembers;
@Parameter(name = ApiConstants.MAX_MEMBERS,
type = CommandType.INTEGER,
- description = "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.")
+ description = "The maximum number of members in the vmgroup, The number of Instances in the Instance group will be equal to or less than this number.")
private Integer maxMembers;
- @Parameter(name = ApiConstants.INTERVAL, type = CommandType.INTEGER, description = "the frequency in which the performance counters to be collected")
+ @Parameter(name = ApiConstants.INTERVAL, type = CommandType.INTEGER, description = "The frequency in which the performance counters to be collected")
private Integer interval;
@Parameter(name = ApiConstants.SCALEUP_POLICY_IDS,
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = AutoScalePolicyResponse.class,
- description = "list of scaleup autoscale policies")
+ description = "List of scaleup autoscale policies")
private List scaleUpPolicyIds;
@Parameter(name = ApiConstants.SCALEDOWN_POLICY_IDS,
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = AutoScalePolicyResponse.class,
- description = "list of scaledown autoscale policies")
+ description = "List of scaledown autoscale policies")
private List scaleDownPolicyIds;
@ACL(accessType = AccessType.OperateEntry)
@@ -85,10 +85,10 @@ public class UpdateAutoScaleVmGroupCmd extends BaseAsyncCustomIdCmd {
type = CommandType.UUID,
entityType = AutoScaleVmGroupResponse.class,
required = true,
- description = "the ID of the autoscale group")
+ description = "The ID of the autoscale group")
private Long id;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the group to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the group to the end user or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
// ///////////////////////////////////////////////////
@@ -97,7 +97,7 @@ public class UpdateAutoScaleVmGroupCmd extends BaseAsyncCustomIdCmd {
@Override
public void execute() {
- CallContext.current().setEventDetails("AutoScale Vm Group Id: " + getId());
+ CallContext.current().setEventDetails("AutoScale Instance Group Id: " + getId());
AutoScaleVmGroup result = _autoScaleService.updateAutoScaleVmGroup(this);
if (result != null) {
AutoScaleVmGroupResponse response = _responseGenerator.createAutoScaleVmGroupResponse(result);
@@ -151,7 +151,7 @@ public class UpdateAutoScaleVmGroupCmd extends BaseAsyncCustomIdCmd {
@Override
public String getEventDescription() {
- return "Updating AutoScale Vm Group. Vm Group Id: " + getId();
+ return "Updating AutoScale Instance Group. Instance Group Id: " + getId();
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/UpdateAutoScaleVmProfileCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/UpdateAutoScaleVmProfileCmd.java
index 0b73fd91b52..5192f0382db 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/UpdateAutoScaleVmProfileCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/UpdateAutoScaleVmProfileCmd.java
@@ -42,7 +42,7 @@ import com.cloud.event.EventTypes;
import com.cloud.network.as.AutoScaleVmProfile;
import com.cloud.user.Account;
-@APICommand(name = "updateAutoScaleVmProfile", description = "Updates an existing autoscale vm profile.", responseObject = AutoScaleVmProfileResponse.class, entityType = {AutoScaleVmProfile.class},
+@APICommand(name = "updateAutoScaleVmProfile", description = "Updates an existing autoscale Instance profile.", responseObject = AutoScaleVmProfileResponse.class, entityType = {AutoScaleVmProfile.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class UpdateAutoScaleVmProfileCmd extends BaseAsyncCustomIdCmd {
@@ -56,25 +56,25 @@ public class UpdateAutoScaleVmProfileCmd extends BaseAsyncCustomIdCmd {
type = CommandType.UUID,
entityType = AutoScaleVmProfileResponse.class,
required = true,
- description = "the ID of the autoscale vm profile")
+ description = "The ID of the autoscale Instance profile")
private Long id;
@Parameter(name = ApiConstants.SERVICE_OFFERING_ID,
type = CommandType.UUID,
entityType = ServiceOfferingResponse.class,
- description = "the service offering of the auto deployed virtual machine",
+ description = "The service offering of the auto deployed Instance",
since = "4.18.0")
private Long serviceOfferingId;
@Parameter(name = ApiConstants.TEMPLATE_ID,
type = CommandType.UUID,
entityType = TemplateResponse.class,
- description = "the template of the auto deployed virtual machine")
+ description = "The Template of the auto deployed Instance")
private Long templateId;
@Parameter(name = ApiConstants.AUTOSCALE_EXPUNGE_VM_GRACE_PERIOD,
type = CommandType.INTEGER,
- description = "the time allowed for existing connections to get closed before a vm is destroyed")
+ description = "The time allowed for existing connections to get closed before an Instance is destroyed")
private Integer expungeVmGracePeriod;
@Parameter(name = ApiConstants.COUNTERPARAM_LIST,
@@ -84,7 +84,7 @@ public class UpdateAutoScaleVmProfileCmd extends BaseAsyncCustomIdCmd {
@Parameter(name = ApiConstants.OTHER_DEPLOY_PARAMS,
type = CommandType.MAP,
- description = "parameters other than zoneId/serviceOfferringId/templateId of the auto deployed virtual machine. \n"
+ description = "Parameters other than zoneId/serviceOfferringId/templateId of the auto deployed Instance. \n"
+ "Example: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\n"
+ "Possible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\".",
since = "4.18.0")
@@ -92,7 +92,7 @@ public class UpdateAutoScaleVmProfileCmd extends BaseAsyncCustomIdCmd {
@Parameter(name = ApiConstants.USER_DATA,
type = CommandType.STRING,
- description = "an optional binary data that can be sent to the virtual machine upon a successful deployment. " +
+ description = "An optional binary data that can be sent to the Instance upon a successful deployment. " +
"This binary data must be base64 encoded before adding it to the request. " +
"Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. " +
"Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. " +
@@ -112,10 +112,10 @@ public class UpdateAutoScaleVmProfileCmd extends BaseAsyncCustomIdCmd {
@Parameter(name = ApiConstants.AUTOSCALE_USER_ID,
type = CommandType.UUID,
entityType = UserResponse.class,
- description = "the ID of the user used to launch and destroy the VMs")
+ description = "The ID of the user used to launch and destroy the Instances")
private Long autoscaleUserId;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the profile to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the profile to the end user or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
// ///////////////////////////////////////////////////
@@ -131,7 +131,7 @@ public class UpdateAutoScaleVmProfileCmd extends BaseAsyncCustomIdCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update autoscale vm profile");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update autoscale Instance profile");
}
}
@@ -190,7 +190,7 @@ public class UpdateAutoScaleVmProfileCmd extends BaseAsyncCustomIdCmd {
@Override
public String getEventDescription() {
- return "Updating AutoScale Vm Profile. Vm Profile Id: " + getId();
+ return "Updating AutoScale Instance Profile. Instance Profile Id: " + getId();
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/UpdateConditionCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/UpdateConditionCmd.java
index 4ed8244ff0c..a386db47843 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/UpdateConditionCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/autoscale/UpdateConditionCmd.java
@@ -36,7 +36,7 @@ import com.cloud.exception.ResourceInUseException;
import com.cloud.network.as.Condition;
import com.cloud.user.Account;
-@APICommand(name = "updateCondition", description = "Updates a condition for VM auto scaling", responseObject = SuccessResponse.class, entityType = {Condition.class},
+@APICommand(name = "updateCondition", description = "Updates a condition for Instance auto scaling", responseObject = SuccessResponse.class, entityType = {Condition.class},
authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false, since = "4.18.0")
public class UpdateConditionCmd extends BaseAsyncCmd {
@@ -46,7 +46,7 @@ public class UpdateConditionCmd extends BaseAsyncCmd {
// ///////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ConditionResponse.class, required = true, description = "the ID of the condition.")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ConditionResponse.class, required = true, description = "The ID of the condition.")
private Long id;
@Parameter(name = ApiConstants.RELATIONAL_OPERATOR, type = CommandType.STRING, required = true, description = "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/backup/AssignVirtualMachineToBackupOfferingCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/backup/AssignVirtualMachineToBackupOfferingCmd.java
index 0e6b2bc165e..e8914e45c42 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/backup/AssignVirtualMachineToBackupOfferingCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/backup/AssignVirtualMachineToBackupOfferingCmd.java
@@ -40,7 +40,7 @@ import com.cloud.exception.ResourceAllocationException;
import com.cloud.exception.ResourceUnavailableException;
@APICommand(name = "assignVirtualMachineToBackupOffering",
- description = "Assigns a VM to a backup offering",
+ description = "Assigns an Instance to a backup offering",
responseObject = SuccessResponse.class, since = "4.14.0",
authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User})
public class AssignVirtualMachineToBackupOfferingCmd extends BaseAsyncCmd {
@@ -56,7 +56,7 @@ public class AssignVirtualMachineToBackupOfferingCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = UserVmResponse.class,
required = true,
- description = "ID of the virtual machine")
+ description = "ID of the Instance")
private Long vmId;
@Parameter(name = ApiConstants.BACKUP_OFFERING_ID,
@@ -90,7 +90,7 @@ public class AssignVirtualMachineToBackupOfferingCmd extends BaseAsyncCmd {
SuccessResponse response = new SuccessResponse(getCommandName());
this.setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to add VM to backup offering");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to add Instance to backup offering");
}
} catch (Exception e) {
throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, e.getMessage());
@@ -109,6 +109,6 @@ public class AssignVirtualMachineToBackupOfferingCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "Assigning VM to backup offering ID: " + offeringId;
+ return "Assigning Instance to backup offering ID: " + offeringId;
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/backup/CreateBackupCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/backup/CreateBackupCmd.java
index 558f92e4006..4f852094ed7 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/backup/CreateBackupCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/backup/CreateBackupCmd.java
@@ -41,7 +41,7 @@ import com.cloud.exception.ResourceUnavailableException;
import com.cloud.utils.exception.CloudRuntimeException;
@APICommand(name = "createBackup",
- description = "Create VM backup",
+ description = "Create Instance backup",
responseObject = SuccessResponse.class, since = "4.14.0",
authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User})
public class CreateBackupCmd extends BaseAsyncCreateCmd {
@@ -57,7 +57,7 @@ public class CreateBackupCmd extends BaseAsyncCreateCmd {
type = CommandType.UUID,
entityType = UserVmResponse.class,
required = true,
- description = "ID of the VM")
+ description = "ID of the Instance")
private Long vmId;
/////////////////////////////////////////////////////
@@ -81,7 +81,7 @@ public class CreateBackupCmd extends BaseAsyncCreateCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new CloudRuntimeException("Error while creating backup of VM");
+ throw new CloudRuntimeException("Error while creating backup of Instance");
}
} catch (Exception e) {
throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, e.getMessage());
@@ -105,7 +105,7 @@ public class CreateBackupCmd extends BaseAsyncCreateCmd {
@Override
public String getEventDescription() {
- return "Creating backup for VM " + vmId;
+ return "Creating backup for Instance " + vmId;
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/backup/CreateBackupScheduleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/backup/CreateBackupScheduleCmd.java
index 5dc06af2123..05d903a611c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/backup/CreateBackupScheduleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/backup/CreateBackupScheduleCmd.java
@@ -26,7 +26,6 @@ import org.apache.cloudstack.api.ApiErrorCode;
import org.apache.cloudstack.api.BaseCmd;
import org.apache.cloudstack.api.Parameter;
import org.apache.cloudstack.api.ServerApiException;
-import org.apache.cloudstack.api.response.BackupResponse;
import org.apache.cloudstack.api.response.BackupScheduleResponse;
import org.apache.cloudstack.api.response.UserVmResponse;
import org.apache.cloudstack.backup.BackupManager;
@@ -37,8 +36,8 @@ import com.cloud.utils.DateUtil;
import com.cloud.utils.exception.CloudRuntimeException;
@APICommand(name = "createBackupSchedule",
- description = "Creates a user-defined VM backup schedule",
- responseObject = BackupResponse.class, since = "4.14.0",
+ description = "Creates a User-defined Instance backup schedule",
+ responseObject = BackupScheduleResponse.class, since = "4.14.0",
authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User})
public class CreateBackupScheduleCmd extends BaseCmd {
@@ -53,19 +52,19 @@ public class CreateBackupScheduleCmd extends BaseCmd {
type = CommandType.UUID,
entityType = UserVmResponse.class,
required = true,
- description = "ID of the VM for which schedule is to be defined")
+ description = "ID of the Instance for which schedule is to be defined")
private Long vmId;
@Parameter(name = ApiConstants.INTERVAL_TYPE,
type = CommandType.STRING,
required = true,
- description = "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY")
+ description = "Valid values are HOURLY, DAILY, WEEKLY, and MONTHLY")
private String intervalType;
@Parameter(name = ApiConstants.SCHEDULE,
type = CommandType.STRING,
required = true,
- description = "custom backup schedule, the format is:"
+ description = "Custom backup schedule, the format is:"
+ "for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28)")
private String schedule;
@@ -108,7 +107,7 @@ public class CreateBackupScheduleCmd extends BaseCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new CloudRuntimeException("Error while creating backup schedule of VM");
+ throw new CloudRuntimeException("Error while creating backup schedule of Instance");
}
} catch (Exception e) {
throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, e.getMessage());
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/backup/DeleteBackupCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/backup/DeleteBackupCmd.java
index 7f0a63ecc91..369934a79c4 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/backup/DeleteBackupCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/backup/DeleteBackupCmd.java
@@ -41,7 +41,7 @@ import com.cloud.exception.ResourceUnavailableException;
import com.cloud.utils.exception.CloudRuntimeException;
@APICommand(name = "deleteBackup",
- description = "Delete VM backup",
+ description = "Delete Instance backup",
responseObject = SuccessResponse.class, since = "4.14.0",
authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User})
public class DeleteBackupCmd extends BaseAsyncCmd {
@@ -57,13 +57,13 @@ public class DeleteBackupCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = BackupResponse.class,
required = true,
- description = "id of the VM backup")
+ description = "ID of the Instance backup")
private Long backupId;
@Parameter(name = ApiConstants.FORCED,
type = CommandType.BOOLEAN,
required = false,
- description = "force the deletion of backup which removes the entire backup chain but keep VM in Backup Offering",
+ description = "Force the deletion of backup which removes the entire backup chain but keep Instance in Backup Offering",
since = "4.18.0.0")
private Boolean forced;
@@ -92,7 +92,7 @@ public class DeleteBackupCmd extends BaseAsyncCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new CloudRuntimeException("Error while deleting backup of VM");
+ throw new CloudRuntimeException("Error while deleting backup of Instance");
}
} catch (Exception e) {
throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, e.getMessage());
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/backup/DeleteBackupScheduleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/backup/DeleteBackupScheduleCmd.java
index 548f4d67b23..8f9134a5cff 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/backup/DeleteBackupScheduleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/backup/DeleteBackupScheduleCmd.java
@@ -40,7 +40,7 @@ import com.cloud.exception.ResourceUnavailableException;
import com.cloud.utils.exception.CloudRuntimeException;
@APICommand(name = "deleteBackupSchedule",
- description = "Deletes the backup schedule of a VM",
+ description = "Deletes the backup schedule of a Instance",
responseObject = SuccessResponse.class, since = "4.14.0",
authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User})
public class DeleteBackupScheduleCmd extends BaseCmd {
@@ -89,7 +89,7 @@ public class DeleteBackupScheduleCmd extends BaseCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new CloudRuntimeException("Failed to delete VM backup schedule");
+ throw new CloudRuntimeException("Failed to delete Instance backup schedule");
}
} catch (Exception e) {
throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, e.getMessage());
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/backup/ListBackupScheduleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/backup/ListBackupScheduleCmd.java
index fa6e3ea5d45..1985bd6980f 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/backup/ListBackupScheduleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/backup/ListBackupScheduleCmd.java
@@ -45,7 +45,7 @@ import java.util.ArrayList;
import java.util.List;
@APICommand(name = "listBackupSchedule",
- description = "List backup schedule of a VM",
+ description = "List backup schedule of an Instance",
responseObject = BackupScheduleResponse.class, since = "4.14.0",
authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User})
public class ListBackupScheduleCmd extends BaseCmd {
@@ -61,7 +61,7 @@ public class ListBackupScheduleCmd extends BaseCmd {
type = CommandType.UUID,
entityType = UserVmResponse.class,
required = true,
- description = "ID of the VM")
+ description = "ID of the Instance")
private Long vmId;
/////////////////////////////////////////////////////
@@ -90,7 +90,7 @@ public class ListBackupScheduleCmd extends BaseCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new CloudRuntimeException("No backup schedule exists for the VM");
+ throw new CloudRuntimeException("No backup schedule exists for the Instance");
}
} catch (Exception e) {
throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, e.getMessage());
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/backup/ListBackupsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/backup/ListBackupsCmd.java
index 7d87cc37e6c..9f34dbda14a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/backup/ListBackupsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/backup/ListBackupsCmd.java
@@ -45,7 +45,7 @@ import com.cloud.exception.ResourceUnavailableException;
import com.cloud.utils.Pair;
@APICommand(name = "listBackups",
- description = "Lists VM backups",
+ description = "Lists Instance backups",
responseObject = BackupResponse.class, since = "4.14.0",
authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User})
public class ListBackupsCmd extends BaseListProjectAndAccountResourcesCmd {
@@ -60,19 +60,19 @@ public class ListBackupsCmd extends BaseListProjectAndAccountResourcesCmd {
@Parameter(name = ApiConstants.ID,
type = CommandType.UUID,
entityType = BackupResponse.class,
- description = "id of the backup")
+ description = "ID of the backup")
private Long id;
@Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID,
type = CommandType.UUID,
entityType = UserVmResponse.class,
- description = "id of the VM")
+ description = "ID of the Instance")
private Long vmId;
@Parameter(name = ApiConstants.ZONE_ID,
type = CommandType.UUID,
entityType = ZoneResponse.class,
- description = "list backups by zone id")
+ description = "List backups by zone id")
private Long zoneId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/backup/RemoveVirtualMachineFromBackupOfferingCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/backup/RemoveVirtualMachineFromBackupOfferingCmd.java
index c451bff5456..81f11edb7d9 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/backup/RemoveVirtualMachineFromBackupOfferingCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/backup/RemoveVirtualMachineFromBackupOfferingCmd.java
@@ -39,7 +39,7 @@ import com.cloud.exception.ResourceAllocationException;
import com.cloud.exception.ResourceUnavailableException;
@APICommand(name = "removeVirtualMachineFromBackupOffering",
- description = "Removes a VM from any existing backup offering",
+ description = "Removes an Instance from any existing backup offering",
responseObject = SuccessResponse.class, since = "4.14.0",
authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User})
public class RemoveVirtualMachineFromBackupOfferingCmd extends BaseAsyncCmd {
@@ -55,12 +55,12 @@ public class RemoveVirtualMachineFromBackupOfferingCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = UserVmResponse.class,
required = true,
- description = "ID of the virtual machine")
+ description = "ID of the Instance")
private Long vmId;
@Parameter(name = ApiConstants.FORCED,
type = CommandType.BOOLEAN,
- description = "Whether to force remove VM from the backup offering that may also delete VM backups.")
+ description = "Whether to force remove Instance from the backup offering that may also delete Instance backups.")
private Boolean forced;
/////////////////////////////////////////////////////
@@ -87,7 +87,7 @@ public class RemoveVirtualMachineFromBackupOfferingCmd extends BaseAsyncCmd {
SuccessResponse response = new SuccessResponse(getCommandName());
this.setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to remove VM from backup offering");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to remove Instance from backup offering");
}
} catch (Exception e) {
throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, e.getMessage());
@@ -106,6 +106,6 @@ public class RemoveVirtualMachineFromBackupOfferingCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "Removing VM ID" + vmId + " from backup offering";
+ return "Removing Instance ID" + vmId + " from backup offering";
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/backup/RestoreBackupCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/backup/RestoreBackupCmd.java
index 6d02a084b70..5385c0fb0b6 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/backup/RestoreBackupCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/backup/RestoreBackupCmd.java
@@ -40,7 +40,7 @@ import com.cloud.exception.ResourceUnavailableException;
import com.cloud.utils.exception.CloudRuntimeException;
@APICommand(name = "restoreBackup",
- description = "Restores an existing stopped or deleted VM using a VM backup",
+ description = "Restores an existing stopped or deleted Instance using an Instance backup",
responseObject = SuccessResponse.class, since = "4.14.0",
authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User})
public class RestoreBackupCmd extends BaseAsyncCmd {
@@ -80,7 +80,7 @@ public class RestoreBackupCmd extends BaseAsyncCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new CloudRuntimeException("Error while restoring VM from backup");
+ throw new CloudRuntimeException("Error while restoring Instance from backup");
}
} catch (Exception e) {
throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, e.getMessage());
@@ -99,6 +99,6 @@ public class RestoreBackupCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "Restoring VM from backup: " + backupId;
+ return "Restoring Instance from backup: " + backupId;
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/backup/RestoreVolumeFromBackupAndAttachToVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/backup/RestoreVolumeFromBackupAndAttachToVMCmd.java
index 310b0bd9bf1..cee367a149c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/backup/RestoreVolumeFromBackupAndAttachToVMCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/backup/RestoreVolumeFromBackupAndAttachToVMCmd.java
@@ -41,7 +41,7 @@ import com.cloud.exception.ResourceUnavailableException;
import com.cloud.utils.exception.CloudRuntimeException;
@APICommand(name = "restoreVolumeFromBackupAndAttachToVM",
- description = "Restore and attach a backed up volume to VM",
+ description = "Restore and attach a backed up volume to Instance",
responseObject = SuccessResponse.class, since = "4.14.0",
authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User})
public class RestoreVolumeFromBackupAndAttachToVMCmd extends BaseAsyncCmd {
@@ -57,7 +57,7 @@ public class RestoreVolumeFromBackupAndAttachToVMCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = BackupResponse.class,
required = true,
- description = "ID of the VM backup")
+ description = "ID of the Instance backup")
private Long backupId;
@Parameter(name = ApiConstants.VOLUME_ID,
@@ -70,7 +70,7 @@ public class RestoreVolumeFromBackupAndAttachToVMCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = UserVmResponse.class,
required = true,
- description = "id of the VM where to attach the restored volume")
+ description = "ID of the Instance where to attach the restored volume")
private Long vmId;
/////////////////////////////////////////////////////
@@ -107,7 +107,7 @@ public class RestoreVolumeFromBackupAndAttachToVMCmd extends BaseAsyncCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new CloudRuntimeException("Error restoring volume and attaching to VM");
+ throw new CloudRuntimeException("Error restoring volume and attaching to Instance");
}
} catch (Exception e) {
throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, e.getMessage());
@@ -121,6 +121,6 @@ public class RestoreVolumeFromBackupAndAttachToVMCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "Restoring volume "+ volumeUuid + " from backup " + backupId + " and attaching it to VM " + vmId;
+ return "Restoring volume "+ volumeUuid + " from backup " + backupId + " and attaching it to Instance " + vmId;
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/backup/UpdateBackupScheduleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/backup/UpdateBackupScheduleCmd.java
index 47c8dc42fac..f4938ee0f87 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/backup/UpdateBackupScheduleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/backup/UpdateBackupScheduleCmd.java
@@ -22,7 +22,7 @@ import org.apache.cloudstack.api.APICommand;
import org.apache.cloudstack.api.response.BackupResponse;
@APICommand(name = "updateBackupSchedule",
- description = "Updates a user-defined VM backup schedule",
+ description = "Updates a User-defined Instance backup schedule",
responseObject = BackupResponse.class, since = "4.14.0",
authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User})
public class UpdateBackupScheduleCmd extends CreateBackupScheduleCmd {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/config/ListCapabilitiesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/config/ListCapabilitiesCmd.java
index 0cecbb37020..7553ccffa7d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/config/ListCapabilitiesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/config/ListCapabilitiesCmd.java
@@ -72,6 +72,8 @@ public class ListCapabilitiesCmd extends BaseCmd {
response.setInstancesDisksStatsRetentionTime((Integer) capabilities.get(ApiConstants.INSTANCES_DISKS_STATS_RETENTION_TIME));
response.setSharedFsVmMinCpuCount((Integer)capabilities.get(ApiConstants.SHAREDFSVM_MIN_CPU_COUNT));
response.setSharedFsVmMinRamSize((Integer)capabilities.get(ApiConstants.SHAREDFSVM_MIN_RAM_SIZE));
+ response.setDynamicScalingEnabled((Boolean) capabilities.get(ApiConstants.DYNAMIC_SCALING_ENABLED));
+ response.setAdditionalConfigEnabled((Boolean) capabilities.get(ApiConstants.ADDITONAL_CONFIG_ENABLED));
response.setObjectName("capability");
response.setResponseName(getCommandName());
this.setResponseObject(response);
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/consoleproxy/CreateConsoleEndpointCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/consoleproxy/CreateConsoleEndpointCmd.java
index 63b47e163b6..a4c12833ee9 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/consoleproxy/CreateConsoleEndpointCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/consoleproxy/CreateConsoleEndpointCmd.java
@@ -39,7 +39,7 @@ import org.apache.commons.collections.MapUtils;
import javax.inject.Inject;
import java.util.Map;
-@APICommand(name = "createConsoleEndpoint", description = "Create a console endpoint to connect to a VM console",
+@APICommand(name = "createConsoleEndpoint", description = "Create a console endpoint to connect to a Instance console",
responseObject = CreateConsoleEndpointResponse.class, since = "4.18.0",
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false,
authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User})
@@ -53,7 +53,7 @@ public class CreateConsoleEndpointCmd extends BaseCmd {
type = CommandType.UUID,
entityType = UserVmResponse.class,
required = true,
- description = "ID of the VM")
+ description = "ID of the Instance")
private Long vmId;
@Parameter(name = ApiConstants.TOKEN,
@@ -70,7 +70,7 @@ public class CreateConsoleEndpointCmd extends BaseCmd {
CreateConsoleEndpointResponse response = createResponse(endpoint);
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Unable to generate console endpoint for vm " + vmId);
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Unable to generate console endpoint for Instance " + vmId);
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/event/ArchiveEventsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/event/ArchiveEventsCmd.java
index 669b1782e9e..e449f4b002b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/event/ArchiveEventsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/event/ArchiveEventsCmd.java
@@ -48,18 +48,18 @@ public class ArchiveEventsCmd extends BaseCmd {
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = EventResponse.class,
- description = "the IDs of the events")
+ description = "The IDs of the events")
private List ids;
- @Parameter(name = ApiConstants.END_DATE, type = CommandType.DATE, description = "end date range to archive events"
+ @Parameter(name = ApiConstants.END_DATE, type = CommandType.DATE, description = "End date range to archive events"
+ " (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")")
private Date endDate;
- @Parameter(name = ApiConstants.START_DATE, type = CommandType.DATE, description = "start date range to archive events"
+ @Parameter(name = ApiConstants.START_DATE, type = CommandType.DATE, description = "Start date range to archive events"
+ " (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")")
private Date startDate;
- @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, description = "archive by event type")
+ @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, description = "Archive by event type")
private String type;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/event/DeleteEventsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/event/DeleteEventsCmd.java
index c9c3f1d6955..db183a08e5a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/event/DeleteEventsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/event/DeleteEventsCmd.java
@@ -48,18 +48,18 @@ public class DeleteEventsCmd extends BaseCmd {
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = EventResponse.class,
- description = "the IDs of the events")
+ description = "The IDs of the events")
private List ids;
- @Parameter(name = ApiConstants.END_DATE, type = CommandType.DATE, description = "end date range to delete events"
+ @Parameter(name = ApiConstants.END_DATE, type = CommandType.DATE, description = "End date range to delete events"
+ " (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")")
private Date endDate;
- @Parameter(name = ApiConstants.START_DATE, type = CommandType.DATE, description = "start date range to delete events"
+ @Parameter(name = ApiConstants.START_DATE, type = CommandType.DATE, description = "Start date range to delete events"
+ " (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")")
private Date startDate;
- @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, description = "delete by event type")
+ @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, description = "Delete by event type")
private String type;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/event/ListEventsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/event/ListEventsCmd.java
index b5273c64922..dcea200456a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/event/ListEventsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/event/ListEventsCmd.java
@@ -36,41 +36,41 @@ public class ListEventsCmd extends BaseListProjectAndAccountResourcesCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = EventResponse.class, description = "the ID of the event")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = EventResponse.class, description = "The ID of the event")
private Long id;
- @Parameter(name = ApiConstants.DURATION, type = CommandType.INTEGER, description = "the duration of the event")
+ @Parameter(name = ApiConstants.DURATION, type = CommandType.INTEGER, description = "The duration of the event")
private Integer duration;
@Parameter(name = ApiConstants.END_DATE,
type = CommandType.DATE,
- description = "the end date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")")
+ description = "The end date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")")
private Date endDate;
- @Parameter(name = ApiConstants.ENTRY_TIME, type = CommandType.INTEGER, description = "the time the event was entered")
+ @Parameter(name = ApiConstants.ENTRY_TIME, type = CommandType.INTEGER, description = "The time the event was entered")
private Integer entryTime;
- @Parameter(name = ApiConstants.LEVEL, type = CommandType.STRING, description = "the event level (INFO, WARN, ERROR)")
+ @Parameter(name = ApiConstants.LEVEL, type = CommandType.STRING, description = "The event level (INFO, WARN, ERROR)")
private String level;
@Parameter(name = ApiConstants.START_DATE,
type = CommandType.DATE,
- description = "the start date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")")
+ description = "The start date range of the list you want to retrieve (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-dd HH:mm:ss\")")
private Date startDate;
- @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, description = "the event type (see event types)")
+ @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, description = "The event type (see event types)")
private String type;
- @Parameter(name = ApiConstants.START_ID, type = CommandType.UUID, entityType = EventResponse.class, description = "the parent/start ID of the event, when provided this will list all the events with the start/parent ID including the parent event")
+ @Parameter(name = ApiConstants.START_ID, type = CommandType.UUID, entityType = EventResponse.class, description = "The parent/start ID of the event, when provided this will list all the events with the start/parent ID including the parent event")
private Long startId;
- @Parameter(name = ApiConstants.RESOURCE_ID, type = CommandType.STRING, description = "the ID of the resource associated with the event", since="4.17.0")
+ @Parameter(name = ApiConstants.RESOURCE_ID, type = CommandType.STRING, description = "The ID of the resource associated with the event", since="4.17.0")
private String resourceId;
- @Parameter(name = ApiConstants.RESOURCE_TYPE, type = CommandType.STRING, description = "the type of the resource associated with the event", since="4.17.0")
+ @Parameter(name = ApiConstants.RESOURCE_TYPE, type = CommandType.STRING, description = "The type of the resource associated with the event", since="4.17.0")
private String resourceType;
- @Parameter(name = ApiConstants.ARCHIVED, type = CommandType.BOOLEAN, description = "true to list archived events otherwise false", since="4.19.0")
+ @Parameter(name = ApiConstants.ARCHIVED, type = CommandType.BOOLEAN, description = "True to list archived events otherwise false", since="4.19.0")
private Boolean archived;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/CreateEgressFirewallRuleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/CreateEgressFirewallRuleCmd.java
index 8cbbcea6a59..7a96421a385 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/CreateEgressFirewallRuleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/CreateEgressFirewallRuleCmd.java
@@ -57,37 +57,37 @@ public class CreateEgressFirewallRuleCmd extends BaseAsyncCreateCmd implements F
type = CommandType.UUID,
entityType = NetworkResponse.class,
required = true,
- description = "the network id of the port forwarding rule")
+ description = "The Network ID of the port forwarding rule")
private Long networkId;
@Parameter(name = ApiConstants.PROTOCOL,
type = CommandType.STRING,
required = true,
- description = "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.")
+ description = "The protocol for the firewall rule. Valid values are TCP/UDP/ICMP.")
private String protocol;
- @Parameter(name = ApiConstants.START_PORT, type = CommandType.INTEGER, description = "the starting port of firewall rule")
+ @Parameter(name = ApiConstants.START_PORT, type = CommandType.INTEGER, description = "The starting port of firewall rule")
private Integer publicStartPort;
- @Parameter(name = ApiConstants.END_PORT, type = CommandType.INTEGER, description = "the ending port of firewall rule")
+ @Parameter(name = ApiConstants.END_PORT, type = CommandType.INTEGER, description = "The ending port of firewall rule")
private Integer publicEndPort;
- @Parameter(name = ApiConstants.CIDR_LIST, type = CommandType.LIST, collectionType = CommandType.STRING, description = "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,).")
+ @Parameter(name = ApiConstants.CIDR_LIST, type = CommandType.LIST, collectionType = CommandType.STRING, description = "The CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,).")
private List cidrlist;
- @Parameter(name = ApiConstants.DEST_CIDR_LIST, type = CommandType.LIST, collectionType = CommandType.STRING, description = "the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,).")
+ @Parameter(name = ApiConstants.DEST_CIDR_LIST, type = CommandType.LIST, collectionType = CommandType.STRING, description = "The CIDR list to forward traffic to. Multiple entries must be separated by a single comma character (,).")
private List destCidrList;
- @Parameter(name = ApiConstants.ICMP_TYPE, type = CommandType.INTEGER, description = "type of the icmp message being sent")
+ @Parameter(name = ApiConstants.ICMP_TYPE, type = CommandType.INTEGER, description = "Type of the ICMP message being sent")
private Integer icmpType;
- @Parameter(name = ApiConstants.ICMP_CODE, type = CommandType.INTEGER, description = "error code for this icmp message")
+ @Parameter(name = ApiConstants.ICMP_CODE, type = CommandType.INTEGER, description = "Error code for this ICMP message")
private Integer icmpCode;
- @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, description = "type of firewallrule: system/user")
+ @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, description = "Type of firewallrule: system/user")
private String type;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the rule to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the rule to the end user or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/CreateFirewallRuleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/CreateFirewallRuleCmd.java
index efccb5c09b0..569b5fc454d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/CreateFirewallRuleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/CreateFirewallRuleCmd.java
@@ -57,34 +57,34 @@ public class CreateFirewallRuleCmd extends BaseAsyncCreateCmd implements Firewal
type = CommandType.UUID,
entityType = IPAddressResponse.class,
required = true,
- description = "the IP address id of the port forwarding rule")
+ description = "The IP address ID of the port forwarding rule")
private Long ipAddressId;
@Parameter(name = ApiConstants.PROTOCOL,
type = CommandType.STRING,
required = true,
- description = "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.")
+ description = "The protocol for the firewall rule. Valid values are TCP/UDP/ICMP.")
private String protocol;
- @Parameter(name = ApiConstants.START_PORT, type = CommandType.INTEGER, description = "the starting port of firewall rule")
+ @Parameter(name = ApiConstants.START_PORT, type = CommandType.INTEGER, description = "The starting port of firewall rule")
private Integer publicStartPort;
- @Parameter(name = ApiConstants.END_PORT, type = CommandType.INTEGER, description = "the ending port of firewall rule")
+ @Parameter(name = ApiConstants.END_PORT, type = CommandType.INTEGER, description = "The ending port of firewall rule")
private Integer publicEndPort;
- @Parameter(name = ApiConstants.CIDR_LIST, type = CommandType.LIST, collectionType = CommandType.STRING, description = "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,).")
+ @Parameter(name = ApiConstants.CIDR_LIST, type = CommandType.LIST, collectionType = CommandType.STRING, description = "The CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,).")
private List cidrlist;
- @Parameter(name = ApiConstants.ICMP_TYPE, type = CommandType.INTEGER, description = "type of the ICMP message being sent")
+ @Parameter(name = ApiConstants.ICMP_TYPE, type = CommandType.INTEGER, description = "Type of the ICMP message being sent")
private Integer icmpType;
- @Parameter(name = ApiConstants.ICMP_CODE, type = CommandType.INTEGER, description = "error code for this icmp message")
+ @Parameter(name = ApiConstants.ICMP_CODE, type = CommandType.INTEGER, description = "Error code for this icmp message")
private Integer icmpCode;
- @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, description = "type of firewallrule: system/user")
+ @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, description = "Type of firewallrule: system/user")
private String type;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the rule to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the rule to the end User or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
// ///////////////////////////////////////////////////
@@ -171,7 +171,7 @@ public class CreateFirewallRuleCmd extends BaseAsyncCreateCmd implements Firewal
@Override
public long getId() {
- throw new UnsupportedOperationException("database ID can only provided by VO objects");
+ throw new UnsupportedOperationException("Database ID can only provided by VO objects");
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/CreatePortForwardingRuleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/CreatePortForwardingRuleCmd.java
index 9d1fe176019..db6b788178a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/CreatePortForwardingRuleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/CreatePortForwardingRuleCmd.java
@@ -64,37 +64,37 @@ public class CreatePortForwardingRuleCmd extends BaseAsyncCreateCmd implements P
type = CommandType.UUID,
entityType = IPAddressResponse.class,
required = true,
- description = "the IP address id of the port forwarding rule")
+ description = "The IP address ID of the port forwarding rule")
private Long ipAddressId;
@Parameter(name = ApiConstants.PRIVATE_START_PORT,
type = CommandType.INTEGER,
required = true,
- description = "the starting port of port forwarding rule's private port range")
+ description = "The starting port of port forwarding rule's private port range")
private Integer privateStartPort;
@Parameter(name = ApiConstants.PROTOCOL,
type = CommandType.STRING,
required = true,
- description = "the protocol for the port forwarding rule. Valid values are TCP or UDP.")
+ description = "The protocol for the port forwarding rule. Valid values are TCP or UDP.")
private String protocol;
@Parameter(name = ApiConstants.PRIVATE_END_PORT,
type = CommandType.INTEGER,
required = false,
- description = "the ending port of port forwarding rule's private port range")
+ description = "The ending port of port forwarding rule's private port range")
private Integer privateEndPort;
@Parameter(name = ApiConstants.PUBLIC_START_PORT,
type = CommandType.INTEGER,
required = true,
- description = "the starting port of port forwarding rule's public port range")
+ description = "The starting port of port forwarding rule's public port range")
private Integer publicStartPort;
@Parameter(name = ApiConstants.PUBLIC_END_PORT,
type = CommandType.INTEGER,
required = false,
- description = "the ending port of port forwarding rule's private port range")
+ description = "The ending port of port forwarding rule's private port range")
private Integer publicEndPort;
@ACL(accessType = AccessType.OperateEntry)
@@ -102,17 +102,17 @@ public class CreatePortForwardingRuleCmd extends BaseAsyncCreateCmd implements P
type = CommandType.UUID,
entityType = UserVmResponse.class,
required = true,
- description = "the ID of the virtual machine for the port forwarding rule")
+ description = "The ID of the Instance for the port forwarding rule")
private Long virtualMachineId;
@Parameter(name = ApiConstants.CIDR_LIST,
type = CommandType.LIST,
collectionType = CommandType.STRING,
- description = " the source CIDR list to allow traffic from; all other CIDRs will be blocked. " +
+ description = "The source CIDR list to allow traffic from; all other CIDRs will be blocked. " +
"Multiple entries must be separated by a single comma character (,). This param will be used only for VPC tiers. By default, all CIDRs are allowed.")
private List sourceCidrList;
- @Parameter(name = ApiConstants.OPEN_FIREWALL, type = CommandType.BOOLEAN, description = "if true, firewall rule for source/end public port is automatically created; "
+ @Parameter(name = ApiConstants.OPEN_FIREWALL, type = CommandType.BOOLEAN, description = "If true, firewall rule for source/end public port is automatically created; "
+ "if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when PF"
+ " rule is being created for VPC guest network 2) in all other cases defaulted to true")
private Boolean openFirewall;
@@ -120,16 +120,16 @@ public class CreatePortForwardingRuleCmd extends BaseAsyncCreateCmd implements P
@Parameter(name = ApiConstants.NETWORK_ID,
type = CommandType.UUID,
entityType = NetworkResponse.class,
- description = "the network of the virtual machine the port forwarding rule will be created for. "
+ description = "The Network of the Instance the port forwarding rule will be created for. "
+ "Required when public IP address is not associated with any guest network yet (VPC case).")
private Long networkId;
@Parameter(name = ApiConstants.VM_GUEST_IP,
type = CommandType.STRING,
required = false,
- description = "VM guest nic secondary IP address for the port forwarding rule")
+ description = "Instance guest NIC secondary IP address for the port forwarding rule")
private String vmSecondaryIp;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the rule to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the rule to the end user or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
// ///////////////////////////////////////////////////
@@ -335,7 +335,7 @@ public class CreatePortForwardingRuleCmd extends BaseAsyncCreateCmd implements P
Ip privateIp = getVmSecondaryIp();
if (privateIp != null) {
if (!NetUtils.isValidIp4(privateIp.toString())) {
- throw new InvalidParameterValueException("Invalid vm ip address");
+ throw new InvalidParameterValueException("Invalid Instance IP address");
}
}
@@ -359,7 +359,7 @@ public class CreatePortForwardingRuleCmd extends BaseAsyncCreateCmd implements P
@Override
public String getEventDescription() {
IpAddress ip = _networkService.getIp(ipAddressId);
- return ("Applying port forwarding rule for Ip: " + ip.getAddress() + " with virtual machine:" + virtualMachineId);
+ return ("Applying port forwarding rule for Ip: " + ip.getAddress() + " with Instance:" + virtualMachineId);
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/DeleteEgressFirewallRuleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/DeleteEgressFirewallRuleCmd.java
index b93d943eab9..60c7839bdc6 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/DeleteEgressFirewallRuleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/DeleteEgressFirewallRuleCmd.java
@@ -46,7 +46,7 @@ public class DeleteEgressFirewallRuleCmd extends BaseAsyncCmd {
/////////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, required = true, description = "the ID of the firewall rule")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, required = true, description = "The ID of the firewall rule")
private Long id;
// unexposed parameter needed for events logging
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/DeleteFirewallRuleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/DeleteFirewallRuleCmd.java
index c4a4dfd75cb..7c4d5f2249f 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/DeleteFirewallRuleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/DeleteFirewallRuleCmd.java
@@ -44,7 +44,7 @@ public class DeleteFirewallRuleCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, required = true, description = "the ID of the firewall rule")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, required = true, description = "The ID of the firewall rule")
private Long id;
// unexposed parameter needed for events logging
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/DeletePortForwardingRuleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/DeletePortForwardingRuleCmd.java
index 267d18d8a8a..47dd9e039eb 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/DeletePortForwardingRuleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/DeletePortForwardingRuleCmd.java
@@ -48,7 +48,7 @@ public class DeletePortForwardingRuleCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = FirewallRuleResponse.class,
required = true,
- description = "the ID of the port forwarding rule")
+ description = "The ID of the port forwarding rule")
private Long id;
// unexposed parameter needed for events logging
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/ListEgressFirewallRulesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/ListEgressFirewallRulesCmd.java
index aa0fd28fdec..4a1547cccae 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/ListEgressFirewallRulesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/ListEgressFirewallRulesCmd.java
@@ -48,16 +48,16 @@ public class ListEgressFirewallRulesCmd extends BaseListTaggedResourcesCmd imple
@Parameter(name = ApiConstants.NETWORK_ID,
type = CommandType.UUID,
entityType = NetworkResponse.class,
- description = "the network ID for the egress firewall services")
+ description = "The network ID for the egress firewall services")
private Long networkId;
@Parameter(name = ApiConstants.IP_ADDRESS_ID,
type = CommandType.UUID,
entityType = IPAddressResponse.class,
- description = "the ID of IP address of the firewall services")
+ description = "The ID of IP address of the firewall services")
private Long ipAddressId;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "list resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "List resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/ListFirewallRulesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/ListFirewallRulesCmd.java
index 19a05b15890..6cb560df8f0 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/ListFirewallRulesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/ListFirewallRulesCmd.java
@@ -47,17 +47,17 @@ public class ListFirewallRulesCmd extends BaseListTaggedResourcesCmd implements
@Parameter(name = ApiConstants.IP_ADDRESS_ID,
type = CommandType.UUID,
entityType = IPAddressResponse.class,
- description = "the ID of IP address of the firewall services")
+ description = "The ID of IP address of the firewall services")
private Long ipAddressId;
@Parameter(name = ApiConstants.NETWORK_ID,
type = CommandType.UUID,
entityType = NetworkResponse.class,
- description = "list firewall rules for certain network",
+ description = "List firewall rules for certain network",
since = "4.3")
private Long networkId;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "list resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "List resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/ListPortForwardingRulesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/ListPortForwardingRulesCmd.java
index a2e9152a9e4..e5fd35f61eb 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/ListPortForwardingRulesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/ListPortForwardingRulesCmd.java
@@ -48,17 +48,17 @@ public class ListPortForwardingRulesCmd extends BaseListTaggedResourcesCmd {
@Parameter(name = ApiConstants.IP_ADDRESS_ID,
type = CommandType.UUID,
entityType = IPAddressResponse.class,
- description = "the ID of IP address of the port forwarding services")
+ description = "The ID of IP address of the port forwarding services")
private Long ipAddressId;
@Parameter(name = ApiConstants.NETWORK_ID,
type = CommandType.UUID,
entityType = NetworkResponse.class,
- description = "list port forwarding rules for certain network",
+ description = "List port forwarding rules for certain network",
since = "4.3")
private Long networkId;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "list resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "List resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/UpdateEgressFirewallRuleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/UpdateEgressFirewallRuleCmd.java
index a8db4ec2b29..7516a78f0ba 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/UpdateEgressFirewallRuleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/UpdateEgressFirewallRuleCmd.java
@@ -42,14 +42,14 @@ public class UpdateEgressFirewallRuleCmd extends BaseAsyncCustomIdCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, required = true, description = "the ID of the egress firewall rule")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, required = true, description = "The ID of the egress firewall rule")
private Long id;
// unexposed parameter needed for events logging
@Parameter(name = ApiConstants.ACCOUNT_ID, type = CommandType.UUID, entityType = AccountResponse.class, expose = false)
private Long ownerId;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the rule to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the rule to the end user or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/UpdateFirewallRuleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/UpdateFirewallRuleCmd.java
index 89c9bc891eb..347434d2394 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/UpdateFirewallRuleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/UpdateFirewallRuleCmd.java
@@ -42,14 +42,14 @@ public class UpdateFirewallRuleCmd extends BaseAsyncCustomIdCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, required = true, description = "the ID of the firewall rule")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, required = true, description = "The ID of the firewall rule")
private Long id;
// unexposed parameter needed for events logging
@Parameter(name = ApiConstants.ACCOUNT_ID, type = CommandType.UUID, entityType = AccountResponse.class, expose = false)
private Long ownerId;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the rule to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the rule to the end user or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/UpdatePortForwardingRuleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/UpdatePortForwardingRuleCmd.java
index ee4bd18ad40..aaeca27375b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/UpdatePortForwardingRuleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/firewall/UpdatePortForwardingRuleCmd.java
@@ -36,33 +36,33 @@ import java.util.List;
@APICommand(name = "updatePortForwardingRule",
responseObject = FirewallRuleResponse.class,
- description = "Updates a port forwarding rule. Only the private port and the virtual machine can be updated.", entityType = {PortForwardingRule.class},
+ description = "Updates a port forwarding rule. Only the private port and the Instance can be updated.", entityType = {PortForwardingRule.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class UpdatePortForwardingRuleCmd extends BaseAsyncCustomIdCmd {
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, required = true, description = "the ID of the port forwarding rule", since = "4.4")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, required = true, description = "The ID of the port forwarding rule", since = "4.4")
private Long id;
- @Parameter(name=ApiConstants.PRIVATE_START_PORT, type=CommandType.INTEGER, description="the private start port of the port forwarding rule")
+ @Parameter(name=ApiConstants.PRIVATE_START_PORT, type=CommandType.INTEGER, description = "The private start port of the port forwarding rule")
private Integer privatePort;
- @Parameter(name=ApiConstants.PRIVATE_END_PORT, type=CommandType.INTEGER, description="the private end port of the port forwarding rule")
+ @Parameter(name=ApiConstants.PRIVATE_END_PORT, type=CommandType.INTEGER, description = "The private end port of the port forwarding rule")
private Integer privateEndPort;
@Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID,
type = CommandType.UUID,
entityType = UserVmResponse.class,
- description = "the ID of the virtual machine for the port forwarding rule")
+ description = "The ID of the Instance for the port forwarding rule")
private Long virtualMachineId;
- @Parameter(name = ApiConstants.VM_GUEST_IP, type = CommandType.STRING, required = false, description = "VM guest nic Secondary ip address for the port forwarding rule", since = "4.5")
+ @Parameter(name = ApiConstants.VM_GUEST_IP, type = CommandType.STRING, required = false, description = "Instance guest NIC Secondary IP address for the port forwarding rule", since = "4.5")
private String vmGuestIp;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the rule to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the rule to the end user or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
@Parameter(name = ApiConstants.CIDR_LIST,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/guest/ListGuestOsCategoriesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/guest/ListGuestOsCategoriesCmd.java
index c74514d662c..948b1638c8c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/guest/ListGuestOsCategoriesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/guest/ListGuestOsCategoriesCmd.java
@@ -39,10 +39,10 @@ public class ListGuestOsCategoriesCmd extends BaseListCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = GuestOSCategoryResponse.class, description = "list Os category by id")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = GuestOSCategoryResponse.class, description = "List Os category by id")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "list os category by name", since = "3.0.1")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "List os category by name", since = "3.0.1")
private String name;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/guest/ListGuestOsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/guest/ListGuestOsCmd.java
index b31a4669220..4ff2ebf0a66 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/guest/ListGuestOsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/guest/ListGuestOsCmd.java
@@ -42,13 +42,13 @@ public class ListGuestOsCmd extends BaseListCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = GuestOSResponse.class, description = "list by Os type Id")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = GuestOSResponse.class, description = "List by OS type ID")
private Long id;
- @Parameter(name = ApiConstants.OS_CATEGORY_ID, type = CommandType.UUID, entityType = GuestOSCategoryResponse.class, description = "list by Os Category id")
+ @Parameter(name = ApiConstants.OS_CATEGORY_ID, type = CommandType.UUID, entityType = GuestOSCategoryResponse.class, description = "List by OS Category ID")
private Long osCategoryId;
- @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "list os by description", since = "3.0.1")
+ @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "List OS by description", since = "3.0.1")
private String description;
@Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "list resources by display flag; only ROOT admin is eligible to pass this parameter",
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/ipv6/CreateIpv6FirewallRuleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/ipv6/CreateIpv6FirewallRuleCmd.java
index 18af5b2973e..8db66112cdb 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/ipv6/CreateIpv6FirewallRuleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/ipv6/CreateIpv6FirewallRuleCmd.java
@@ -43,7 +43,7 @@ import com.cloud.user.Account;
import com.cloud.utils.net.NetUtils;
@APICommand(name = "createIpv6FirewallRule",
- description = "Creates an Ipv6 firewall rule in the given network (the network must not belong to VPC)",
+ description = "Creates an IPv6 firewall rule in the given Network (the Network must not belong to VPC)",
responseObject = FirewallRuleResponse.class,
requestHasSensitiveInfo = false,
responseHasSensitiveInfo = false,
@@ -55,34 +55,34 @@ public class CreateIpv6FirewallRuleCmd extends BaseAsyncCreateCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.PROTOCOL, type = CommandType.STRING, required = true, description = "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number")
+ @Parameter(name = ApiConstants.PROTOCOL, type = CommandType.STRING, required = true, description = "The protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number")
private String protocol;
- @Parameter(name = ApiConstants.START_PORT, type = CommandType.INTEGER, description = "the starting port of Ipv6 firewall rule")
+ @Parameter(name = ApiConstants.START_PORT, type = CommandType.INTEGER, description = "The starting port of Ipv6 firewall rule")
private Integer publicStartPort;
- @Parameter(name = ApiConstants.END_PORT, type = CommandType.INTEGER, description = "the ending port of Ipv6 firewall rule")
+ @Parameter(name = ApiConstants.END_PORT, type = CommandType.INTEGER, description = "The ending port of Ipv6 firewall rule")
private Integer publicEndPort;
- @Parameter(name = ApiConstants.CIDR_LIST, type = CommandType.LIST, collectionType = CommandType.STRING, description = "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).")
+ @Parameter(name = ApiConstants.CIDR_LIST, type = CommandType.LIST, collectionType = CommandType.STRING, description = "The source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).")
private List sourceCidrList;
- @Parameter(name = ApiConstants.DEST_CIDR_LIST, type = CommandType.LIST, collectionType = CommandType.STRING, description = "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).")
+ @Parameter(name = ApiConstants.DEST_CIDR_LIST, type = CommandType.LIST, collectionType = CommandType.STRING, description = "The destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).")
private List destinationCidrlist;
- @Parameter(name = ApiConstants.ICMP_TYPE, type = CommandType.INTEGER, description = "type of the ICMP message being sent")
+ @Parameter(name = ApiConstants.ICMP_TYPE, type = CommandType.INTEGER, description = "Type of the ICMP message being sent")
private Integer icmpType;
- @Parameter(name = ApiConstants.ICMP_CODE, type = CommandType.INTEGER, description = "error code for this ICMP message")
+ @Parameter(name = ApiConstants.ICMP_CODE, type = CommandType.INTEGER, description = "Error code for this ICMP message")
private Integer icmpCode;
- @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "The network of the VM the Ipv6 firewall rule will be created for", required = true)
+ @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "The Network of the Instance the Ipv6 firewall rule will be created for", required = true)
private Long networkId;
- @Parameter(name = ApiConstants.TRAFFIC_TYPE, type = CommandType.STRING, description = "the traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified")
+ @Parameter(name = ApiConstants.TRAFFIC_TYPE, type = CommandType.STRING, description = "The traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified")
private String trafficType;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the rule to the end user or not", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the rule to the end User or not", authorized = {RoleType.Admin})
private Boolean display;
// ///////////////////////////////////////////////////
@@ -193,7 +193,7 @@ public class CreateIpv6FirewallRuleCmd extends BaseAsyncCreateCmd {
@Override
public String getEventDescription() {
- return "Creating ipv6 firewall rule";
+ return "Creating IPv6 firewall rule";
}
public Integer getIcmpCode() {
@@ -246,7 +246,7 @@ public class CreateIpv6FirewallRuleCmd extends BaseAsyncCreateCmd {
} finally {
if (!success || rule == null) {
ipv6Service.revokeIpv6FirewallRule(getEntityId());
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create ipv6 firewall rule");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create IPv6 firewall rule");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/ipv6/DeleteIpv6FirewallRuleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/ipv6/DeleteIpv6FirewallRuleCmd.java
index aaee19b5948..19ecbda290c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/ipv6/DeleteIpv6FirewallRuleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/ipv6/DeleteIpv6FirewallRuleCmd.java
@@ -45,7 +45,7 @@ public class DeleteIpv6FirewallRuleCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, required = true, description = "the ID of the IPv6 firewall rule")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, required = true, description = "The ID of the IPv6 firewall rule")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/ipv6/ListIpv6FirewallRulesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/ipv6/ListIpv6FirewallRulesCmd.java
index 7ade2e3ed04..59401578cb2 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/ipv6/ListIpv6FirewallRulesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/ipv6/ListIpv6FirewallRulesCmd.java
@@ -46,16 +46,16 @@ public class ListIpv6FirewallRulesCmd extends BaseListTaggedResourcesCmd impleme
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class,
- description = "Lists ipv6 firewall rule with the specified ID")
+ description = "Lists IPv6 firewall rule with the specified ID")
private Long id;
- @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "list ipv6 firewall rules by network ID")
+ @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "List IPV6 firewall rules by Network ID")
private Long networkId;
- @Parameter(name = ApiConstants.TRAFFIC_TYPE, type = CommandType.STRING, description = "list ipv6 firewall rules by traffic type - ingress or egress")
+ @Parameter(name = ApiConstants.TRAFFIC_TYPE, type = CommandType.STRING, description = "List IPV6 firewall rules by traffic type - ingress or egress")
private String trafficType;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "list resources by display flag; only ROOT admin is eligible to pass this parameter", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "List resources by display flag; only ROOT admin is eligible to pass this parameter", authorized = {RoleType.Admin})
private Boolean display;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/ipv6/UpdateIpv6FirewallRuleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/ipv6/UpdateIpv6FirewallRuleCmd.java
index 2d63d703dc5..353f28e908b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/ipv6/UpdateIpv6FirewallRuleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/ipv6/UpdateIpv6FirewallRuleCmd.java
@@ -46,31 +46,31 @@ public class UpdateIpv6FirewallRuleCmd extends BaseAsyncCustomIdCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, required = true, description = "the ID of the ipv6 firewall rule")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, required = true, description = "The ID of the IPv6 firewall rule")
private Long id;
- @Parameter(name = ApiConstants.PROTOCOL, type = CommandType.STRING, description = "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number")
+ @Parameter(name = ApiConstants.PROTOCOL, type = CommandType.STRING, description = "The protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number")
private String protocol;
- @Parameter(name = ApiConstants.START_PORT, type = CommandType.INTEGER, description = "the starting port of Ipv6 firewall rule")
+ @Parameter(name = ApiConstants.START_PORT, type = CommandType.INTEGER, description = "The starting port of Ipv6 firewall rule")
private Integer publicStartPort;
- @Parameter(name = ApiConstants.END_PORT, type = CommandType.INTEGER, description = "the ending port of Ipv6 firewall rule")
+ @Parameter(name = ApiConstants.END_PORT, type = CommandType.INTEGER, description = "The ending port of Ipv6 firewall rule")
private Integer publicEndPort;
- @Parameter(name = ApiConstants.CIDR_LIST, type = CommandType.LIST, collectionType = CommandType.STRING, description = "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).")
+ @Parameter(name = ApiConstants.CIDR_LIST, type = CommandType.LIST, collectionType = CommandType.STRING, description = "The cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).")
private List cidrlist;
- @Parameter(name = ApiConstants.ICMP_TYPE, type = CommandType.INTEGER, description = "type of the ICMP message being sent")
+ @Parameter(name = ApiConstants.ICMP_TYPE, type = CommandType.INTEGER, description = "Type of the ICMP message being sent")
private Integer icmpType;
- @Parameter(name = ApiConstants.ICMP_CODE, type = CommandType.INTEGER, description = "error code for this ICMP message")
+ @Parameter(name = ApiConstants.ICMP_CODE, type = CommandType.INTEGER, description = "Error code for this ICMP message")
private Integer icmpCode;
- @Parameter(name = ApiConstants.TRAFFIC_TYPE, type = CommandType.STRING, description = "the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified")
+ @Parameter(name = ApiConstants.TRAFFIC_TYPE, type = CommandType.STRING, description = "The traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified")
private String trafficType;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the Ipv6 firewall rule to the end user or not", since = "4.4", authorized = {
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the Ipv6 firewall rule to the end User or not", since = "4.4", authorized = {
RoleType.Admin})
private Boolean display;
@@ -143,7 +143,7 @@ public class UpdateIpv6FirewallRuleCmd extends BaseAsyncCustomIdCmd {
@Override
public String getEventDescription() {
- return "Updating ipv6 firewall rule";
+ return "Updating IPv6 firewall rule";
}
public Integer getIcmpCode() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/iso/AttachIsoCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/iso/AttachIsoCmd.java
index d795fbabb52..27026d62a67 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/iso/AttachIsoCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/iso/AttachIsoCmd.java
@@ -35,7 +35,7 @@ import com.cloud.event.EventTypes;
import com.cloud.exception.InvalidParameterValueException;
import com.cloud.uservm.UserVm;
-@APICommand(name = "attachIso", description = "Attaches an ISO to a virtual machine.", responseObject = UserVmResponse.class, responseView = ResponseView.Restricted,
+@APICommand(name = "attachIso", description = "Attaches an ISO to an Instance.", responseObject = UserVmResponse.class, responseView = ResponseView.Restricted,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class AttachIsoCmd extends BaseAsyncCmd implements UserCmd {
@@ -46,11 +46,11 @@ public class AttachIsoCmd extends BaseAsyncCmd implements UserCmd {
/////////////////////////////////////////////////////
@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TemplateResponse.class,
- required = true, description = "the ID of the ISO file")
+ required = true, description = "The ID of the ISO file")
protected Long id;
@Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID, type = CommandType.UUID, entityType = UserVmResponse.class,
- required = true, description = "the ID of the virtual machine")
+ required = true, description = "The ID of the Instance")
protected Long virtualMachineId;
@Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN,
@@ -86,7 +86,7 @@ public class AttachIsoCmd extends BaseAsyncCmd implements UserCmd {
public long getEntityOwnerId() {
UserVm vm = _entityMgr.findById(UserVm.class, getVirtualMachineId());
if (vm == null) {
- throw new InvalidParameterValueException("Unable to find virtual machine by ID " + getVirtualMachineId());
+ throw new InvalidParameterValueException("Unable to find Instance by ID " + getVirtualMachineId());
}
return vm.getAccountId();
@@ -99,7 +99,7 @@ public class AttachIsoCmd extends BaseAsyncCmd implements UserCmd {
@Override
public String getEventDescription() {
- return "attaching ISO: " + getId() + " to VM: " + getVirtualMachineId();
+ return "attaching ISO: " + getId() + " to Instance: " + getVirtualMachineId();
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/iso/DeleteIsoCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/iso/DeleteIsoCmd.java
index feae31026b9..b00b11ab1d3 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/iso/DeleteIsoCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/iso/DeleteIsoCmd.java
@@ -41,13 +41,13 @@ public class DeleteIsoCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TemplateResponse.class, required = true, description = "the ID of the ISO file")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TemplateResponse.class, required = true, description = "The ID of the ISO file")
private Long id;
@Parameter(name = ApiConstants.ZONE_ID,
type = CommandType.UUID,
entityType = ZoneResponse.class,
- description = "the ID of the zone of the ISO file. If not specified, the ISO will be deleted from all the zones")
+ description = "The ID of the zone of the ISO file. If not specified, the ISO will be deleted from all the zones")
private Long zoneId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/iso/DetachIsoCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/iso/DetachIsoCmd.java
index 292e1c6f099..f49f3589a79 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/iso/DetachIsoCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/iso/DetachIsoCmd.java
@@ -33,7 +33,7 @@ import com.cloud.event.EventTypes;
import com.cloud.exception.InvalidParameterValueException;
import com.cloud.uservm.UserVm;
-@APICommand(name = "detachIso", description = "Detaches any ISO file (if any) currently attached to a virtual machine.", responseObject = UserVmResponse.class, responseView = ResponseView.Restricted,
+@APICommand(name = "detachIso", description = "Detaches any ISO file (if any) currently attached to an Instance.", responseObject = UserVmResponse.class, responseView = ResponseView.Restricted,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class DetachIsoCmd extends BaseAsyncCmd implements UserCmd {
@@ -44,7 +44,7 @@ public class DetachIsoCmd extends BaseAsyncCmd implements UserCmd {
/////////////////////////////////////////////////////
@Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID, type = CommandType.UUID, entityType = UserVmResponse.class,
- required = true, description = "The ID of the virtual machine")
+ required = true, description = "The ID of the Instance")
protected Long virtualMachineId;
@Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN,
@@ -78,7 +78,7 @@ public class DetachIsoCmd extends BaseAsyncCmd implements UserCmd {
if (vm != null) {
return vm.getAccountId();
} else {
- throw new InvalidParameterValueException("Unable to find VM by ID " + getVirtualMachineId());
+ throw new InvalidParameterValueException("Unable to find Instance by ID " + getVirtualMachineId());
}
}
@@ -89,7 +89,7 @@ public class DetachIsoCmd extends BaseAsyncCmd implements UserCmd {
@Override
public String getEventDescription() {
- return "detaching ISO from VM: " + getVirtualMachineId();
+ return "detaching ISO from Instance: " + getVirtualMachineId();
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/iso/ExtractIsoCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/iso/ExtractIsoCmd.java
index 4d11f0dc3d2..6cd8b312f97 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/iso/ExtractIsoCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/iso/ExtractIsoCmd.java
@@ -44,20 +44,20 @@ public class ExtractIsoCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TemplateResponse.class, required = true, description = "the ID of the ISO file")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TemplateResponse.class, required = true, description = "The ID of the ISO file")
private Long id;
- @Parameter(name = ApiConstants.URL, type = CommandType.STRING, required = false, length = 2048, description = "the URL to which the ISO would be extracted")
+ @Parameter(name = ApiConstants.URL, type = CommandType.STRING, required = false, length = 2048, description = "The URL to which the ISO would be extracted")
private String url;
@Parameter(name = ApiConstants.ZONE_ID,
type = CommandType.UUID,
entityType = ZoneResponse.class,
required = false,
- description = "the ID of the zone where the ISO is originally located")
+ description = "The ID of the zone where the ISO is originally located")
private Long zoneId;
- @Parameter(name = ApiConstants.MODE, type = CommandType.STRING, required = true, description = "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD")
+ @Parameter(name = ApiConstants.MODE, type = CommandType.STRING, required = true, description = "The mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD")
private String mode;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/iso/GetUploadParamsForIsoCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/iso/GetUploadParamsForIsoCmd.java
index 01a47f22b72..5cd7b151221 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/iso/GetUploadParamsForIsoCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/iso/GetUploadParamsForIsoCmd.java
@@ -38,7 +38,7 @@ import com.cloud.exception.ResourceAllocationException;
import com.cloud.exception.ResourceUnavailableException;
@APICommand(name = "getUploadParamsForIso",
- description = "upload an existing ISO into the CloudStack cloud.",
+ description = "Upload an existing ISO into the CloudStack cloud.",
responseObject = GetUploadParamsResponse.class, since = "4.13",
authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
@@ -50,30 +50,30 @@ public class GetUploadParamsForIsoCmd extends AbstractGetUploadParamsCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.BOOTABLE, type = BaseCmd.CommandType.BOOLEAN, description = "true if this ISO is bootable. If not passed explicitly its assumed to be true")
+ @Parameter(name = ApiConstants.BOOTABLE, type = BaseCmd.CommandType.BOOLEAN, description = "True if this ISO is bootable. If not passed explicitly its assumed to be true")
private Boolean bootable;
@Parameter(name = ApiConstants.DISPLAY_TEXT,
type = BaseCmd.CommandType.STRING,
- description = "the display text of the ISO. This is usually used for display purposes.",
+ description = "The display text of the ISO. This is usually used for display purposes.",
length = 4096)
private String displayText;
- @Parameter(name = ApiConstants.IS_FEATURED, type = BaseCmd.CommandType.BOOLEAN, description = "true if you want this ISO to be featured")
+ @Parameter(name = ApiConstants.IS_FEATURED, type = BaseCmd.CommandType.BOOLEAN, description = "True if you want this ISO to be featured")
private Boolean featured;
@Parameter(name = ApiConstants.IS_PUBLIC,
type = BaseCmd.CommandType.BOOLEAN,
- description = "true if you want to register the ISO to be publicly available to all users, false otherwise.")
+ description = "True if you want to register the ISO to be publicly available to all Users, false otherwise.")
private Boolean publicIso;
- @Parameter(name = ApiConstants.IS_EXTRACTABLE, type = BaseCmd.CommandType.BOOLEAN, description = "true if the ISO or its derivatives are extractable; default is false")
+ @Parameter(name = ApiConstants.IS_EXTRACTABLE, type = BaseCmd.CommandType.BOOLEAN, description = "True if the ISO or its derivatives are extractable; default is false")
private Boolean extractable;
@Parameter(name = ApiConstants.OS_TYPE_ID,
type = BaseCmd.CommandType.UUID,
entityType = GuestOSResponse.class,
- description = "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed")
+ description = "The ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed")
private Long osTypeId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/iso/ListIsoPermissionsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/iso/ListIsoPermissionsCmd.java
index 6f220c774b8..48e4b85d66e 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/iso/ListIsoPermissionsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/iso/ListIsoPermissionsCmd.java
@@ -26,7 +26,7 @@ import org.apache.cloudstack.api.response.TemplatePermissionsResponse;
import com.cloud.storage.Storage.ImageFormat;
import com.cloud.template.VirtualMachineTemplate;
-@APICommand(name = "listIsoPermissions", description = "List ISO visibility and all accounts that have permissions to view this ISO.", responseObject = TemplatePermissionsResponse.class, responseView = ResponseView.Restricted,
+@APICommand(name = "listIsoPermissions", description = "List ISO visibility and all Accounts that have permissions to view this ISO.", responseObject = TemplatePermissionsResponse.class, responseView = ResponseView.Restricted,
requestHasSensitiveInfo = false,
responseHasSensitiveInfo = false)
public class ListIsoPermissionsCmd extends BaseListTemplateOrIsoPermissionsCmd implements UserCmd {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/iso/ListIsosCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/iso/ListIsosCmd.java
index 5c4d606a93c..64885b6f833 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/iso/ListIsosCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/iso/ListIsosCmd.java
@@ -49,45 +49,45 @@ public class ListIsosCmd extends BaseListTaggedResourcesCmd implements UserCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.BOOTABLE, type = CommandType.BOOLEAN, description = "true if the ISO is bootable, false otherwise")
+ @Parameter(name = ApiConstants.BOOTABLE, type = CommandType.BOOLEAN, description = "True if the ISO is bootable, false otherwise")
private Boolean bootable;
- @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, description = "the hypervisor for which to restrict the search")
+ @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, description = "The hypervisor for which to restrict the search")
private String hypervisor;
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TemplateResponse.class, description = "list ISO by ID")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TemplateResponse.class, description = "List ISO by ID")
private Long id;
- @Parameter(name = ApiConstants.IS_PUBLIC, type = CommandType.BOOLEAN, description = "true if the ISO is publicly available to all users, false otherwise.")
+ @Parameter(name = ApiConstants.IS_PUBLIC, type = CommandType.BOOLEAN, description = "True if the ISO is publicly available to all Users, false otherwise.")
private Boolean publicIso;
- @Parameter(name = ApiConstants.IS_READY, type = CommandType.BOOLEAN, description = "true if this ISO is ready to be deployed")
+ @Parameter(name = ApiConstants.IS_READY, type = CommandType.BOOLEAN, description = "True if this ISO is ready to be deployed")
private Boolean ready;
@Parameter(name = ApiConstants.ISO_FILTER,
type = CommandType.STRING,
- description = "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". "
- + "* featured : templates that have been marked as featured and public. "
- + "* self : templates that have been registered or created by the calling user. "
- + "* selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. "
- + "* sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. "
- + "* executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. "
- + "* community : templates that have been marked as public but not featured. " + "* all : all templates (only usable by admins).")
+ description = "Possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". "
+ + "* featured : Templates that have been marked as featured and public. "
+ + "* self : Templates that have been registered or created by the calling User. "
+ + "* selfexecutable : same as self, but only returns Templates that can be used to deploy a new Instance. "
+ + "* sharedexecutable : Templates ready to be deployed that have been granted to the calling User by another User. "
+ + "* executable : Templates that are owned by the calling User, or public Templates, that can be used to deploy an Instance. "
+ + "* community : Templates that have been marked as public but not featured. " + "* all : all Templates (only usable by admins).")
private String isoFilter = TemplateFilter.selfexecutable.toString();
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "list all ISOs by name")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "List all ISOs by name")
private String isoName;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "the ID of the zone")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "The ID of the zone")
private Long zoneId;
- @Parameter(name=ApiConstants.SHOW_REMOVED, type=CommandType.BOOLEAN, description="show removed ISOs as well")
+ @Parameter(name=ApiConstants.SHOW_REMOVED, type=CommandType.BOOLEAN, description = "Show removed ISOs as well")
private Boolean showRemoved;
- @Parameter(name = ApiConstants.SHOW_UNIQUE, type = CommandType.BOOLEAN, description = "If set to true, list only unique isos across zones", since = "4.13.2")
+ @Parameter(name = ApiConstants.SHOW_UNIQUE, type = CommandType.BOOLEAN, description = "If set to true, list only unique ISOs across zones", since = "4.13.2")
private Boolean showUnique;
- @Parameter(name = ApiConstants.SHOW_RESOURCE_ICON, type = CommandType.BOOLEAN, description = "flag to display the resource image for the isos")
+ @Parameter(name = ApiConstants.SHOW_RESOURCE_ICON, type = CommandType.BOOLEAN, description = "Flag to display the resource image for the ISOs")
private Boolean showIcon;
@Parameter(name = ApiConstants.ARCH, type = CommandType.STRING,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/iso/RegisterIsoCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/iso/RegisterIsoCmd.java
index 81f52552289..f499c01ce58 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/iso/RegisterIsoCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/iso/RegisterIsoCmd.java
@@ -50,52 +50,52 @@ public class RegisterIsoCmd extends BaseCmd implements UserCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.BOOTABLE, type = CommandType.BOOLEAN, description = "true if this ISO is bootable. If not passed explicitly its assumed to be true")
+ @Parameter(name = ApiConstants.BOOTABLE, type = CommandType.BOOLEAN, description = "True if this ISO is bootable. If not passed explicitly its assumed to be true")
private Boolean bootable;
@Parameter(name = ApiConstants.DISPLAY_TEXT,
type = CommandType.STRING,
- description = "the display text of the ISO, defaults to the 'name'",
+ description = "The display text of the ISO, defaults to the 'name'",
length = 4096)
private String displayText;
- @Parameter(name = ApiConstants.IS_FEATURED, type = CommandType.BOOLEAN, description = "true if you want this ISO to be featured")
+ @Parameter(name = ApiConstants.IS_FEATURED, type = CommandType.BOOLEAN, description = "True if you want this ISO to be featured")
private Boolean featured;
@Parameter(name = ApiConstants.IS_PUBLIC,
type = CommandType.BOOLEAN,
- description = "true if you want to register the ISO to be publicly available to all users, false otherwise.")
+ description = "True if you want to register the ISO to be publicly available to all Users, false otherwise.")
private Boolean publicIso;
- @Parameter(name = ApiConstants.IS_EXTRACTABLE, type = CommandType.BOOLEAN, description = "true if the ISO or its derivatives are extractable; default is false")
+ @Parameter(name = ApiConstants.IS_EXTRACTABLE, type = CommandType.BOOLEAN, description = "True if the ISO or its derivatives are extractable; default is false")
private Boolean extractable;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "the name of the ISO")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "The name of the ISO")
private String isoName;
@Parameter(name = ApiConstants.OS_TYPE_ID,
type = CommandType.UUID,
entityType = GuestOSResponse.class,
- description = "the ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed")
+ description = "The ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed")
private Long osTypeId;
- @Parameter(name = ApiConstants.URL, type = CommandType.STRING, required = true, length = 2048, description = "the URL to where the ISO is currently being hosted")
+ @Parameter(name = ApiConstants.URL, type = CommandType.STRING, required = true, length = 2048, description = "The URL to where the ISO is currently being hosted")
private String url;
@Parameter(name=ApiConstants.ZONE_ID, type=CommandType.UUID, entityType = ZoneResponse.class,
- required=true, description="the ID of the zone you wish to register the ISO to.")
+ required=true, description = "The ID of the zone you wish to register the ISO to.")
protected Long zoneId;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "an optional domainId. If the account parameter is used, domainId must also be used.")
+ description = "An optional domainId. If the Account parameter is used, domainId must also be used.")
private Long domainId;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "an optional account name. Must be used with domainId.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "An optional Account name. Must be used with domainId.")
private String accountName;
- @Parameter(name = ApiConstants.CHECKSUM, type = CommandType.STRING, description = "the checksum value of this ISO. " + ApiConstants.CHECKSUM_PARAMETER_PREFIX_DESCRIPTION)
+ @Parameter(name = ApiConstants.CHECKSUM, type = CommandType.STRING, description = "The checksum value of this ISO. " + ApiConstants.CHECKSUM_PARAMETER_PREFIX_DESCRIPTION)
private String checksum;
@Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "Register ISO for the project")
@@ -106,17 +106,17 @@ public class RegisterIsoCmd extends BaseCmd implements UserCmd {
@Parameter(name = ApiConstants.IS_DYNAMICALLY_SCALABLE,
type = CommandType.BOOLEAN,
- description = "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory")
+ description = "True if ISO contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory")
protected Boolean isDynamicallyScalable;
@Parameter(name=ApiConstants.DIRECT_DOWNLOAD,
type = CommandType.BOOLEAN,
- description = "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment")
+ description = "True if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment")
private Boolean directDownload;
@Parameter(name = ApiConstants.PASSWORD_ENABLED,
type = CommandType.BOOLEAN,
- description = "true if password reset feature is supported; default is false")
+ description = "True if password reset feature is supported; default is false")
private Boolean passwordEnabled;
@Parameter(name = ApiConstants.ARCH, type = CommandType.STRING,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/job/ListAsyncJobsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/job/ListAsyncJobsCmd.java
index 783d78fdce3..b55d1b234f1 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/job/ListAsyncJobsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/job/ListAsyncJobsCmd.java
@@ -26,7 +26,7 @@ import org.apache.cloudstack.api.response.AsyncJobResponse;
import org.apache.cloudstack.api.response.ListResponse;
import org.apache.cloudstack.api.response.ManagementServerResponse;
-@APICommand(name = "listAsyncJobs", description = "Lists all pending asynchronous jobs for the account.", responseObject = AsyncJobResponse.class,
+@APICommand(name = "listAsyncJobs", description = "Lists all pending asynchronous jobs for the Account.", responseObject = AsyncJobResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListAsyncJobsCmd extends BaseListAccountResourcesCmd {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/job/QueryAsyncJobResultCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/job/QueryAsyncJobResultCmd.java
index 3d328543dc2..93a44375721 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/job/QueryAsyncJobResultCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/job/QueryAsyncJobResultCmd.java
@@ -34,7 +34,7 @@ public class QueryAsyncJobResultCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.JOB_ID, type = CommandType.UUID, entityType = AsyncJobResponse.class, required = true, description = "the ID of the asynchronous job")
+ @Parameter(name = ApiConstants.JOB_ID, type = CommandType.UUID, entityType = AsyncJobResponse.class, required = true, description = "The ID of the asynchronous job")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/AssignCertToLoadBalancerCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/AssignCertToLoadBalancerCmd.java
index 4f9d2f37d13..e663e88dbdb 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/AssignCertToLoadBalancerCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/AssignCertToLoadBalancerCmd.java
@@ -47,14 +47,14 @@ public class AssignCertToLoadBalancerCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = FirewallRuleResponse.class,
required = true,
- description = "the ID of the load balancer rule")
+ description = "The ID of the load balancer rule")
Long lbRuleId;
@Parameter(name = ApiConstants.CERTIFICATE_ID,
type = CommandType.UUID,
entityType = SslCertResponse.class,
required = true,
- description = "the ID of the certificate")
+ description = "The ID of the certificate")
Long certId;
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/AssignToLoadBalancerRuleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/AssignToLoadBalancerRuleCmd.java
index c4424b1d937..f7962dab137 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/AssignToLoadBalancerRuleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/AssignToLoadBalancerRuleCmd.java
@@ -45,7 +45,7 @@ import com.cloud.utils.net.NetUtils;
import com.cloud.vm.VirtualMachine;
@APICommand(name = "assignToLoadBalancerRule",
- description = "Assigns virtual machine or a list of virtual machines to a load balancer rule.",
+ description = "Assigns an Instance or a list of Instances to a load balancer rule.",
responseObject = SuccessResponse.class,
requestHasSensitiveInfo = false,
responseHasSensitiveInfo = false)
@@ -60,14 +60,14 @@ public class AssignToLoadBalancerRuleCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = FirewallRuleResponse.class,
required = true,
- description = "the ID of the load balancer rule")
+ description = "The ID of the load balancer rule")
private Long id;
@Parameter(name = ApiConstants.VIRTUAL_MACHINE_IDS,
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = UserVmResponse.class,
- description = "the list of IDs of the virtual machine that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3)")
+ description = "The list of IDs of the Instance that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3)")
private List virtualMachineIds;
@Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID_IP,
@@ -112,7 +112,7 @@ public class AssignToLoadBalancerRuleCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "applying instances for load balancer: " + getLoadBalancerId() + " (ids: " + StringUtils.join(getVirtualMachineIds(), ",") + ")";
+ return "applying Instances for load balancer: " + getLoadBalancerId() + " (ids: " + StringUtils.join(getVirtualMachineIds(), ",") + ")";
}
@@ -128,7 +128,7 @@ public class AssignToLoadBalancerRuleCmd extends BaseAsyncCmd {
VirtualMachine lbvm = _entityMgr.findByUuid(VirtualMachine.class, vmId);
if (lbvm == null) {
- throw new InvalidParameterValueException("Unable to find virtual machine ID: " + vmId);
+ throw new InvalidParameterValueException("Unable to find Instance ID: " + vmId);
}
//check whether the given ip is valid ip or not
@@ -155,7 +155,7 @@ public class AssignToLoadBalancerRuleCmd extends BaseAsyncCmd {
@Override
public void execute() {
- CallContext.current().setEventDetails("Load balancer Id: " + getLoadBalancerId() + " VmIds: " + StringUtils.join(getVirtualMachineIds(), ","));
+ CallContext.current().setEventDetails("Load balancer Id: " + getLoadBalancerId() + " Instance IDs: " + StringUtils.join(getVirtualMachineIds(), ","));
Map> vmIdIpsMap = getVmIdIpListMap();
boolean result = false;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/CreateApplicationLoadBalancerCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/CreateApplicationLoadBalancerCmd.java
index 2199dfb4e8b..b244375d64b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/CreateApplicationLoadBalancerCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/CreateApplicationLoadBalancerCmd.java
@@ -48,51 +48,51 @@ public class CreateApplicationLoadBalancerCmd extends BaseAsyncCreateCmd {
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "name of the load balancer")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "Name of the load balancer")
private String loadBalancerName;
- @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "the description of the load balancer", length = 4096)
+ @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "The description of the load balancer", length = 4096)
private String description;
@Parameter(name = ApiConstants.NETWORK_ID,
type = CommandType.UUID,
required = true,
entityType = NetworkResponse.class,
- description = "The guest network the load balancer will be created for")
+ description = "The guest Network the load balancer will be created for")
private Long networkId;
@Parameter(name = ApiConstants.SOURCE_PORT,
type = CommandType.INTEGER,
required = true,
- description = "the source port the network traffic will be load balanced from")
+ description = "The source port the Network traffic will be load balanced from")
private Integer sourcePort;
- @Parameter(name = ApiConstants.ALGORITHM, type = CommandType.STRING, required = true, description = "load balancer algorithm (source, roundrobin, leastconn)")
+ @Parameter(name = ApiConstants.ALGORITHM, type = CommandType.STRING, required = true, description = "Load balancer algorithm (source, roundrobin, leastconn)")
private String algorithm;
@Parameter(name = ApiConstants.INSTANCE_PORT,
type = CommandType.INTEGER,
required = true,
- description = "the TCP port of the virtual machine where the network traffic will be load balanced to")
+ description = "The TCP port of the Instance where the network traffic will be load balanced to")
private Integer instancePort;
- @Parameter(name = ApiConstants.SOURCE_IP, type = CommandType.STRING, description = "the source IP address the network traffic will be load balanced from")
+ @Parameter(name = ApiConstants.SOURCE_IP, type = CommandType.STRING, description = "The source IP address the network traffic will be load balanced from")
private String sourceIp;
@Parameter(name = ApiConstants.SOURCE_IP_NETWORK_ID,
type = CommandType.UUID,
entityType = NetworkResponse.class,
required = true,
- description = "the network id of the source ip address")
+ description = "The Network ID of the source IP address")
private Long sourceIpNetworkId;
@Parameter(name = ApiConstants.SCHEME,
type = CommandType.STRING,
required = true,
- description = "the load balancer scheme. Supported value in this release is Internal")
+ description = "The load balancer scheme. Supported value in this release is Internal")
private String scheme;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the rule to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the rule to the end user or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/CreateLBHealthCheckPolicyCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/CreateLBHealthCheckPolicyCmd.java
index c24a5f19f07..c4dfcad7918 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/CreateLBHealthCheckPolicyCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/CreateLBHealthCheckPolicyCmd.java
@@ -53,10 +53,10 @@ public class CreateLBHealthCheckPolicyCmd extends BaseAsyncCreateCmd {
type = CommandType.UUID,
entityType = FirewallRuleResponse.class,
required = true,
- description = "the ID of the load balancer rule")
+ description = "The ID of the load balancer rule")
private Long lbRuleId;
- @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "the description of the load balancer health check policy")
+ @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "The description of the load balancer health check policy")
private String description;
@Parameter(name = ApiConstants.HEALTHCHECK_PINGPATH, type = CommandType.STRING, required = false, description = "HTTP ping path")
@@ -77,16 +77,16 @@ public class CreateLBHealthCheckPolicyCmd extends BaseAsyncCreateCmd {
@Parameter(name = ApiConstants.HEALTHCHECK_HEALTHY_THRESHOLD,
type = CommandType.INTEGER,
required = false,
- description = "Number of consecutive health check success before declaring an instance healthy")
+ description = "Number of consecutive health check success before declaring an Instance healthy")
private int healthyThreshold;
@Parameter(name = ApiConstants.HEALTHCHECK_UNHEALTHY_THRESHOLD,
type = CommandType.INTEGER,
required = false,
- description = "Number of consecutive health check failures before declaring an instance unhealthy")
+ description = "Number of consecutive health check failures before declaring an Instance unhealthy")
private int unhealthyThreshold;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the rule to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the rule to the end user or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/CreateLBStickinessPolicyCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/CreateLBStickinessPolicyCmd.java
index c6b5036bc95..b336b84517f 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/CreateLBStickinessPolicyCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/CreateLBStickinessPolicyCmd.java
@@ -54,25 +54,25 @@ public class CreateLBStickinessPolicyCmd extends BaseAsyncCreateCmd {
type = CommandType.UUID,
entityType = FirewallRuleResponse.class,
required = true,
- description = "the ID of the load balancer rule")
+ description = "The ID of the load balancer rule")
private Long lbRuleId;
- @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "the description of the load balancer stickiness policy")
+ @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "The description of the load balancer stickiness policy")
private String description;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "name of the load balancer stickiness policy")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "Name of the load balancer stickiness policy")
private String lbStickinessPolicyName;
@Parameter(name = ApiConstants.METHOD_NAME,
type = CommandType.STRING,
required = true,
- description = "name of the load balancer stickiness policy method, possible values are LbCookie, AppCookie, SourceBased")
+ description = "Name of the load balancer stickiness policy method, possible values are LbCookie, AppCookie, SourceBased")
private String stickinessMethodName;
- @Parameter(name = ApiConstants.PARAM_LIST, type = CommandType.MAP, description = "param list. Example: param[0].name=cookiename¶m[0].value=LBCookie ")
+ @Parameter(name = ApiConstants.PARAM_LIST, type = CommandType.MAP, description = "Param list. Example: param[0].name=cookiename¶m[0].value=LBCookie ")
private Map paramList;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the rule to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the rule to the end user or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/CreateLoadBalancerRuleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/CreateLoadBalancerRuleCmd.java
index 34798c4efe1..e0293db2499 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/CreateLoadBalancerRuleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/CreateLoadBalancerRuleCmd.java
@@ -57,65 +57,65 @@ public class CreateLoadBalancerRuleCmd extends BaseAsyncCreateCmd /*implements L
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ALGORITHM, type = CommandType.STRING, required = true, description = "load balancer algorithm (source, roundrobin, leastconn)")
+ @Parameter(name = ApiConstants.ALGORITHM, type = CommandType.STRING, required = true, description = "Load balancer algorithm (source, roundrobin, leastconn)")
private String algorithm;
- @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "the description of the load balancer rule", length = 4096)
+ @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "The description of the load balancer rule", length = 4096)
private String description;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "name of the load balancer rule")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "Name of the load balancer rule")
private String loadBalancerRuleName;
@Parameter(name = ApiConstants.PRIVATE_PORT,
type = CommandType.INTEGER,
required = true,
- description = "the private port of the private IP address/virtual machine where the network traffic will be load balanced to")
+ description = "The private port of the private IP address/Instance where the network traffic will be load balanced to")
private Integer privatePort;
@Parameter(name = ApiConstants.PUBLIC_IP_ID,
type = CommandType.UUID,
entityType = IPAddressResponse.class,
- description = "public IP address ID from where the network traffic will be load balanced from")
+ description = "Public IP address ID from where the network traffic will be load balanced from")
private Long publicIpId;
@Parameter(name = ApiConstants.ZONE_ID,
type = CommandType.UUID,
entityType = ZoneResponse.class,
required = false,
- description = "zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm")
+ description = "Zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm")
private Long zoneId;
@Parameter(name = ApiConstants.PUBLIC_PORT,
type = CommandType.INTEGER,
required = true,
- description = "the public port from where the network traffic will be load balanced from")
+ description = "The public port from where the network traffic will be load balanced from")
private Integer publicPort;
- @Parameter(name = ApiConstants.OPEN_FIREWALL, type = CommandType.BOOLEAN, description = "if true, firewall rule for"
+ @Parameter(name = ApiConstants.OPEN_FIREWALL, type = CommandType.BOOLEAN, description = "If true, firewall rule for"
+ " source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when LB"
+ " rule is being created for VPC guest network 2) in all other cases defaulted to true")
private Boolean openFirewall;
@Parameter(name = ApiConstants.ACCOUNT,
type = CommandType.STRING,
- description = "the account associated with the load balancer. Must be used with the domainId parameter.")
+ description = "The Account associated with the load balancer. Must be used with the domainId parameter.")
private String accountName;
- @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "the domain ID associated with the load balancer")
+ @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "The domain ID associated with the load balancer")
private Long domainId;
- @Parameter(name = ApiConstants.CIDR_LIST, type = CommandType.LIST, collectionType = CommandType.STRING, since = "4.18.0.0", description = "the source CIDR list to allow traffic from; "
+ @Parameter(name = ApiConstants.CIDR_LIST, type = CommandType.LIST, collectionType = CommandType.STRING, since = "4.18.0.0", description = "The source CIDR list to allow traffic from; "
+ "all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). By default, all CIDRs are allowed.")
private List cidrlist;
- @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "The guest network this "
- + "rule will be created for. Required when public Ip address is not associated with any Guest network yet (VPC case)")
+ @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "The guest Network this "
+ + "rule will be created for. Required when public IP address is not associated with any Guest Network yet (VPC case)")
private Long networkId;
- @Parameter(name = ApiConstants.PROTOCOL, type = CommandType.STRING, description = "The protocol for the LB such as tcp, udp or tcp-proxy.")
+ @Parameter(name = ApiConstants.PROTOCOL, type = CommandType.STRING, description = "The protocol for the LB such as TCP, UDP or tcp-proxy.")
private String lbProtocol;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the rule to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the rule to the end user or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
/////////////////////////////////////////////////////
@@ -206,7 +206,7 @@ public class CreateLoadBalancerRuleCmd extends BaseAsyncCreateCmd /*implements L
} else {
Network defaultGuestNetwork = _networkService.getExclusiveGuestNetwork(zoneId);
if (defaultGuestNetwork == null) {
- throw new InvalidParameterValueException("Unable to find a default guest network for account " + getAccountName() + " in domain ID=" + getDomainId());
+ throw new InvalidParameterValueException("Unable to find a default guest Network for Account " + getAccountName() + " in domain ID=" + getDomainId());
} else {
return defaultGuestNetwork.getId();
}
@@ -216,7 +216,7 @@ public class CreateLoadBalancerRuleCmd extends BaseAsyncCreateCmd /*implements L
if (ipAddr.getAssociatedWithNetworkId() != null) {
return ipAddr.getAssociatedWithNetworkId();
} else {
- throw new InvalidParameterValueException("IP address ID=" + publicIpId + " is not associated with any network");
+ throw new InvalidParameterValueException("IP address ID=" + publicIpId + " is not associated with any Network");
}
}
}
@@ -339,10 +339,10 @@ public class CreateLoadBalancerRuleCmd extends BaseAsyncCreateCmd /*implements L
if (account != null) {
return account.getId();
} else {
- throw new InvalidParameterValueException("Unable to find account " + accountName + " in domain ID=" + domainId);
+ throw new InvalidParameterValueException("Unable to find Account " + accountName + " in domain ID=" + domainId);
}
} else {
- throw new InvalidParameterValueException("Can't define IP owner. Either specify account/domainId or publicIpId");
+ throw new InvalidParameterValueException("Can't define IP owner. Either specify Account/domainId or publicIpId");
}
}
@@ -387,7 +387,7 @@ public class CreateLoadBalancerRuleCmd extends BaseAsyncCreateCmd /*implements L
@Override
public String getEventDescription() {
- return "creating load balancer: " + getName() + " account: " + getAccountName();
+ return "Creating load balancer: " + getName() + " Account: " + getAccountName();
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/DeleteApplicationLoadBalancerCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/DeleteApplicationLoadBalancerCmd.java
index 410df086393..f2064d42ca4 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/DeleteApplicationLoadBalancerCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/DeleteApplicationLoadBalancerCmd.java
@@ -39,7 +39,7 @@ public class DeleteApplicationLoadBalancerCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, required = true, description = "the ID of the Load Balancer")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, required = true, description = "The ID of the Load Balancer")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/DeleteLBHealthCheckPolicyCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/DeleteLBHealthCheckPolicyCmd.java
index 3cf1f345037..27a92bb25fc 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/DeleteLBHealthCheckPolicyCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/DeleteLBHealthCheckPolicyCmd.java
@@ -44,7 +44,7 @@ public class DeleteLBHealthCheckPolicyCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = LBHealthCheckResponse.class,
required = true,
- description = "the ID of the load balancer health check policy")
+ description = "The ID of the load balancer health check policy")
private Long id;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/DeleteLBStickinessPolicyCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/DeleteLBStickinessPolicyCmd.java
index 5d04de3cae5..cc83835cd0e 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/DeleteLBStickinessPolicyCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/DeleteLBStickinessPolicyCmd.java
@@ -45,7 +45,7 @@ public class DeleteLBStickinessPolicyCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = LBStickinessResponse.class,
required = true,
- description = "the ID of the LB stickiness policy")
+ description = "The ID of the LB stickiness policy")
private Long id;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/DeleteLoadBalancerRuleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/DeleteLoadBalancerRuleCmd.java
index b4079430ee3..fee9067d695 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/DeleteLoadBalancerRuleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/DeleteLoadBalancerRuleCmd.java
@@ -44,7 +44,7 @@ public class DeleteLoadBalancerRuleCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = FirewallRuleResponse.class,
required = true,
- description = "the ID of the load balancer rule")
+ description = "The ID of the load balancer rule")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/ListApplicationLoadBalancersCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/ListApplicationLoadBalancersCmd.java
index d54f3e1155e..b1d29f18f1a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/ListApplicationLoadBalancersCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/ListApplicationLoadBalancersCmd.java
@@ -43,28 +43,28 @@ public class ListApplicationLoadBalancersCmd extends BaseListTaggedResourcesCmd
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, description = "the ID of the load balancer")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, description = "The ID of the load balancer")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the load balancer")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the load balancer")
private String loadBalancerName;
- @Parameter(name = ApiConstants.SOURCE_IP, type = CommandType.STRING, description = "the source IP address of the load balancer")
+ @Parameter(name = ApiConstants.SOURCE_IP, type = CommandType.STRING, description = "The source IP address of the load balancer")
private String sourceIp;
@Parameter(name = ApiConstants.SOURCE_IP_NETWORK_ID,
type = CommandType.UUID,
entityType = NetworkResponse.class,
- description = "the network ID of the source IP address")
+ description = "The network ID of the source IP address")
private Long sourceIpNetworkId;
- @Parameter(name = ApiConstants.SCHEME, type = CommandType.STRING, description = "the scheme of the load balancer. Supported value is internal in the current release")
+ @Parameter(name = ApiConstants.SCHEME, type = CommandType.STRING, description = "The scheme of the load balancer. Supported value is internal in the current release")
private String scheme;
- @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "the network ID of the load balancer")
+ @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "The network ID of the load balancer")
private Long networkId;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "list resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "List resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/ListLBHealthCheckPoliciesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/ListLBHealthCheckPoliciesCmd.java
index cb2cdb446d1..e91f315bdaf 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/ListLBHealthCheckPoliciesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/ListLBHealthCheckPoliciesCmd.java
@@ -44,13 +44,13 @@ public class ListLBHealthCheckPoliciesCmd extends BaseListCmd {
@Parameter(name = ApiConstants.LBID,
type = CommandType.UUID,
entityType = FirewallRuleResponse.class,
- description = "the ID of the load balancer rule")
+ description = "The ID of the load balancer rule")
private Long lbRuleId;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "list resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "List resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = LBHealthCheckResponse.class, description = "the ID of the health check policy", since = "4.4")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = LBHealthCheckResponse.class, description = "The ID of the health check policy", since = "4.4")
private Long id;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/ListLBStickinessPoliciesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/ListLBStickinessPoliciesCmd.java
index a48e2ea37b7..a14f731435b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/ListLBStickinessPoliciesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/ListLBStickinessPoliciesCmd.java
@@ -45,17 +45,17 @@ public class ListLBStickinessPoliciesCmd extends BaseListCmd {
@Parameter(name = ApiConstants.LBID,
type = CommandType.UUID,
entityType = FirewallRuleResponse.class,
- description = "the ID of the load balancer rule")
+ description = "The ID of the load balancer rule")
private Long lbRuleId;
@Parameter(name = ApiConstants.ID,
type = CommandType.UUID,
entityType = LBStickinessResponse.class,
- description = "the ID of the load balancer stickiness policy")
+ description = "The ID of the load balancer stickiness policy")
private Long id;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "list resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "List resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/ListLoadBalancerRuleInstancesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/ListLoadBalancerRuleInstancesCmd.java
index 3bfc68a95ba..8079e287c2a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/ListLoadBalancerRuleInstancesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/ListLoadBalancerRuleInstancesCmd.java
@@ -36,7 +36,7 @@ import org.apache.cloudstack.api.response.UserVmResponse;
import com.cloud.uservm.UserVm;
import com.cloud.utils.Pair;
-@APICommand(name = "listLoadBalancerRuleInstances", description = "List all virtual machine instances that are assigned to a load balancer rule.", responseObject = LoadBalancerRuleVmMapResponse.class, responseView = ResponseView.Restricted,
+@APICommand(name = "listLoadBalancerRuleInstances", description = "List all Instances that are assigned to a load balancer rule.", responseObject = LoadBalancerRuleVmMapResponse.class, responseView = ResponseView.Restricted,
requestHasSensitiveInfo = false,
responseHasSensitiveInfo = true)
public class ListLoadBalancerRuleInstancesCmd extends BaseListCmd implements UserCmd {
@@ -49,20 +49,20 @@ public class ListLoadBalancerRuleInstancesCmd extends BaseListCmd implements Use
@Parameter(name = ApiConstants.APPLIED,
type = CommandType.BOOLEAN,
- description = "true if listing all virtual machines currently applied to the load balancer rule; default is true")
+ description = "True if listing all Instances currently applied to the load balancer rule; default is true")
private Boolean applied;
@Parameter(name = ApiConstants.ID,
type = CommandType.UUID,
entityType = FirewallRuleResponse.class,
required = true,
- description = "the ID of the load balancer rule")
+ description = "The ID of the load balancer rule")
private Long id;
@Parameter(name = ApiConstants.LIST_LB_VMIPS,
type = CommandType.BOOLEAN,
- description = "true if load balancer rule VM IP information to be included; default is false")
+ description = "True if load balancer rule Instance IP information to be included; default is false")
private boolean isListLbVmip;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/ListLoadBalancerRulesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/ListLoadBalancerRulesCmd.java
index b8b82f0c4a8..6ee31756777 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/ListLoadBalancerRulesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/ListLoadBalancerRulesCmd.java
@@ -44,31 +44,31 @@ public class ListLoadBalancerRulesCmd extends BaseListTaggedResourcesCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, description = "the ID of the load balancer rule")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, description = "The ID of the load balancer rule")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the load balancer rule")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the load balancer rule")
private String loadBalancerRuleName;
@Parameter(name = ApiConstants.PUBLIC_IP_ID,
type = CommandType.UUID,
entityType = IPAddressResponse.class,
- description = "the public IP address ID of the load balancer rule")
+ description = "The public IP address ID of the load balancer rule")
private Long publicIpId;
@Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID,
type = CommandType.UUID,
entityType = UserVmResponse.class,
- description = "the ID of the virtual machine of the load balancer rule")
+ description = "The ID of the Instance of the load balancer rule")
private Long virtualMachineId;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "the availability zone ID")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "The availability zone ID")
private Long zoneId;
- @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "list by network ID the rule belongs to")
+ @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "List by Network ID the rule belongs to")
private Long networkId;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "list resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "List resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/RemoveCertFromLoadBalancerCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/RemoveCertFromLoadBalancerCmd.java
index dfaafe89923..3633aeca5ef 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/RemoveCertFromLoadBalancerCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/RemoveCertFromLoadBalancerCmd.java
@@ -45,7 +45,7 @@ public class RemoveCertFromLoadBalancerCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = FirewallRuleResponse.class,
required = true,
- description = "the ID of the load balancer rule")
+ description = "The ID of the load balancer rule")
Long lbRuleId;
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/RemoveFromLoadBalancerRuleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/RemoveFromLoadBalancerRuleCmd.java
index d29f2676ed5..713879c8c78 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/RemoveFromLoadBalancerRuleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/RemoveFromLoadBalancerRuleCmd.java
@@ -43,7 +43,7 @@ import com.cloud.network.rules.LoadBalancer;
import com.cloud.user.Account;
@APICommand(name = "removeFromLoadBalancerRule",
- description = "Removes a virtual machine or a list of virtual machines from a load balancer rule.",
+ description = "Removes an Instance or a list of Instances from a load balancer rule.",
responseObject = SuccessResponse.class,
requestHasSensitiveInfo = false,
responseHasSensitiveInfo = false)
@@ -65,7 +65,7 @@ public class RemoveFromLoadBalancerRuleCmd extends BaseAsyncCmd {
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = UserVmResponse.class,
- description = "the list of IDs of the virtual machines that are being removed from the load balancer rule (i.e. virtualMachineIds=1,2,3)")
+ description = "The list of IDs of the Instances that are being removed from the load balancer rule (i.e. virtualMachineIds=1,2,3)")
private List virtualMachineIds;
@Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID_IP,
@@ -121,7 +121,7 @@ public class RemoveFromLoadBalancerRuleCmd extends BaseAsyncCmd {
VirtualMachine lbvm = _entityMgr.findByUuid(VirtualMachine.class, vmId);
if (lbvm == null) {
- throw new InvalidParameterValueException("Unable to find virtual machine ID: " + vmId);
+ throw new InvalidParameterValueException("Unable to find Instance ID: " + vmId);
}
Long longVmId = lbvm.getId();
@@ -143,12 +143,12 @@ public class RemoveFromLoadBalancerRuleCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "removing instances from load balancer: " + getId() + " (ids: " + StringUtils.join(getVirtualMachineIds(), ",") + ")";
+ return "removing Instances from load balancer: " + getId() + " (ids: " + StringUtils.join(getVirtualMachineIds(), ",") + ")";
}
@Override
public void execute() {
- CallContext.current().setEventDetails("Load balancer Id: " + getId() + " VmIds: " + StringUtils.join(getVirtualMachineIds(), ","));
+ CallContext.current().setEventDetails("Load balancer Id: " + getId() + " Instance IDs: " + StringUtils.join(getVirtualMachineIds(), ","));
Map> vmIdIpsMap = getVmIdIpListMap();
try {
boolean result = _lbService.removeFromLoadBalancer(id, virtualMachineIds, vmIdIpsMap, false);
@@ -156,10 +156,10 @@ public class RemoveFromLoadBalancerRuleCmd extends BaseAsyncCmd {
SuccessResponse response = new SuccessResponse(getCommandName());
this.setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to remove instance from load balancer rule");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to remove Instance from load balancer rule");
}
}catch (InvalidParameterValueException ex) {
- throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "Failed to remove instance from load balancer rule");
+ throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "Failed to remove Instance from load balancer rule");
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/UpdateApplicationLoadBalancerCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/UpdateApplicationLoadBalancerCmd.java
index d129cd8988f..19a366732d5 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/UpdateApplicationLoadBalancerCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/UpdateApplicationLoadBalancerCmd.java
@@ -38,10 +38,10 @@ public class UpdateApplicationLoadBalancerCmd extends BaseAsyncCustomIdCmd {
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, required = true, description = "the ID of the load balancer")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, required = true, description = "The ID of the load balancer")
private Long id;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the rule to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the rule to the end user or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/UpdateLBHealthCheckPolicyCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/UpdateLBHealthCheckPolicyCmd.java
index fdd98fc3a0a..80e285aec51 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/UpdateLBHealthCheckPolicyCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/UpdateLBHealthCheckPolicyCmd.java
@@ -37,7 +37,7 @@ public class UpdateLBHealthCheckPolicyCmd extends BaseAsyncCustomIdCmd{
@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = LBHealthCheckResponse.class, required = true, description = "ID of load balancer health check policy")
private Long id;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the policy to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the policy to the end user or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/UpdateLBStickinessPolicyCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/UpdateLBStickinessPolicyCmd.java
index b2137cf262d..0163bb8a44f 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/UpdateLBStickinessPolicyCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/UpdateLBStickinessPolicyCmd.java
@@ -33,10 +33,10 @@ public class UpdateLBStickinessPolicyCmd extends BaseAsyncCustomIdCmd{
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = LBStickinessResponse.class, required = true, description = "id of lb stickiness policy")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = LBStickinessResponse.class, required = true, description = "ID of lb stickiness policy")
private Long id;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the policy to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the policy to the end user or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/UpdateLoadBalancerRuleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/UpdateLoadBalancerRuleCmd.java
index 25254ba9eb7..01b15191e73 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/UpdateLoadBalancerRuleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/UpdateLoadBalancerRuleCmd.java
@@ -42,23 +42,23 @@ public class UpdateLoadBalancerRuleCmd extends BaseAsyncCustomIdCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ALGORITHM, type = CommandType.STRING, description = "load balancer algorithm (source, roundrobin, leastconn)")
+ @Parameter(name = ApiConstants.ALGORITHM, type = CommandType.STRING, description = "Load balancer algorithm (source, roundrobin, leastconn)")
private String algorithm;
- @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "the description of the load balancer rule", length = 4096)
+ @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "The description of the load balancer rule", length = 4096)
private String description;
@Parameter(name = ApiConstants.ID,
type = CommandType.UUID,
entityType = FirewallRuleResponse.class,
required = true,
- description = "the ID of the load balancer rule to update")
+ description = "The ID of the load balancer rule to update")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the load balancer rule")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the load balancer rule")
private String loadBalancerName;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the rule to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the rule to the end user or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
@Parameter(name = ApiConstants.PROTOCOL, type = CommandType.STRING, description = "The protocol for the LB")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/UploadSslCertCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/UploadSslCertCmd.java
index e51b4dee9db..0032b7a0acd 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/UploadSslCertCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/loadbalancer/UploadSslCertCmd.java
@@ -61,13 +61,13 @@ public class UploadSslCertCmd extends BaseCmd {
@Parameter(name = ApiConstants.PASSWORD, type = CommandType.STRING, description = "Password for the private key")
private String password;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "account that will own the SSL certificate")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "Account that will own the SSL certificate")
private String accountName;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "an optional project for the SSL certificate")
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "An optional project for the SSL certificate")
private Long projectId;
- @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "domain ID of the account owning the SSL certificate")
+ @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "Domain ID of the account owning the SSL certificate")
private Long domainId;
@Parameter(name = ApiConstants.NAME , type = CommandType.STRING, required = true, description = "Name for the uploaded certificate")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/nat/CreateIpForwardingRuleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/nat/CreateIpForwardingRuleCmd.java
index e883a7a0e4d..1aaf5573a9d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/nat/CreateIpForwardingRuleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/nat/CreateIpForwardingRuleCmd.java
@@ -54,24 +54,24 @@ public class CreateIpForwardingRuleCmd extends BaseAsyncCreateCmd implements Sta
type = CommandType.UUID,
entityType = IPAddressResponse.class,
required = true,
- description = "the public IP address ID of the forwarding rule, already associated via associateIp")
+ description = "The public IP address ID of the forwarding rule, already associated via associateIp")
private Long ipAddressId;
- @Parameter(name = ApiConstants.START_PORT, type = CommandType.INTEGER, required = true, description = "the start port for the rule")
+ @Parameter(name = ApiConstants.START_PORT, type = CommandType.INTEGER, required = true, description = "The start port for the rule")
private Integer startPort;
- @Parameter(name = ApiConstants.END_PORT, type = CommandType.INTEGER, description = "the end port for the rule")
+ @Parameter(name = ApiConstants.END_PORT, type = CommandType.INTEGER, description = "The end port for the rule")
private Integer endPort;
- @Parameter(name = ApiConstants.PROTOCOL, type = CommandType.STRING, required = true, description = "the protocol for the rule. Valid values are TCP or UDP.")
+ @Parameter(name = ApiConstants.PROTOCOL, type = CommandType.STRING, required = true, description = "The protocol for the rule. Valid values are TCP or UDP.")
private String protocol;
@Parameter(name = ApiConstants.OPEN_FIREWALL,
type = CommandType.BOOLEAN,
- description = "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default")
+ description = "If true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default")
private Boolean openFirewall;
- @Parameter(name = ApiConstants.CIDR_LIST, type = CommandType.LIST, collectionType = CommandType.STRING, description = "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.")
+ @Parameter(name = ApiConstants.CIDR_LIST, type = CommandType.LIST, collectionType = CommandType.STRING, description = "The CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use.")
private List cidrlist;
/////////////////////////////////////////////////////
@@ -172,14 +172,14 @@ public class CreateIpForwardingRuleCmd extends BaseAsyncCreateCmd implements Sta
@Override
public String getEventDescription() {
IpAddress ip = _networkService.getIp(ipAddressId);
- return ("Applying an ipforwarding 1:1 NAT rule for IP: " + ip.getAddress() + " with virtual machine:" + getVirtualMachineId());
+ return ("Applying an IP forwarding 1:1 NAT rule for IP: " + ip.getAddress() + " with Instance:" + getVirtualMachineId());
}
private long getVirtualMachineId() {
Long vmId = _networkService.getIp(ipAddressId).getAssociatedWithVmId();
if (vmId == null) {
- throw new InvalidParameterValueException("IP address is not associated with any network, unable to create static NAT rule");
+ throw new InvalidParameterValueException("IP address is not associated with any Network, unable to create static NAT rule");
}
return vmId;
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/nat/DeleteIpForwardingRuleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/nat/DeleteIpForwardingRuleCmd.java
index e4c16a31751..6ca48bf36c4 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/nat/DeleteIpForwardingRuleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/nat/DeleteIpForwardingRuleCmd.java
@@ -42,7 +42,7 @@ public class DeleteIpForwardingRuleCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, required = true, description = "the ID of the forwarding rule")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, required = true, description = "The ID of the forwarding rule")
private Long id;
// unexposed parameter needed for events logging
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/nat/DisableStaticNatCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/nat/DisableStaticNatCmd.java
index 2bee7dfcc89..f3d03b8beb3 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/nat/DisableStaticNatCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/nat/DisableStaticNatCmd.java
@@ -46,7 +46,7 @@ public class DisableStaticNatCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = IPAddressResponse.class,
required = true,
- description = "the public IP address ID for which static NAT feature is being disabled")
+ description = "The public IP address ID for which static NAT feature is being disabled")
private Long ipAddressId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/nat/EnableStaticNatCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/nat/EnableStaticNatCmd.java
index 48c6cc20bf1..23ad2852a8e 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/nat/EnableStaticNatCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/nat/EnableStaticNatCmd.java
@@ -45,19 +45,19 @@ public class EnableStaticNatCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.IP_ADDRESS_ID, type = CommandType.UUID, entityType = IPAddressResponse.class, required = true, description = "the public IP "
+ @Parameter(name = ApiConstants.IP_ADDRESS_ID, type = CommandType.UUID, entityType = IPAddressResponse.class, required = true, description = "The public IP "
+ "address ID for which static NAT feature is being enabled")
private Long ipAddressId;
- @Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID, type = CommandType.UUID, entityType = UserVmResponse.class, required = true, description = "the ID of "
- + "the virtual machine for enabling static NAT feature")
+ @Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID, type = CommandType.UUID, entityType = UserVmResponse.class, required = true, description = "The ID of "
+ + "the Instance for enabling static NAT feature")
private Long virtualMachineId;
@Parameter(name = ApiConstants.NETWORK_ID,
type = CommandType.UUID,
entityType = NetworkResponse.class,
- description = "The network of the VM the static NAT will be enabled for."
- + " Required when public IP address is not associated with any guest network yet (VPC case)")
+ description = "The Network of the Instance the static NAT will be enabled for."
+ + " Required when public IP address is not associated with any guest Network yet (VPC case)")
private Long networkId;
@Parameter(name = ApiConstants.VM_GUEST_IP,
type = CommandType.STRING,
@@ -101,7 +101,7 @@ public class EnableStaticNatCmd extends BaseCmd {
if (ntwkId == null) {
throw new InvalidParameterValueException("Unable to enable static NAT for the ipAddress id=" + ipAddressId +
- " as IP is not associated with any network and no networkId is passed in");
+ " as IP is not associated with any Network and no networkId is passed in");
}
return ntwkId;
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/nat/ListIpForwardingRulesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/nat/ListIpForwardingRulesCmd.java
index 89981a6453b..089ed972b3b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/nat/ListIpForwardingRulesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/nat/ListIpForwardingRulesCmd.java
@@ -46,7 +46,7 @@ public class ListIpForwardingRulesCmd extends BaseListProjectAndAccountResources
@Parameter(name = ApiConstants.IP_ADDRESS_ID,
type = CommandType.UUID,
entityType = IPAddressResponse.class,
- description = "list the rule belonging to this public IP address")
+ description = "List the rule belonging to this public IP address")
private Long publicIpAddressId;
@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = FirewallRuleResponse.class, description = "Lists rule with the specified ID.")
@@ -55,7 +55,7 @@ public class ListIpForwardingRulesCmd extends BaseListProjectAndAccountResources
@Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID,
type = CommandType.UUID,
entityType = UserVmResponse.class,
- description = "Lists all rules applied to the specified VM.")
+ description = "Lists all rules applied to the specified Instance.")
private Long vmId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/network/CreateNetworkACLCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/network/CreateNetworkACLCmd.java
index 8d8e598bcab..a6cd724f2d1 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/network/CreateNetworkACLCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/network/CreateNetworkACLCmd.java
@@ -40,7 +40,7 @@ import com.cloud.network.vpc.NetworkACLItem;
import com.cloud.user.Account;
import com.cloud.utils.net.NetUtils;
-@APICommand(name = "createNetworkACL", description = "Creates a ACL rule in the given network (the network has to belong to VPC)", responseObject = NetworkACLItemResponse.class, requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
+@APICommand(name = "createNetworkACL", description = "Creates a ACL rule in the given Network (the Network has to belong to VPC)", responseObject = NetworkACLItemResponse.class, requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class CreateNetworkACLCmd extends BaseAsyncCreateCmd {
@@ -48,40 +48,40 @@ public class CreateNetworkACLCmd extends BaseAsyncCreateCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.PROTOCOL, type = CommandType.STRING, required = true, description = "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number")
+ @Parameter(name = ApiConstants.PROTOCOL, type = CommandType.STRING, required = true, description = "The protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number")
private String protocol;
- @Parameter(name = ApiConstants.START_PORT, type = CommandType.INTEGER, description = "the starting port of ACL")
+ @Parameter(name = ApiConstants.START_PORT, type = CommandType.INTEGER, description = "The starting port of ACL")
private Integer publicStartPort;
- @Parameter(name = ApiConstants.END_PORT, type = CommandType.INTEGER, description = "the ending port of ACL")
+ @Parameter(name = ApiConstants.END_PORT, type = CommandType.INTEGER, description = "The ending port of ACL")
private Integer publicEndPort;
- @Parameter(name = ApiConstants.CIDR_LIST, type = CommandType.LIST, collectionType = CommandType.STRING, description = "the CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).")
+ @Parameter(name = ApiConstants.CIDR_LIST, type = CommandType.LIST, collectionType = CommandType.STRING, description = "The CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).")
private List cidrlist;
- @Parameter(name = ApiConstants.ICMP_TYPE, type = CommandType.INTEGER, description = "type of the ICMP message being sent")
+ @Parameter(name = ApiConstants.ICMP_TYPE, type = CommandType.INTEGER, description = "Type of the ICMP message being sent")
private Integer icmpType;
- @Parameter(name = ApiConstants.ICMP_CODE, type = CommandType.INTEGER, description = "error code for this ICMP message")
+ @Parameter(name = ApiConstants.ICMP_CODE, type = CommandType.INTEGER, description = "Error code for this ICMP message")
private Integer icmpCode;
- @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "The network of the VM the ACL will be created for")
+ @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "The Network of the Instance the ACL will be created for")
private Long networkId;
- @Parameter(name = ApiConstants.ACL_ID, type = CommandType.UUID, entityType = NetworkACLResponse.class, description = "The network of the VM the ACL will be created for")
+ @Parameter(name = ApiConstants.ACL_ID, type = CommandType.UUID, entityType = NetworkACLResponse.class, description = "The network of the Instance the ACL will be created for")
private Long aclId;
- @Parameter(name = ApiConstants.TRAFFIC_TYPE, type = CommandType.STRING, description = "the traffic type for the ACL," + "can be ingress or egress, defaulted to ingress if not specified")
+ @Parameter(name = ApiConstants.TRAFFIC_TYPE, type = CommandType.STRING, description = "The traffic type for the ACL," + "can be ingress or egress, defaulted to ingress if not specified")
private String trafficType;
@Parameter(name = ApiConstants.NUMBER, type = CommandType.INTEGER, description = "The number of the ACL item, its ordering")
private Integer number;
- @Parameter(name = ApiConstants.ACTION, type = CommandType.STRING, description = "scl entry action, allow or deny")
+ @Parameter(name = ApiConstants.ACTION, type = CommandType.STRING, description = "ACL entry action, allow or deny")
private String action;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the rule to the end user or not", since = "4.4", authorized = {
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the rule to the end User or not", since = "4.4", authorized = {
RoleType.Admin})
private Boolean display;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/network/CreateNetworkACLListCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/network/CreateNetworkACLListCmd.java
index cd25a604e77..317032280f7 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/network/CreateNetworkACLListCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/network/CreateNetworkACLListCmd.java
@@ -36,7 +36,7 @@ import com.cloud.network.vpc.NetworkACL;
import com.cloud.network.vpc.Vpc;
import com.cloud.user.Account;
-@APICommand(name = "createNetworkACLList", description = "Creates a network ACL. If no VPC is given, then it creates a global ACL that can be used by everyone.",
+@APICommand(name = "createNetworkACLList", description = "Creates a Network ACL. If no VPC is given, then it creates a global ACL that can be used by everyone.",
responseObject = NetworkACLResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class CreateNetworkACLListCmd extends BaseAsyncCreateCmd {
@@ -46,19 +46,19 @@ public class CreateNetworkACLListCmd extends BaseAsyncCreateCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "Name of the network ACL list")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "Name of the Network ACL list")
private String name;
- @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "Description of the network ACL list")
+ @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "Description of the Network ACL list")
private String description;
@Parameter(name = ApiConstants.VPC_ID,
type = CommandType.UUID,
entityType = VpcResponse.class,
- description = "ID of the VPC associated with this network ACL list")
+ description = "ID of the VPC associated with this Network ACL list")
private Long vpcId;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the list to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the list to the end User or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
// ///////////////////////////////////////////////////
@@ -112,7 +112,7 @@ public class CreateNetworkACLListCmd extends BaseAsyncCreateCmd {
setResponseObject(aclResponse);
aclResponse.setResponseName(getCommandName());
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create network ACL");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create Network ACL");
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/network/CreateNetworkCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/network/CreateNetworkCmd.java
index aca3d3ca1b4..35fec1d6b3e 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/network/CreateNetworkCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/network/CreateNetworkCmd.java
@@ -57,68 +57,68 @@ public class CreateNetworkCmd extends BaseCmd implements UserCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "the name of the network")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "The name of the network")
private String name;
- @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "the display text of the network")
+ @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "The display text of the network")
private String displayText;
@Parameter(name = ApiConstants.NETWORK_OFFERING_ID,
type = CommandType.UUID,
entityType = NetworkOfferingResponse.class,
required = true,
- description = "the network offering ID")
+ description = "The network offering ID")
private Long networkOfferingId;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, required = true, description = "the zone ID for the network")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, required = true, description = "The zone ID for the network")
private Long zoneId;
@Parameter(name = ApiConstants.PHYSICAL_NETWORK_ID,
type = CommandType.UUID,
entityType = PhysicalNetworkResponse.class,
- description = "the physical network ID the network belongs to")
+ description = "The physical Network ID the network belongs to")
private Long physicalNetworkId;
- @Parameter(name = ApiConstants.GATEWAY, type = CommandType.STRING, description = "the gateway of the network. Required "
+ @Parameter(name = ApiConstants.GATEWAY, type = CommandType.STRING, description = "The gateway of the Network. Required "
+ "for shared networks and isolated networks when it belongs to VPC")
private String gateway;
- @Parameter(name = ApiConstants.NETMASK, type = CommandType.STRING, description = "the netmask of the network. Required "
+ @Parameter(name = ApiConstants.NETMASK, type = CommandType.STRING, description = "The netmask of the Network. Required "
+ "for shared networks and isolated networks when it belongs to VPC")
private String netmask;
- @Parameter(name = ApiConstants.START_IP, type = CommandType.STRING, description = "the beginning IP address in the network IP range")
+ @Parameter(name = ApiConstants.START_IP, type = CommandType.STRING, description = "The beginning IP address in the Network IP range")
private String startIp;
- @Parameter(name = ApiConstants.END_IP, type = CommandType.STRING, description = "the ending IP address in the network IP"
+ @Parameter(name = ApiConstants.END_IP, type = CommandType.STRING, description = "The ending IP address in the Network IP"
+ " range. If not specified, will be defaulted to startIP")
private String endIp;
- @Parameter(name = ApiConstants.ISOLATED_PVLAN, type = CommandType.STRING, description = "the isolated private VLAN for this network")
+ @Parameter(name = ApiConstants.ISOLATED_PVLAN, type = CommandType.STRING, description = "The isolated private VLAN for this Network")
private String isolatedPvlan;
@Parameter(name = ApiConstants.ISOLATED_PVLAN_TYPE, type = CommandType.STRING,
- description = "the isolated private VLAN type for this network")
+ description = "The isolated private VLAN type for this network")
private String isolatedPvlanType;
- @Parameter(name = ApiConstants.NETWORK_DOMAIN, type = CommandType.STRING, description = "network domain")
+ @Parameter(name = ApiConstants.NETWORK_DOMAIN, type = CommandType.STRING, description = "Network domain")
private String networkDomain;
@Parameter(name = ApiConstants.ACL_TYPE, type = CommandType.STRING, description = "Access control type; supported values"
- + " are account and domain. In 3.0 all shared networks should have aclType=Domain, and all isolated networks"
- + " - Account. Account means that only the account owner can use the network, domain - all accounts in the domain can use the network")
+ + " are Account and domain. In 3.0 all shared networks should have aclType=Domain, and all isolated networks"
+ + " - Account. Account means that only the Account owner can use the network, domain - all accounts in the domain can use the network")
private String aclType;
@Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "Account that will own the network. Account should be under the selected domain")
private String accountName;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "an optional project for the network")
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "An optional project for the network")
private Long projectId;
- @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "domain ID of the account owning a network. " +
- "If the account is not specified, but the acltype is Account or not specified, the network will be automatically assigned to the caller account and domain. " +
- "To create a network under the domain without linking it to any account, make sure to include acltype=Domain parameter in the api call. " +
- "If account is not specified, but acltype is Domain, the network will be created for the specified domain.")
+ @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "Domain ID of the account owning a network. " +
+ "If the Account is not specified, but the acltype is Account or not specified, the Network will be automatically assigned to the caller account and domain. " +
+ "To create a Network under the domain without linking it to any account, make sure to include acltype=Domain parameter in the api call. " +
+ "If Account is not specified, but acltype is Domain, the network will be created for the specified domain.")
private Long domainId;
@Parameter(name = ApiConstants.SUBDOMAIN_ACCESS,
@@ -127,22 +127,22 @@ public class CreateNetworkCmd extends BaseCmd implements UserCmd {
+ " subdomains to use networks dedicated to their parent domain(s). Should be used with aclType=Domain, defaulted to allow.subdomain.network.access global config if not specified")
private Boolean subdomainAccess;
- @Parameter(name = ApiConstants.VPC_ID, type = CommandType.UUID, entityType = VpcResponse.class, description = "the VPC network belongs to")
+ @Parameter(name = ApiConstants.VPC_ID, type = CommandType.UUID, entityType = VpcResponse.class, description = "The VPC network belongs to")
private Long vpcId;
@Parameter(name = ApiConstants.TUNGSTEN_VIRTUAL_ROUTER_UUID, type = CommandType.STRING, description = "Tungsten-Fabric virtual router the network belongs to")
private String tungstenVirtualRouterUuid;
- @Parameter(name = ApiConstants.START_IPV6, type = CommandType.STRING, description = "the beginning IPv6 address in the IPv6 network range")
+ @Parameter(name = ApiConstants.START_IPV6, type = CommandType.STRING, description = "The beginning IPv6 address in the IPv6 network range")
private String startIpv6;
- @Parameter(name = ApiConstants.END_IPV6, type = CommandType.STRING, description = "the ending IPv6 address in the IPv6 network range")
+ @Parameter(name = ApiConstants.END_IPV6, type = CommandType.STRING, description = "The ending IPv6 address in the IPv6 network range")
private String endIpv6;
- @Parameter(name = ApiConstants.IP6_GATEWAY, type = CommandType.STRING, description = "the gateway of the IPv6 network. Required for Shared networks")
+ @Parameter(name = ApiConstants.IP6_GATEWAY, type = CommandType.STRING, description = "The gateway of the IPv6 network. Required for Shared networks")
private String ip6Gateway;
- @Parameter(name = ApiConstants.IP6_CIDR, type = CommandType.STRING, description = "the CIDR of IPv6 network, must be at least /64")
+ @Parameter(name = ApiConstants.IP6_CIDR, type = CommandType.STRING, description = "The CIDR of IPv6 network, must be at least /64")
private String ip6Cidr;
@Parameter(name = ApiConstants.EXTERNAL_ID, type = CommandType.STRING, description = "ID of the network in an external system.")
@@ -150,7 +150,7 @@ public class CreateNetworkCmd extends BaseCmd implements UserCmd {
@Parameter(name = ApiConstants.DISPLAY_NETWORK,
type = CommandType.BOOLEAN,
- description = "an optional field, whether to the display the network to the end user or not.", authorized = {RoleType.Admin})
+ description = "An optional field, whether to the display the network to the end User or not.", authorized = {RoleType.Admin})
private Boolean displayNetwork;
@Parameter(name = ApiConstants.ACL_ID, type = CommandType.UUID, entityType = NetworkACLResponse.class, description = "Network ACL ID associated for the network")
@@ -171,16 +171,16 @@ public class CreateNetworkCmd extends BaseCmd implements UserCmd {
description = "MTU to be configured on the network VR's private interface(s)", since = "4.18.0")
private Integer privateMtu;
- @Parameter(name = ApiConstants.DNS1, type = CommandType.STRING, description = "the first IPv4 DNS for the network", since = "4.18.0")
+ @Parameter(name = ApiConstants.DNS1, type = CommandType.STRING, description = "The first IPv4 DNS for the network", since = "4.18.0")
private String ip4Dns1;
- @Parameter(name = ApiConstants.DNS2, type = CommandType.STRING, description = "the second IPv4 DNS for the network", since = "4.18.0")
+ @Parameter(name = ApiConstants.DNS2, type = CommandType.STRING, description = "The second IPv4 DNS for the network", since = "4.18.0")
private String ip4Dns2;
- @Parameter(name = ApiConstants.IP6_DNS1, type = CommandType.STRING, description = "the first IPv6 DNS for the network", since = "4.18.0")
+ @Parameter(name = ApiConstants.IP6_DNS1, type = CommandType.STRING, description = "The first IPv6 DNS for the network", since = "4.18.0")
private String ip6Dns1;
- @Parameter(name = ApiConstants.IP6_DNS2, type = CommandType.STRING, description = "the second IPv6 DNS for the network", since = "4.18.0")
+ @Parameter(name = ApiConstants.IP6_DNS2, type = CommandType.STRING, description = "The second IPv6 DNS for the network", since = "4.18.0")
private String ip6Dns2;
@Parameter(name = ApiConstants.SOURCE_NAT_IP,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/network/CreateNetworkPermissionsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/network/CreateNetworkPermissionsCmd.java
index 1df472cbb22..eb95bc78189 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/network/CreateNetworkPermissionsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/network/CreateNetworkPermissionsCmd.java
@@ -51,24 +51,24 @@ public class CreateNetworkPermissionsCmd extends BaseCmd {
@Parameter(name = ApiConstants.ACCOUNTS,
type = CommandType.LIST,
collectionType = CommandType.STRING,
- description = "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.")
+ description = "A comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.")
private List accountNames;
@Parameter(name = ApiConstants.ACCOUNT_IDS,
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = AccountResponse.class,
- description = "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.")
+ description = "A comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.")
private List accountIds;
- @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, required = true, description = "the network ID")
+ @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, required = true, description = "The network ID")
private Long networkId;
@Parameter(name = ApiConstants.PROJECT_IDS,
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = ProjectResponse.class,
- description = "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.")
+ description = "A comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.")
private List projectIds;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/network/DeleteNetworkACLCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/network/DeleteNetworkACLCmd.java
index ca42626eacb..76bbd127066 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/network/DeleteNetworkACLCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/network/DeleteNetworkACLCmd.java
@@ -32,7 +32,7 @@ import com.cloud.event.EventTypes;
import com.cloud.exception.ResourceUnavailableException;
import com.cloud.user.Account;
-@APICommand(name = "deleteNetworkACL", description = "Deletes a network ACL", responseObject = SuccessResponse.class,
+@APICommand(name = "deleteNetworkACL", description = "Deletes a Network ACL", responseObject = SuccessResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class DeleteNetworkACLCmd extends BaseAsyncCmd {
@@ -40,7 +40,7 @@ public class DeleteNetworkACLCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = NetworkACLItemResponse.class, required = true, description = "the ID of the network ACL")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = NetworkACLItemResponse.class, required = true, description = "The ID of the Network ACL")
private Long id;
/////////////////////////////////////////////////////
@@ -89,7 +89,7 @@ public class DeleteNetworkACLCmd extends BaseAsyncCmd {
SuccessResponse response = new SuccessResponse(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to delete network ACL item");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to delete Network ACL item");
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/network/DeleteNetworkACLListCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/network/DeleteNetworkACLListCmd.java
index 45bc86e8c91..0352a5756b1 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/network/DeleteNetworkACLListCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/network/DeleteNetworkACLListCmd.java
@@ -40,7 +40,7 @@ public class DeleteNetworkACLListCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = NetworkACLResponse.class, required = true, description = "the ID of the network ACL")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = NetworkACLResponse.class, required = true, description = "The ID of the network ACL")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/network/DeleteNetworkCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/network/DeleteNetworkCmd.java
index 8e8e18c6702..7063be7ee18 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/network/DeleteNetworkCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/network/DeleteNetworkCmd.java
@@ -33,7 +33,7 @@ import com.cloud.event.EventTypes;
import com.cloud.exception.InvalidParameterValueException;
import com.cloud.network.Network;
-@APICommand(name = "deleteNetwork", description = "Deletes a network", responseObject = SuccessResponse.class, entityType = {Network.class},
+@APICommand(name = "deleteNetwork", description = "Deletes a Network", responseObject = SuccessResponse.class, entityType = {Network.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class DeleteNetworkCmd extends BaseAsyncCmd {
@@ -41,7 +41,7 @@ public class DeleteNetworkCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = NetworkResponse.class, required = true, description = "the ID of the network")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = NetworkResponse.class, required = true, description = "The ID of the network")
private Long id;
@Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN, required = false, description = "Force delete a network." +
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/network/ListNetworkACLListsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/network/ListNetworkACLListsCmd.java
index c88f956943b..62834a51e03 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/network/ListNetworkACLListsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/network/ListNetworkACLListsCmd.java
@@ -43,16 +43,16 @@ public class ListNetworkACLListsCmd extends BaseListProjectAndAccountResourcesCm
@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = NetworkACLResponse.class, description = "Lists network ACL with the specified ID.")
private Long id;
- @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "list network ACLs by network ID")
+ @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "List network ACLs by network ID")
private Long networkId;
- @Parameter(name = ApiConstants.VPC_ID, type = CommandType.UUID, entityType = VpcResponse.class, description = "list network ACLs by VPC ID")
+ @Parameter(name = ApiConstants.VPC_ID, type = CommandType.UUID, entityType = VpcResponse.class, description = "List network ACLs by VPC ID")
private Long vpcId;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "list network ACLs by specified name")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "List network ACLs by specified name")
private String name;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "list resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "List resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/network/ListNetworkACLsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/network/ListNetworkACLsCmd.java
index 1ef2b9b7bfb..159f07296ee 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/network/ListNetworkACLsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/network/ListNetworkACLsCmd.java
@@ -44,22 +44,22 @@ public class ListNetworkACLsCmd extends BaseListTaggedResourcesCmd {
description = "Lists network ACL Item with the specified ID")
private Long id;
- @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "list network ACL items by network ID")
+ @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "List network ACL items by network ID")
private Long networkId;
- @Parameter(name = ApiConstants.TRAFFIC_TYPE, type = CommandType.STRING, description = "list network ACL items by traffic type - ingress or egress")
+ @Parameter(name = ApiConstants.TRAFFIC_TYPE, type = CommandType.STRING, description = "List network ACL items by traffic type - ingress or egress")
private String trafficType;
- @Parameter(name = ApiConstants.ACL_ID, type = CommandType.UUID, entityType = NetworkACLResponse.class, description = "list network ACL items by ACL ID")
+ @Parameter(name = ApiConstants.ACL_ID, type = CommandType.UUID, entityType = NetworkACLResponse.class, description = "List network ACL items by ACL ID")
private Long aclId;
- @Parameter(name = ApiConstants.PROTOCOL, type = CommandType.STRING, description = "list network ACL items by protocol")
+ @Parameter(name = ApiConstants.PROTOCOL, type = CommandType.STRING, description = "List network ACL items by protocol")
private String protocol;
- @Parameter(name = ApiConstants.ACTION, type = CommandType.STRING, description = "list network ACL items by action")
+ @Parameter(name = ApiConstants.ACTION, type = CommandType.STRING, description = "List network ACL items by action")
private String action;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "list resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "List resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/network/ListNetworkOfferingsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/network/ListNetworkOfferingsCmd.java
index bdc89d804cd..ff3b61056be 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/network/ListNetworkOfferingsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/network/ListNetworkOfferingsCmd.java
@@ -39,75 +39,75 @@ public class ListNetworkOfferingsCmd extends BaseListCmd {
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = NetworkOfferingResponse.class, description = "list network offerings by ID")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = NetworkOfferingResponse.class, description = "List network offerings by ID")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "list network offerings by name")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "List network offerings by name")
private String networkOfferingName;
- @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "list network offerings by display text")
+ @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "List network offerings by display text")
private String displayText;
- @Parameter(name = ApiConstants.TRAFFIC_TYPE, type = CommandType.STRING, description = "list by traffic type")
+ @Parameter(name = ApiConstants.TRAFFIC_TYPE, type = CommandType.STRING, description = "List by traffic type")
private String trafficType;
- @Parameter(name = ApiConstants.IS_DEFAULT, type = CommandType.BOOLEAN, description = "true if need to list only default network offerings. Default value is false")
+ @Parameter(name = ApiConstants.IS_DEFAULT, type = CommandType.BOOLEAN, description = "True if need to list only default network offerings. Default value is false")
private Boolean isDefault;
- @Parameter(name = ApiConstants.SPECIFY_VLAN, type = CommandType.BOOLEAN, description = "the tags for the network offering.")
+ @Parameter(name = ApiConstants.SPECIFY_VLAN, type = CommandType.BOOLEAN, description = "The tags for the network offering.")
private Boolean specifyVlan;
- @Parameter(name = ApiConstants.AVAILABILITY, type = CommandType.STRING, description = "the availability of network offering. Default value is required")
+ @Parameter(name = ApiConstants.AVAILABILITY, type = CommandType.STRING, description = "The availability of network offering. Default value is required")
private String availability;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "list network offerings available for network creation in specific domain",
+ description = "List network offerings available for network creation in specific domain",
since = "4.13")
private Long domainId;
@Parameter(name = ApiConstants.ZONE_ID,
type = CommandType.UUID,
entityType = ZoneResponse.class,
- description = "list network offerings available for network creation in specific zone")
+ description = "List network offerings available for network creation in specific zone")
private Long zoneId;
- @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "list network offerings by state")
+ @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "List network offerings by state")
private String state;
@Parameter(name = ApiConstants.NETWORK_ID,
type = CommandType.UUID,
entityType = NetworkResponse.class,
- description = "the ID of the network. Pass this in if you want to see the available network offering that a network can be changed to.")
+ description = "The ID of the network. Pass this in if you want to see the available network offering that a network can be changed to.")
private Long networkId;
- @Parameter(name = ApiConstants.GUEST_IP_TYPE, type = CommandType.STRING, description = "list network offerings by guest type: shared or isolated")
+ @Parameter(name = ApiConstants.GUEST_IP_TYPE, type = CommandType.STRING, description = "List network offerings by guest type: shared or isolated")
private String guestIpType;
@Parameter(name = ApiConstants.SUPPORTED_SERVICES,
type = CommandType.LIST,
collectionType = CommandType.STRING,
- description = "list network offerings supporting certain services")
+ description = "List network offerings supporting certain services")
private List supportedServices;
@Parameter(name = ApiConstants.SOURCE_NAT_SUPPORTED,
type = CommandType.BOOLEAN,
- description = "true if need to list only netwok offerings where source NAT is supported, false otherwise")
+ description = "True if need to list only netwok offerings where source NAT is supported, false otherwise")
private Boolean sourceNatSupported;
@Parameter(name = ApiConstants.SPECIFY_IP_RANGES,
type = CommandType.BOOLEAN,
- description = "true if need to list only network offerings which support specifying ip ranges")
+ description = "True if need to list only network offerings which support specifying ip ranges")
private Boolean specifyIpRanges;
- @Parameter(name = ApiConstants.TAGS, type = CommandType.STRING, description = "list network offerings by tags", length = 4096)
+ @Parameter(name = ApiConstants.TAGS, type = CommandType.STRING, description = "List network offerings by tags", length = 4096)
private String tags;
- @Parameter(name = ApiConstants.IS_TAGGED, type = CommandType.BOOLEAN, description = "true if offering has tags specified")
+ @Parameter(name = ApiConstants.IS_TAGGED, type = CommandType.BOOLEAN, description = "True if offering has tags specified")
private Boolean isTagged;
- @Parameter(name = ApiConstants.FOR_VPC, type = CommandType.BOOLEAN, description = "the network offering can be used" + " only for network creation inside the VPC")
+ @Parameter(name = ApiConstants.FOR_VPC, type = CommandType.BOOLEAN, description = "The network offering can be used" + " only for network creation inside the VPC")
private Boolean forVpc;
@Parameter(name = ApiConstants.ROUTING_MODE,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/network/ListNetworkPermissionsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/network/ListNetworkPermissionsCmd.java
index 6ea4937e115..e852fdccecb 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/network/ListNetworkPermissionsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/network/ListNetworkPermissionsCmd.java
@@ -34,7 +34,7 @@ import com.cloud.user.Account;
import java.util.ArrayList;
import java.util.List;
-@APICommand(name = "listNetworkPermissions", description = "List network visibility and all accounts that have permissions to view this network.",
+@APICommand(name = "listNetworkPermissions", description = "List Network visibility and all Accounts that have permissions to view this Network.",
responseObject = NetworkPermissionsResponse.class,
requestHasSensitiveInfo = false,
responseHasSensitiveInfo = false,
@@ -47,7 +47,7 @@ public class ListNetworkPermissionsCmd extends BaseCmd implements UserCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, required = true, description = "Lists network permission by network ID")
+ @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, required = true, description = "Lists Network permission by Network ID")
private Long networkId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/network/ListNetworksCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/network/ListNetworksCmd.java
index 0e8425b14b4..110b4d48c12 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/network/ListNetworksCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/network/ListNetworksCmd.java
@@ -42,7 +42,7 @@ import com.cloud.network.Network;
import com.cloud.utils.Pair;
import org.apache.commons.lang3.StringUtils;
-@APICommand(name = "listNetworks", description = "Lists all available networks.", responseObject = NetworkResponse.class, responseView = ResponseView.Restricted, entityType = {Network.class},
+@APICommand(name = "listNetworks", description = "Lists all available Networks.", responseObject = NetworkResponse.class, responseView = ResponseView.Restricted, entityType = {Network.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListNetworksCmd extends BaseListRetrieveOnlyResourceCountCmd implements UserCmd {
private static final String s_name = "listnetworksresponse";
@@ -50,49 +50,49 @@ public class ListNetworksCmd extends BaseListRetrieveOnlyResourceCountCmd implem
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "list networks by ID")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "List Networks by ID")
private Long id;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "the zone ID of the network")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "The zone ID of the Network")
private Long zoneId;
- @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, description = "the type of the network. Supported values are: isolated, l2, shared and all")
+ @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, description = "The type of the Network. Supported values are: isolated, l2, shared and all")
private String guestIpType;
- @Parameter(name = ApiConstants.IS_SYSTEM, type = CommandType.BOOLEAN, description = "true if network is system, false otherwise")
+ @Parameter(name = ApiConstants.IS_SYSTEM, type = CommandType.BOOLEAN, description = "True if Network is system, false otherwise")
private Boolean isSystem;
- @Parameter(name = ApiConstants.ACL_TYPE, type = CommandType.STRING, description = "list networks by ACL (access control list) type. Supported values are account and domain")
+ @Parameter(name = ApiConstants.ACL_TYPE, type = CommandType.STRING, description = "List Networks by ACL (access control list) type. Supported values are Account and domain")
private String aclType;
- @Parameter(name = ApiConstants.TRAFFIC_TYPE, type = CommandType.STRING, description = "type of the traffic")
+ @Parameter(name = ApiConstants.TRAFFIC_TYPE, type = CommandType.STRING, description = "Type of the traffic")
private String trafficType;
- @Parameter(name = ApiConstants.PHYSICAL_NETWORK_ID, type = CommandType.UUID, entityType = PhysicalNetworkResponse.class, description = "list networks by physical network id")
+ @Parameter(name = ApiConstants.PHYSICAL_NETWORK_ID, type = CommandType.UUID, entityType = PhysicalNetworkResponse.class, description = "List Networks by physical Network ID")
private Long physicalNetworkId;
- @Parameter(name = ApiConstants.SUPPORTED_SERVICES, type = CommandType.LIST, collectionType = CommandType.STRING, description = "list networks supporting certain services")
+ @Parameter(name = ApiConstants.SUPPORTED_SERVICES, type = CommandType.LIST, collectionType = CommandType.STRING, description = "List Networks supporting certain services")
private List supportedServices;
- @Parameter(name = ApiConstants.RESTART_REQUIRED, type = CommandType.BOOLEAN, description = "list networks by restartRequired")
+ @Parameter(name = ApiConstants.RESTART_REQUIRED, type = CommandType.BOOLEAN, description = "List networks by restartRequired")
private Boolean restartRequired;
- @Parameter(name = ApiConstants.SPECIFY_IP_RANGES, type = CommandType.BOOLEAN, description = "true if need to list only networks which support specifying IP ranges")
+ @Parameter(name = ApiConstants.SPECIFY_IP_RANGES, type = CommandType.BOOLEAN, description = "True if need to list only networks which support specifying IP ranges")
private Boolean specifyIpRanges;
@Parameter(name = ApiConstants.VPC_ID, type = CommandType.UUID, entityType = VpcResponse.class, description = "List networks by VPC")
private Long vpcId;
- @Parameter(name = ApiConstants.CAN_USE_FOR_DEPLOY, type = CommandType.BOOLEAN, description = "list networks available for VM deployment")
+ @Parameter(name = ApiConstants.CAN_USE_FOR_DEPLOY, type = CommandType.BOOLEAN, description = "List networks available for Instance deployment")
private Boolean canUseForDeploy;
- @Parameter(name = ApiConstants.FOR_VPC, type = CommandType.BOOLEAN, description = "the network belongs to VPC")
+ @Parameter(name = ApiConstants.FOR_VPC, type = CommandType.BOOLEAN, description = "The network belongs to VPC")
private Boolean forVpc;
- @Parameter(name = ApiConstants.DISPLAY_NETWORK, type = CommandType.BOOLEAN, description = "list resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.DISPLAY_NETWORK, type = CommandType.BOOLEAN, description = "List resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
- @Parameter(name = ApiConstants.NETWORK_OFFERING_ID, type = CommandType.UUID, entityType = NetworkOfferingResponse.class, description = "list networks by network offering ID")
+ @Parameter(name = ApiConstants.NETWORK_OFFERING_ID, type = CommandType.UUID, entityType = NetworkOfferingResponse.class, description = "List networks by network offering ID")
private Long networkOfferingId;
@Parameter(name = ApiConstants.ASSOCIATED_NETWORK_ID,
@@ -103,17 +103,17 @@ public class ListNetworksCmd extends BaseListRetrieveOnlyResourceCountCmd implem
private Long associatedNetworkId;
@Parameter(name = ApiConstants.SHOW_RESOURCE_ICON, type = CommandType.BOOLEAN,
- description = "flag to display the resource icon for networks")
+ description = "Flag to display the resource icon for networks")
private Boolean showIcon;
@Parameter(name = ApiConstants.NETWORK_FILTER,
type = CommandType.STRING,
since = "4.17.0",
- description = "possible values are \"account\", \"domain\", \"accountdomain\",\"shared\", and \"all\". Default value is \"all\"."
- + "* account : account networks that have been registered for or created by the calling user. "
- + "* domain : domain networks that have been registered for or created by the calling user. "
- + "* accountdomain : account and domain networks that have been registered for or created by the calling user. "
- + "* shared : networks that have been granted to the calling user by another user. "
+ description = "Possible values are \"account\", \"domain\", \"accountdomain\",\"shared\", and \"all\". Default value is \"all\"."
+ + "* account : account networks that have been registered for or created by the calling User. "
+ + "* domain : domain networks that have been registered for or created by the calling User. "
+ + "* accountdomain : account and domain networks that have been registered for or created by the calling User. "
+ + "* shared : networks that have been granted to the calling User by another User. "
+ "* all : all networks (account, domain and shared).")
private String networkFilter;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/network/MoveNetworkAclItemCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/network/MoveNetworkAclItemCmd.java
index 5d36dcfd8e9..6b525e63c18 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/network/MoveNetworkAclItemCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/network/MoveNetworkAclItemCmd.java
@@ -28,7 +28,7 @@ import com.cloud.event.EventTypes;
import com.cloud.network.vpc.NetworkACLItem;
import com.cloud.user.Account;
-@APICommand(name = "moveNetworkAclItem", description = "Move an ACL rule to a position bettwen two other ACL rules of the same ACL network list", responseObject = NetworkACLItemResponse.class, requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
+@APICommand(name = "moveNetworkAclItem", description = "Move an ACL rule to a position between two other ACL rules of the same ACL Network list", responseObject = NetworkACLItemResponse.class, requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class MoveNetworkAclItemCmd extends BaseAsyncCustomIdCmd {
private static final String s_name = "moveNetworkAclItemResponse";
@@ -42,7 +42,7 @@ public class MoveNetworkAclItemCmd extends BaseAsyncCustomIdCmd {
@Parameter(name = ApiConstants.NEXT_ACL_RULE_ID, type = CommandType.STRING, description = "The ID of the rule that is right after the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the last position of the network ACL list.")
private String nextAclRuleUuid;
- @Parameter(name = ApiConstants.MOVE_ACL_CONSISTENCY_HASH, type = CommandType.STRING, description = "Md5 hash used to check the consistency of the ACL rule list before applying the ACL rule move. This check is useful to manage concurrency problems that may happen when multiple users are editing the same ACL rule listing. The parameter is not required. Therefore, if the user does not send it, they assume the risk of moving ACL rules without checking the consistency of the access control list before executing the move. We use MD5 hash function on a String that is composed of all UUIDs of the ACL rules in concatenated in their respective order (order defined via 'number' field).")
+ @Parameter(name = ApiConstants.MOVE_ACL_CONSISTENCY_HASH, type = CommandType.STRING, description = "Md5 hash used to check the consistency of the ACL rule list before applying the ACL rule move. This check is useful to manage concurrency problems that may happen when multiple Users are editing the same ACL rule listing. The parameter is not required. Therefore, if the User does not send it, they assume the risk of moving ACL rules without checking the consistency of the access control list before executing the move. We use MD5 hash function on a String that is composed of all UUIDs of the ACL rules in concatenated in their respective order (order defined via 'number' field).")
private String aclConsistencyHash;
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/network/RemoveNetworkPermissionsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/network/RemoveNetworkPermissionsCmd.java
index c199d872e0c..546b460f16c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/network/RemoveNetworkPermissionsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/network/RemoveNetworkPermissionsCmd.java
@@ -34,7 +34,7 @@ import com.cloud.user.Account;
import java.util.List;
-@APICommand(name = "removeNetworkPermissions", description = "Removes network permissions.",
+@APICommand(name = "removeNetworkPermissions", description = "Removes Network permissions.",
responseObject = SuccessResponse.class,
entityType = {Network.class},
requestHasSensitiveInfo = false,
@@ -51,24 +51,24 @@ public class RemoveNetworkPermissionsCmd extends BaseCmd {
@Parameter(name = ApiConstants.ACCOUNTS,
type = CommandType.LIST,
collectionType = CommandType.STRING,
- description = "a comma delimited list of accounts within owner's domain. If specified, \"op\" parameter has to be passed in.")
+ description = "A comma delimited list of Accounts within owner's domain. If specified, \"op\" parameter has to be passed in.")
private List accountNames;
@Parameter(name = ApiConstants.ACCOUNT_IDS,
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = AccountResponse.class,
- description = "a comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.")
+ description = "A comma delimited list of account IDs within owner's domain. If specified, \"op\" parameter has to be passed in.")
private List accountIds;
- @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, required = true, description = "the network ID")
+ @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, required = true, description = "The Network ID")
private Long networkId;
@Parameter(name = ApiConstants.PROJECT_IDS,
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = ProjectResponse.class,
- description = "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.")
+ description = "A comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.")
private List projectIds;
// ///////////////////////////////////////////////////
@@ -105,7 +105,7 @@ public class RemoveNetworkPermissionsCmd extends BaseCmd {
SuccessResponse response = new SuccessResponse(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update network permissions");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update Network permissions");
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/network/ReplaceNetworkACLListCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/network/ReplaceNetworkACLListCmd.java
index f6e9557aadb..faddd340f83 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/network/ReplaceNetworkACLListCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/network/ReplaceNetworkACLListCmd.java
@@ -41,13 +41,13 @@ public class ReplaceNetworkACLListCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ACL_ID, type = CommandType.UUID, entityType = NetworkACLResponse.class, required = true, description = "the ID of the network ACL")
+ @Parameter(name = ApiConstants.ACL_ID, type = CommandType.UUID, entityType = NetworkACLResponse.class, required = true, description = "The ID of the network ACL")
private long aclId;
- @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "the ID of the network")
+ @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "The ID of the network")
private Long networkId;
- @Parameter(name = ApiConstants.GATEWAY_ID, type = CommandType.UUID, entityType = PrivateGatewayResponse.class, description = "the ID of the private gateway")
+ @Parameter(name = ApiConstants.GATEWAY_ID, type = CommandType.UUID, entityType = PrivateGatewayResponse.class, description = "The ID of the private gateway")
private Long privateGatewayId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/network/ResetNetworkPermissionsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/network/ResetNetworkPermissionsCmd.java
index a23b98c84a8..611e35028be 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/network/ResetNetworkPermissionsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/network/ResetNetworkPermissionsCmd.java
@@ -29,7 +29,7 @@ import org.apache.cloudstack.api.response.SuccessResponse;
import com.cloud.network.Network;
import com.cloud.user.Account;
-@APICommand(name = "resetNetworkPermissions", description = "Resets network permissions.",
+@APICommand(name = "resetNetworkPermissions", description = "Resets Network permissions.",
responseObject = SuccessResponse.class,
entityType = {Network.class},
requestHasSensitiveInfo = false,
@@ -43,7 +43,7 @@ public class ResetNetworkPermissionsCmd extends BaseCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, required = true, description = "the network ID")
+ @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, required = true, description = "The Network ID")
private Long networkId;
// ///////////////////////////////////////////////////
@@ -65,7 +65,7 @@ public class ResetNetworkPermissionsCmd extends BaseCmd {
SuccessResponse response = new SuccessResponse(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update network permissions");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update Network permissions");
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/network/RestartNetworkCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/network/RestartNetworkCmd.java
index ffc2e36dee5..c04a50cb05d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/network/RestartNetworkCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/network/RestartNetworkCmd.java
@@ -37,7 +37,7 @@ import com.cloud.exception.ResourceUnavailableException;
import com.cloud.network.Network;
@APICommand(name = "restartNetwork",
- description = "Restarts the network; includes 1) restarting network elements - virtual routers, DHCP servers 2) reapplying all public IPs 3) reapplying loadBalancing/portForwarding rules",
+ description = "Restarts the Network; includes 1) restarting network elements - virtual routers, DHCP servers 2) reapplying all public IPs 3) reapplying loadBalancing/portForwarding rules",
responseObject = SuccessResponse.class, entityType = {Network.class},
requestHasSensitiveInfo = false,
responseHasSensitiveInfo = false)
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/network/UpdateNetworkACLItemCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/network/UpdateNetworkACLItemCmd.java
index 42cb0697edb..9e7e1b5b854 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/network/UpdateNetworkACLItemCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/network/UpdateNetworkACLItemCmd.java
@@ -41,37 +41,37 @@ public class UpdateNetworkACLItemCmd extends BaseAsyncCustomIdCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = NetworkACLItemResponse.class, required = true, description = "the ID of the network ACL item")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = NetworkACLItemResponse.class, required = true, description = "The ID of the network ACL item")
private Long id;
- @Parameter(name = ApiConstants.PROTOCOL, type = CommandType.STRING, description = "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number")
+ @Parameter(name = ApiConstants.PROTOCOL, type = CommandType.STRING, description = "The protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number")
private String protocol;
- @Parameter(name = ApiConstants.START_PORT, type = CommandType.INTEGER, description = "the starting port of ACL")
+ @Parameter(name = ApiConstants.START_PORT, type = CommandType.INTEGER, description = "The starting port of ACL")
private Integer publicStartPort;
- @Parameter(name = ApiConstants.END_PORT, type = CommandType.INTEGER, description = "the ending port of ACL")
+ @Parameter(name = ApiConstants.END_PORT, type = CommandType.INTEGER, description = "The ending port of ACL")
private Integer publicEndPort;
- @Parameter(name = ApiConstants.CIDR_LIST, type = CommandType.LIST, collectionType = CommandType.STRING, description = "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).")
+ @Parameter(name = ApiConstants.CIDR_LIST, type = CommandType.LIST, collectionType = CommandType.STRING, description = "The CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).")
private List cidrlist;
- @Parameter(name = ApiConstants.ICMP_TYPE, type = CommandType.INTEGER, description = "type of the ICMP message being sent")
+ @Parameter(name = ApiConstants.ICMP_TYPE, type = CommandType.INTEGER, description = "Type of the ICMP message being sent")
private Integer icmpType;
- @Parameter(name = ApiConstants.ICMP_CODE, type = CommandType.INTEGER, description = "error code for this ICMP message")
+ @Parameter(name = ApiConstants.ICMP_CODE, type = CommandType.INTEGER, description = "Error code for this ICMP message")
private Integer icmpCode;
- @Parameter(name = ApiConstants.TRAFFIC_TYPE, type = CommandType.STRING, description = "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified")
+ @Parameter(name = ApiConstants.TRAFFIC_TYPE, type = CommandType.STRING, description = "The traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified")
private String trafficType;
- @Parameter(name = ApiConstants.NUMBER, type = CommandType.INTEGER, description = "The network of the vm the ACL will be created for")
+ @Parameter(name = ApiConstants.NUMBER, type = CommandType.INTEGER, description = "The Network of the Instance the ACL will be created for")
private Integer number;
- @Parameter(name = ApiConstants.ACTION, type = CommandType.STRING, description = "scl entry action, allow or deny")
+ @Parameter(name = ApiConstants.ACTION, type = CommandType.STRING, description = "ACL entry action, allow or deny")
private String action;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the rule to the end user or not", since = "4.4", authorized = {
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the rule to the end User or not", since = "4.4", authorized = {
RoleType.Admin})
private Boolean display;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/network/UpdateNetworkACLListCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/network/UpdateNetworkACLListCmd.java
index adab885542d..fa29ed44b70 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/network/UpdateNetworkACLListCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/network/UpdateNetworkACLListCmd.java
@@ -31,17 +31,17 @@ import com.cloud.exception.ResourceUnavailableException;
import com.cloud.network.vpc.NetworkACL;
import com.cloud.user.Account;
-@APICommand(name = "updateNetworkACLList", description = "Updates network ACL list", responseObject = SuccessResponse.class, since = "4.4", requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
+@APICommand(name = "updateNetworkACLList", description = "Updates Network ACL list", responseObject = SuccessResponse.class, since = "4.4", requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class UpdateNetworkACLListCmd extends BaseAsyncCustomIdCmd {
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = NetworkACLResponse.class, required = true, description = "the ID of the network ACL")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = NetworkACLResponse.class, required = true, description = "The ID of the network ACL")
private Long id;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the list to the end user or not", since = "4.4", authorized = {
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the list to the end User or not", since = "4.4", authorized = {
RoleType.Admin})
private Boolean display;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/network/UpdateNetworkCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/network/UpdateNetworkCmd.java
index 0d92a635e7f..2e638f1e2f7 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/network/UpdateNetworkCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/network/UpdateNetworkCmd.java
@@ -39,7 +39,7 @@ import com.cloud.exception.InvalidParameterValueException;
import com.cloud.network.Network;
import com.cloud.offering.NetworkOffering;
-@APICommand(name = "updateNetwork", description = "Updates a network", responseObject = NetworkResponse.class, responseView = ResponseView.Restricted, entityType = {Network.class},
+@APICommand(name = "updateNetwork", description = "Updates a Network", responseObject = NetworkResponse.class, responseView = ResponseView.Restricted, entityType = {Network.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class UpdateNetworkCmd extends BaseAsyncCustomIdCmd implements UserCmd {
@@ -50,33 +50,33 @@ public class UpdateNetworkCmd extends BaseAsyncCustomIdCmd implements UserCmd {
/////////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
@Parameter(name=ApiConstants.ID, type=CommandType.UUID, entityType = NetworkResponse.class,
- required=true, description="the ID of the network")
+ required=true, description = "The ID of the network")
protected Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the new name for the network")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The new name for the network")
private String name;
- @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "the new display text for the network")
+ @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "The new display text for the network")
private String displayText;
- @Parameter(name = ApiConstants.NETWORK_DOMAIN, type = CommandType.STRING, description = "network domain")
+ @Parameter(name = ApiConstants.NETWORK_DOMAIN, type = CommandType.STRING, description = "Network domain")
private String networkDomain;
@Parameter(name = ApiConstants.CHANGE_CIDR, type = CommandType.BOOLEAN, description = "Force update even if CIDR type is different")
private Boolean changeCidr;
- @Parameter(name = ApiConstants.NETWORK_OFFERING_ID, type = CommandType.UUID, entityType = NetworkOfferingResponse.class, description = "network offering ID")
+ @Parameter(name = ApiConstants.NETWORK_OFFERING_ID, type = CommandType.UUID, entityType = NetworkOfferingResponse.class, description = "Network offering ID")
private Long networkOfferingId;
@Parameter(name = ApiConstants.GUEST_VM_CIDR, type = CommandType.STRING, description = "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR")
private String guestVmCidr;
- @Parameter(name =ApiConstants.UPDATE_IN_SEQUENCE, type=CommandType.BOOLEAN, description = "if true, we will update the routers one after the other. applicable only for redundant router based networks using virtual router as provider")
+ @Parameter(name =ApiConstants.UPDATE_IN_SEQUENCE, type=CommandType.BOOLEAN, description = "If true, we will update the routers one after the other. applicable only for redundant router based networks using virtual router as provider")
private Boolean updateInSequence;
@Parameter(name = ApiConstants.DISPLAY_NETWORK,
type = CommandType.BOOLEAN,
- description = "an optional field, whether to the display the network to the end user or not.", authorized = {RoleType.Admin})
+ description = "An optional field, whether to the display the network to the end User or not.", authorized = {RoleType.Admin})
private Boolean displayNetwork;
@Parameter(name= ApiConstants.FORCED, type = CommandType.BOOLEAN, description = "Setting this to true will cause a forced network update,", authorized = {RoleType.Admin})
@@ -90,16 +90,16 @@ public class UpdateNetworkCmd extends BaseAsyncCustomIdCmd implements UserCmd {
description = "MTU to be configured on the network VR's public facing interfaces", since = "4.18.0")
private Integer privateMtu;
- @Parameter(name = ApiConstants.DNS1, type = CommandType.STRING, description = "the first IPv4 DNS for the network. Empty string will update the first IPv4 DNS with the value from the zone", since = "4.18.0")
+ @Parameter(name = ApiConstants.DNS1, type = CommandType.STRING, description = "The first IPv4 DNS for the network. Empty string will update the first IPv4 DNS with the value from the zone", since = "4.18.0")
private String ip4Dns1;
- @Parameter(name = ApiConstants.DNS2, type = CommandType.STRING, description = "the second IPv4 DNS for the network. Empty string will update the second IPv4 DNS with the value from the zone", since = "4.18.0")
+ @Parameter(name = ApiConstants.DNS2, type = CommandType.STRING, description = "The second IPv4 DNS for the network. Empty string will update the second IPv4 DNS with the value from the zone", since = "4.18.0")
private String ip4Dns2;
- @Parameter(name = ApiConstants.IP6_DNS1, type = CommandType.STRING, description = "the first IPv6 DNS for the network. Empty string will update the first IPv6 DNS with the value from the zone", since = "4.18.0")
+ @Parameter(name = ApiConstants.IP6_DNS1, type = CommandType.STRING, description = "The first IPv6 DNS for the network. Empty string will update the first IPv6 DNS with the value from the zone", since = "4.18.0")
private String ip6Dns1;
- @Parameter(name = ApiConstants.IP6_DNS2, type = CommandType.STRING, description = "the second IPv6 DNS for the network. Empty string will update the second IPv6 DNS with the value from the zone", since = "4.18.0")
+ @Parameter(name = ApiConstants.IP6_DNS2, type = CommandType.STRING, description = "The second IPv6 DNS for the network. Empty string will update the second IPv6 DNS with the value from the zone", since = "4.18.0")
private String ip6Dns2;
@Parameter(name = ApiConstants.SOURCE_NAT_IP, type = CommandType.STRING, description = "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this network", since = "4.19")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/offering/ListDiskOfferingsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/offering/ListDiskOfferingsCmd.java
index f9b9ec59a40..c7343b95dd6 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/offering/ListDiskOfferingsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/offering/ListDiskOfferingsCmd.java
@@ -45,13 +45,13 @@ public class ListDiskOfferingsCmd extends BaseListProjectAndAccountResourcesCmd
@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = DiskOfferingResponse.class, description = "ID of the disk offering")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "name of the disk offering")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "Name of the disk offering")
private String diskOfferingName;
@Parameter(name = ApiConstants.ZONE_ID,
type = CommandType.UUID,
entityType = ZoneResponse.class,
- description = "id of zone disk offering is associated with",
+ description = "ID of zone disk offering is associated with",
since = "4.13")
private Long zoneId;
@@ -61,7 +61,7 @@ public class ListDiskOfferingsCmd extends BaseListProjectAndAccountResourcesCmd
@Parameter(name = ApiConstants.STORAGE_ID, type = CommandType.UUID, entityType = StoragePoolResponse.class, description = "The ID of the storage pool, tags of the storage pool are used to filter the offerings", since = "4.17")
private Long storagePoolId;
- @Parameter(name = ApiConstants.ENCRYPT, type = CommandType.BOOLEAN, description = "listed offerings support disk encryption", since = "4.18")
+ @Parameter(name = ApiConstants.ENCRYPT, type = CommandType.BOOLEAN, description = "Listed offerings support disk encryption", since = "4.18")
private Boolean encrypt;
@Parameter(name = ApiConstants.STORAGE_TYPE,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/offering/ListServiceOfferingsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/offering/ListServiceOfferingsCmd.java
index 1b3f531e370..ba868dfaf5e 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/offering/ListServiceOfferingsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/offering/ListServiceOfferingsCmd.java
@@ -44,51 +44,51 @@ public class ListServiceOfferingsCmd extends BaseListProjectAndAccountResourcesC
@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ServiceOfferingResponse.class, description = "ID of the service offering")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "name of the service offering")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "Name of the service offering")
private String serviceOfferingName;
@Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID,
type = CommandType.UUID,
entityType = UserVmResponse.class,
- description = "the ID of the virtual machine. Pass this in if you want to see the available service offering that a virtual machine can be changed to.")
+ description = "The ID of the Instance. Pass this in if you want to see the available service offering that an Instance can be changed to.")
private Long virtualMachineId;
- @Parameter(name=ApiConstants.IS_SYSTEM_OFFERING, type=CommandType.BOOLEAN, description="is this a system vm offering")
+ @Parameter(name=ApiConstants.IS_SYSTEM_OFFERING, type=CommandType.BOOLEAN, description = " Is this a System VM offering")
private Boolean isSystem;
@Parameter(name = ApiConstants.SYSTEM_VM_TYPE,
type = CommandType.STRING,
- description = "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".")
+ description = "The system Instance type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".")
private String systemVmType;
@Parameter(name = ApiConstants.ZONE_ID,
type = CommandType.UUID,
entityType = ZoneResponse.class,
- description = "id of zone disk offering is associated with",
+ description = "ID of zone disk offering is associated with",
since = "4.13")
private Long zoneId;
@Parameter(name = ApiConstants.CPU_NUMBER,
type = CommandType.INTEGER,
- description = "the CPU number that listed offerings must support",
+ description = "The CPU number that listed offerings must support",
since = "4.15")
private Integer cpuNumber;
@Parameter(name = ApiConstants.MEMORY,
type = CommandType.INTEGER,
- description = "the RAM memory that listed offering must support",
+ description = "The RAM memory that listed offering must support",
since = "4.15")
private Integer memory;
@Parameter(name = ApiConstants.CPU_SPEED,
type = CommandType.INTEGER,
- description = "the CPU speed that listed offerings must support",
+ description = "The CPU speed that listed offerings must support",
since = "4.15")
private Integer cpuSpeed;
@Parameter(name = ApiConstants.ENCRYPT_ROOT,
type = CommandType.BOOLEAN,
- description = "listed offerings support root disk encryption",
+ description = "Listed offerings support root disk encryption",
since = "4.18")
private Boolean encryptRoot;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/project/ActivateProjectCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/project/ActivateProjectCmd.java
index 42e045d4389..228afb5a186 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/project/ActivateProjectCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/project/ActivateProjectCmd.java
@@ -42,7 +42,7 @@ public class ActivateProjectCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ProjectResponse.class, required = true, description = "id of the project to be modified")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ProjectResponse.class, required = true, description = "ID of the project to be modified")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/project/CreateProjectCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/project/CreateProjectCmd.java
index cb93729381a..2d0e92d47d4 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/project/CreateProjectCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/project/CreateProjectCmd.java
@@ -44,20 +44,20 @@ public class CreateProjectCmd extends BaseAsyncCreateCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "account who will be Admin for the project")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "Account who will be Admin for the project")
private String accountName;
@Parameter(name = ApiConstants.USER_ID, type = CommandType.UUID, entityType = UserResponse.class,
- description = "user ID of the account to be assigned as owner of the project i.e., Project Admin", since = "4.15.0")
+ description = "User ID of the Account to be assigned as owner of the project i.e., Project Admin", since = "4.15.0")
private Long userId;
- @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "domain ID of the account owning a project")
+ @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "Domain ID of the Account owning a project")
private Long domainId;
- @Parameter(name = ApiConstants.ACCOUNT_ID, type = CommandType.UUID, entityType = AccountResponse.class, description = "ID of the account owning a project")
+ @Parameter(name = ApiConstants.ACCOUNT_ID, type = CommandType.UUID, entityType = AccountResponse.class, description = "ID of the Account owning a project")
private Long accountId;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "name of the project")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "Name of the project")
private String name;
@Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "The display text of the project, defaults to the 'name´.")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/project/DeleteProjectCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/project/DeleteProjectCmd.java
index 1fd205fdae4..d4e2b8f56f9 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/project/DeleteProjectCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/project/DeleteProjectCmd.java
@@ -42,10 +42,10 @@ public class DeleteProjectCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ProjectResponse.class, required = true, description = "id of the project to be deleted")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ProjectResponse.class, required = true, description = "ID of the project to be deleted")
private Long id;
- @Parameter(name = ApiConstants.CLEANUP, type = CommandType.BOOLEAN, since = "4.16.0", description = "true if all project resources have to be cleaned up, false otherwise")
+ @Parameter(name = ApiConstants.CLEANUP, type = CommandType.BOOLEAN, since = "4.16.0", description = "True if all project resources have to be cleaned up, false otherwise")
private Boolean cleanup;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/project/DeleteProjectInvitationCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/project/DeleteProjectInvitationCmd.java
index d1b17eda76b..7fe2c3c4abc 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/project/DeleteProjectInvitationCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/project/DeleteProjectInvitationCmd.java
@@ -37,7 +37,7 @@ public class DeleteProjectInvitationCmd extends BaseAsyncCmd {
// ///////////////////////////////////////////////////
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ProjectInvitationResponse.class, required = true, description = "id of the invitation")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ProjectInvitationResponse.class, required = true, description = "ID of the invitation")
private Long id;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/project/ListProjectInvitationsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/project/ListProjectInvitationsCmd.java
index 210394ec2dd..679ba863b10 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/project/ListProjectInvitationsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/project/ListProjectInvitationsCmd.java
@@ -37,21 +37,21 @@ public class ListProjectInvitationsCmd extends BaseListAccountResourcesCmd {
// ///////////////////////////////////////////////////
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "list by project id")
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "List by project ID")
private Long projectId;
@Parameter(name = ApiConstants.ACTIVE_ONLY,
type = CommandType.BOOLEAN,
- description = "if true, list only active invitations - having Pending state and ones that are not timed out yet")
+ description = "If true, list only active invitations - having Pending state and ones that are not timed out yet")
private boolean activeOnly;
- @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "list invitations by state")
+ @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "List invitations by state")
private String state;
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ProjectInvitationResponse.class, description = "list invitations by id")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ProjectInvitationResponse.class, description = "List invitations by ID")
private Long id;
- @Parameter(name = ApiConstants.USER_ID, type = CommandType.UUID, entityType = UserResponse.class, description = "list invitation by user ID")
+ @Parameter(name = ApiConstants.USER_ID, type = CommandType.UUID, entityType = UserResponse.class, description = "List invitation by user ID")
private Long userId;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/project/ListProjectsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/project/ListProjectsCmd.java
index d4679dbe057..2f65429aca6 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/project/ListProjectsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/project/ListProjectsCmd.java
@@ -48,16 +48,16 @@ public class ListProjectsCmd extends BaseListAccountResourcesCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "list projects by project ID")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "List projects by project ID")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "list projects by name")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "List projects by name")
private String name;
- @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "list projects by display text")
+ @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "List projects by display text")
private String displayText;
- @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "list projects by state")
+ @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "List projects by state")
private String state;
@Parameter(name = ApiConstants.TAGS, type = CommandType.MAP, description = "List projects by tags (key/value pairs)")
@@ -69,11 +69,11 @@ public class ListProjectsCmd extends BaseListAccountResourcesCmd {
@Parameter(name = ApiConstants.DETAILS,
type = CommandType.LIST,
collectionType = CommandType.STRING,
- description = "comma separated list of project details requested, value can be a list of [ all, resource, min]")
+ description = "Comma separated list of project details requested, value can be a list of [ all, resource, min]")
private List viewDetails;
@Parameter(name = ApiConstants.SHOW_RESOURCE_ICON, type = CommandType.BOOLEAN,
- description = "flag to display the resource icon for projects")
+ description = "Flag to display the resource icon for projects")
private Boolean showIcon;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/project/SuspendProjectCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/project/SuspendProjectCmd.java
index a3eee8c80bb..7850e7bf694 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/project/SuspendProjectCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/project/SuspendProjectCmd.java
@@ -43,7 +43,7 @@ public class SuspendProjectCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ProjectResponse.class, required = true, description = "id of the project to be suspended")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ProjectResponse.class, required = true, description = "ID of the project to be suspended")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/project/UpdateProjectCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/project/UpdateProjectCmd.java
index 4fabf7da788..e38f9417e8a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/project/UpdateProjectCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/project/UpdateProjectCmd.java
@@ -45,27 +45,27 @@ public class UpdateProjectCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ProjectResponse.class, required = true, description = "id of the project to be modified")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ProjectResponse.class, required = true, description = "ID of the project to be modified")
private Long id;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "new Admin account for the project")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "New Admin Account for the project")
private String accountName;
- @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "display text of the project")
+ @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "Display text of the project")
private String displayText;
- @Parameter(name = ApiConstants.USER_ID, type = CommandType.UUID, entityType = UserResponse.class, description = "ID of the user to be promoted/demoted")
+ @Parameter(name = ApiConstants.USER_ID, type = CommandType.UUID, entityType = UserResponse.class, description = "ID of the User to be promoted/demoted")
private Long userId;
- @Parameter(name = ApiConstants.ROLE_TYPE, type = CommandType.STRING, description = "Account level role to be assigned to the user/account : Admin/Regular")
+ @Parameter(name = ApiConstants.ROLE_TYPE, type = CommandType.STRING, description = "Account level role to be assigned to the User/Account : Admin/Regular")
private String roleType;
- @Parameter(name = ApiConstants.SWAP_OWNER, type = CommandType.BOOLEAN, description = "when true, it swaps ownership with the account/ user provided. " +
+ @Parameter(name = ApiConstants.SWAP_OWNER, type = CommandType.BOOLEAN, description = "When true, it swaps ownership with the Account/User provided. " +
"Ideally to be used when a single project administrator is present. In case of multiple project admins, swapowner is to be set to false," +
"to promote or demote the user/account based on the roleType (Regular or Admin) provided. Defaults to true")
private Boolean swapOwner;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "name of the project", since = "4.19.0")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "Name of the project", since = "4.19.0")
private String name;
/////////////////////////////////////////////////////
@@ -135,8 +135,8 @@ public class UpdateProjectCmd extends BaseAsyncCmd {
public void execute() throws ResourceAllocationException {
CallContext.current().setEventDetails("Project id: " + getId());
if (getAccountName() != null && getUserId() != null) {
- throw new InvalidParameterValueException("Account name and user ID are mutually exclusive. Provide either account name" +
- "to update account or user ID to update the user of the project");
+ throw new InvalidParameterValueException("Account name and User ID are mutually exclusive. Provide either Account name" +
+ "to update Account or user ID to update the user of the project");
}
Project project = null;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/project/UpdateProjectInvitationCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/project/UpdateProjectInvitationCmd.java
index 0cbd9f702c2..a8a6fb802fb 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/project/UpdateProjectInvitationCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/project/UpdateProjectInvitationCmd.java
@@ -38,10 +38,10 @@ public class UpdateProjectInvitationCmd extends BaseAsyncCmd {
// ///////////////////////////////////////////////////
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, required = true, description = "id of the project to join")
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, required = true, description = "ID of the project to join")
private Long projectId;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "account that is joining the project")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "Account that is joining the project")
private String accountName;
@Parameter(name = ApiConstants.USER_ID, type = BaseCmd.CommandType.UUID, entityType = UserResponse.class,
@@ -50,10 +50,10 @@ public class UpdateProjectInvitationCmd extends BaseAsyncCmd {
@Parameter(name = ApiConstants.TOKEN,
type = CommandType.STRING,
- description = "list invitations for specified account; this parameter has to be specified with domainId")
+ description = "List invitations for specified account; this parameter has to be specified with domainId")
private String token;
- @Parameter(name = ApiConstants.ACCEPT, type = CommandType.BOOLEAN, description = "if true, accept the invitation, decline if false. True by default")
+ @Parameter(name = ApiConstants.ACCEPT, type = CommandType.BOOLEAN, description = "If true, accept the invitation, decline if false. True by default")
private Boolean accept;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/region/ha/gslb/AssignToGlobalLoadBalancerRuleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/region/ha/gslb/AssignToGlobalLoadBalancerRuleCmd.java
index 649b2a7bd9b..1cda9ab2757 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/region/ha/gslb/AssignToGlobalLoadBalancerRuleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/region/ha/gslb/AssignToGlobalLoadBalancerRuleCmd.java
@@ -62,7 +62,7 @@ public class AssignToGlobalLoadBalancerRuleCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = GlobalLoadBalancerResponse.class,
required = true,
- description = "the ID of the global load balancer rule")
+ description = "The ID of the global load balancer rule")
private Long id;
@Parameter(name = ApiConstants.LOAD_BALANCER_RULE_LIST,
@@ -70,7 +70,7 @@ public class AssignToGlobalLoadBalancerRuleCmd extends BaseAsyncCmd {
collectionType = CommandType.UUID,
entityType = FirewallRuleResponse.class,
required = true,
- description = "the list load balancer rules that will be assigned to global load balancer rule")
+ description = "The list load balancer rules that will be assigned to global load balancer rule")
private List loadBalancerRulesIds;
@Parameter(name = ApiConstants.GSLB_LBRULE_WEIGHT_MAP,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/region/ha/gslb/CreateGlobalLoadBalancerRuleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/region/ha/gslb/CreateGlobalLoadBalancerRuleCmd.java
index ddaadde7852..df9b6b31865 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/region/ha/gslb/CreateGlobalLoadBalancerRuleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/region/ha/gslb/CreateGlobalLoadBalancerRuleCmd.java
@@ -47,41 +47,41 @@ public class CreateGlobalLoadBalancerRuleCmd extends BaseAsyncCreateCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "name of the load balancer rule")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "Name of the load balancer rule")
private String globalLoadBalancerRuleName;
- @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "the description of the load balancer rule", length = 4096)
+ @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "The description of the load balancer rule", length = 4096)
private String description;
@Parameter(name = ApiConstants.REGION_ID,
type = CommandType.INTEGER,
entityType = RegionResponse.class,
required = true,
- description = "region where the global load balancer is going to be created.")
+ description = "Region where the global load balancer is going to be created.")
private Integer regionId;
@Parameter(name = ApiConstants.ACCOUNT,
type = CommandType.STRING,
- description = "the account associated with the global load balancer. Must be used with the domainId parameter.")
+ description = "The Account associated with the global load balancer. Must be used with the domainId parameter.")
private String accountName;
- @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "the domain ID associated with the load balancer")
+ @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "The domain ID associated with the load balancer")
private Long domainId;
@Parameter(name = ApiConstants.GSLB_LB_METHOD,
type = CommandType.STRING,
required = false,
- description = "load balancer algorithm (roundrobin, leastconn, proximity) "
+ description = "Load balancer algorithm (roundrobin, leastconn, proximity) "
+ "that method is used to distribute traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'")
private String algorithm;
@Parameter(name = ApiConstants.GSLB_STICKY_SESSION_METHOD,
type = CommandType.STRING,
required = false,
- description = "session sticky method (sourceip) if not specified defaults to sourceip")
+ description = "Session sticky method (sourceip) if not specified defaults to sourceip")
private String stickyMethod;
- @Parameter(name = ApiConstants.GSLB_SERVICE_DOMAIN_NAME, type = CommandType.STRING, required = true, description = "domain name for the GSLB service.")
+ @Parameter(name = ApiConstants.GSLB_SERVICE_DOMAIN_NAME, type = CommandType.STRING, required = true, description = "Domain name for the GSLB service.")
private String serviceDomainName;
@Parameter(name = ApiConstants.GSLB_SERVICE_TYPE, type = CommandType.STRING, required = true, description = "GSLB service type (tcp, udp, http)")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/region/ha/gslb/DeleteGlobalLoadBalancerRuleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/region/ha/gslb/DeleteGlobalLoadBalancerRuleCmd.java
index 7f3308614cc..6053a11cf71 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/region/ha/gslb/DeleteGlobalLoadBalancerRuleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/region/ha/gslb/DeleteGlobalLoadBalancerRuleCmd.java
@@ -50,7 +50,7 @@ public class DeleteGlobalLoadBalancerRuleCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = GlobalLoadBalancerResponse.class,
required = true,
- description = "the ID of the global load balancer rule")
+ description = "The ID of the global load balancer rule")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/region/ha/gslb/ListGlobalLoadBalancerRuleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/region/ha/gslb/ListGlobalLoadBalancerRuleCmd.java
index bf0cf22a2ec..a4bd027fc97 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/region/ha/gslb/ListGlobalLoadBalancerRuleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/region/ha/gslb/ListGlobalLoadBalancerRuleCmd.java
@@ -43,10 +43,10 @@ public class ListGlobalLoadBalancerRuleCmd extends BaseListTaggedResourcesCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = GlobalLoadBalancerResponse.class, description = "the ID of the global load balancer rule")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = GlobalLoadBalancerResponse.class, description = "The ID of the global load balancer rule")
private Long id;
- @Parameter(name = ApiConstants.REGION_ID, type = CommandType.INTEGER, entityType = RegionResponse.class, description = "region ID")
+ @Parameter(name = ApiConstants.REGION_ID, type = CommandType.INTEGER, entityType = RegionResponse.class, description = "Region ID")
private Integer regionId;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/region/ha/gslb/RemoveFromGlobalLoadBalancerRuleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/region/ha/gslb/RemoveFromGlobalLoadBalancerRuleCmd.java
index d4b02139892..eb72cad86f2 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/region/ha/gslb/RemoveFromGlobalLoadBalancerRuleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/region/ha/gslb/RemoveFromGlobalLoadBalancerRuleCmd.java
@@ -65,7 +65,7 @@ public class RemoveFromGlobalLoadBalancerRuleCmd extends BaseAsyncCmd {
collectionType = CommandType.UUID,
entityType = FirewallRuleResponse.class,
required = true,
- description = "the list load balancer rules that will be assigned to global load balancer rule")
+ description = "The list load balancer rules that will be assigned to global load balancer rule")
private List loadBalancerRulesIds;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/region/ha/gslb/UpdateGlobalLoadBalancerRuleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/region/ha/gslb/UpdateGlobalLoadBalancerRuleCmd.java
index 7996998e5d9..7ccf62a293a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/region/ha/gslb/UpdateGlobalLoadBalancerRuleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/region/ha/gslb/UpdateGlobalLoadBalancerRuleCmd.java
@@ -33,7 +33,7 @@ import com.cloud.region.ha.GlobalLoadBalancerRule;
import com.cloud.region.ha.GlobalLoadBalancingRulesService;
import com.cloud.user.Account;
-@APICommand(name = "updateGlobalLoadBalancerRule", description = "update global load balancer rules.", responseObject = GlobalLoadBalancerResponse.class,
+@APICommand(name = "updateGlobalLoadBalancerRule", description = "Update global load balancer rules.", responseObject = GlobalLoadBalancerResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class UpdateGlobalLoadBalancerRuleCmd extends BaseAsyncCmd {
@@ -46,23 +46,23 @@ public class UpdateGlobalLoadBalancerRuleCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = GlobalLoadBalancerResponse.class,
required = true,
- description = "the ID of the global load balancer rule")
+ description = "The ID of the global load balancer rule")
private Long id;
- @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "the description of the load balancer rule", length = 4096)
+ @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "The description of the load balancer rule", length = 4096)
private String description;
@Parameter(name = ApiConstants.GSLB_LB_METHOD,
type = CommandType.STRING,
required = false,
- description = "load balancer algorithm (roundrobin, leastconn, proximity) "
+ description = "Load balancer algorithm (roundrobin, leastconn, proximity) "
+ "that is used to distributed traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'")
private String algorithm;
@Parameter(name = ApiConstants.GSLB_STICKY_SESSION_METHOD,
type = CommandType.STRING,
required = false,
- description = "session sticky method (sourceip) if not specified defaults to sourceip")
+ description = "Session sticky method (sourceip) if not specified defaults to sourceip")
private String stickyMethod;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/resource/GetCloudIdentifierCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/resource/GetCloudIdentifierCmd.java
index b9e43336217..04b0ccc4cb0 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/resource/GetCloudIdentifierCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/resource/GetCloudIdentifierCmd.java
@@ -42,7 +42,7 @@ public class GetCloudIdentifierCmd extends BaseCmd {
type = CommandType.UUID,
entityType = UserResponse.class,
required = true,
- description = "the user ID for the cloud identifier")
+ description = "The user ID for the cloud identifier")
private Long userid;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/resource/ListDetailOptionsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/resource/ListDetailOptionsCmd.java
index 240852a74c5..273f931fa23 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/resource/ListDetailOptionsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/resource/ListDetailOptionsCmd.java
@@ -28,7 +28,7 @@ import com.cloud.server.ResourceTag;
import org.apache.commons.lang3.StringUtils;
@APICommand(name = "listDetailOptions",
- description = "Lists all possible details and their options for a resource type such as a VM or a template",
+ description = "Lists all possible details and their options for a resource type such as an Instance or a Template",
responseObject = DetailOptionsResponse.class,
since = "4.13",
requestHasSensitiveInfo = false,
@@ -41,11 +41,11 @@ public class ListDetailOptionsCmd extends BaseCmd {
/////////////////////////////////////////////////////
@Parameter(name = ApiConstants.RESOURCE_TYPE, type = CommandType.STRING, required = true,
- description = "the resource type such as UserVm, Template etc.")
+ description = "The resource type such as UserVm, Template etc.")
private String resourceType;
@Parameter(name = ApiConstants.RESOURCE_ID, type = CommandType.STRING,
- description = "the UUID of the resource (optional)")
+ description = "The UUID of the resource (optional)")
private String resourceId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/resource/ListHypervisorsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/resource/ListHypervisorsCmd.java
index 556f3b081f0..70d339abd6f 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/resource/ListHypervisorsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/resource/ListHypervisorsCmd.java
@@ -38,7 +38,7 @@ public class ListHypervisorsCmd extends BaseCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "the zone id for listing hypervisors.")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "The zone id for listing hypervisors.")
private Long zoneId;
// ///////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/resource/ListResourceLimitsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/resource/ListResourceLimitsCmd.java
index 71b886ed12b..7bae74c73a4 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/resource/ListResourceLimitsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/resource/ListResourceLimitsCmd.java
@@ -43,11 +43,11 @@ public class ListResourceLimitsCmd extends BaseListProjectAndAccountResourcesCmd
private Long id;
@Parameter(name = ApiConstants.RESOURCE_TYPE, type = CommandType.INTEGER, description = "Type of resource. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. "
- + "0 - Instance. Number of instances a user can create. "
+ + "0 - Instance. Number of Instances a user can create. "
+ "1 - IP. Number of public IP addresses an account can own. "
+ "2 - Volume. Number of disk volumes an account can own. "
- + "3 - Snapshot. Number of snapshots an account can own. "
- + "4 - Template. Number of templates an account can register/create. "
+ + "3 - Snapshot. Number of Snapshots an account can own. "
+ + "4 - Template. Number of Templates an account can register/create. "
+ "5 - Project. Number of projects an account can own. "
+ "6 - Network. Number of networks an account can own. "
+ "7 - VPC. Number of VPC an account can own. "
@@ -58,11 +58,11 @@ public class ListResourceLimitsCmd extends BaseListProjectAndAccountResourcesCmd
private Integer resourceType;
@Parameter(name = ApiConstants.RESOURCE_TYPE_NAME, type = CommandType.STRING, description = "Type of resource (wins over resourceType if both are provided). Values are: "
- + "user_vm - Instance. Number of instances a user can create. "
+ + "user_vm - Instance. Number of Instances a user can create. "
+ "public_ip - IP. Number of public IP addresses an account can own. "
+ "volume - Volume. Number of disk volumes an account can own. "
- + "snapshot - Snapshot. Number of snapshots an account can own. "
- + "template - Template. Number of templates an account can register/create. "
+ + "snapshot - Snapshot. Number of Snapshots an account can own. "
+ + "template - Template. Number of Templates an account can register/create. "
+ "project - Project. Number of projects an account can own. "
+ "network - Network. Number of networks an account can own. "
+ "vpc - VPC. Number of VPC an account can own. "
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/resource/UpdateResourceCountCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/resource/UpdateResourceCountCmd.java
index 49c6ee605c8..123b0e48a74 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/resource/UpdateResourceCountCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/resource/UpdateResourceCountCmd.java
@@ -61,11 +61,11 @@ public class UpdateResourceCountCmd extends BaseCmd {
@Parameter(name = ApiConstants.RESOURCE_TYPE,
type = CommandType.INTEGER,
description = "Type of resource to update. If specifies valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 and 11. If not specified will update all resource counts"
- + "0 - Instance. Number of instances a user can create. "
+ + "0 - Instance. Number of Instances a user can create. "
+ "1 - IP. Number of public IP addresses a user can own. "
+ "2 - Volume. Number of disk volumes a user can create. "
- + "3 - Snapshot. Number of snapshots a user can create. "
- + "4 - Template. Number of templates that a user can register/create. "
+ + "3 - Snapshot. Number of Snapshots a user can create. "
+ + "4 - Template. Number of Templates that a user can register/create. "
+ "5 - Project. Number of projects that a user can create. "
+ "6 - Network. Number of guest network a user can create. "
+ "7 - VPC. Number of VPC a user can create. "
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/resource/UpdateResourceLimitCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/resource/UpdateResourceLimitCmd.java
index 3538a389a6e..3678e885a6e 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/resource/UpdateResourceLimitCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/resource/UpdateResourceLimitCmd.java
@@ -57,13 +57,13 @@ public class UpdateResourceLimitCmd extends BaseCmd {
type = CommandType.INTEGER,
required = true,
description = "Type of resource to update. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. "
- + "0 - Instance. Number of instances a user can create. "
+ + "0 - Instance. Number of Instances a user can create. "
+ "1 - IP. Number of public IP addresses a user can own. "
+ "2 - Volume. Number of disk volumes a user can create. "
- + "3 - Snapshot. Number of snapshots a user can create. "
- + "4 - Template. Number of templates that a user can register/create. "
- + "5 - Project. Number of projects a user can create. "
- + "6 - Network. Number of guest network a user can create. "
+ + "3 - Snapshot. Number of Snapshots a user can create. "
+ + "4 - Template. Number of Templates that a user can register/create. "
+ + "5 - Project. Number of Projects a user can create. "
+ + "6 - Network. Number of guest Network a user can create. "
+ "7 - VPC. Number of VPC a user can create. "
+ "8 - CPU. Total number of CPU cores a user can use. "
+ "9 - Memory. Total Memory (in MB) a user can use. "
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/securitygroup/AuthorizeSecurityGroupEgressCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/securitygroup/AuthorizeSecurityGroupEgressCmd.java
index 13faafe348c..13b09c7e19a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/securitygroup/AuthorizeSecurityGroupEgressCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/securitygroup/AuthorizeSecurityGroupEgressCmd.java
@@ -58,43 +58,43 @@ public class AuthorizeSecurityGroupEgressCmd extends BaseAsyncCmd {
@Parameter(name = ApiConstants.PROTOCOL, type = CommandType.STRING, description = "TCP is default. UDP is the other supported protocol")
private String protocol;
- @Parameter(name = ApiConstants.START_PORT, type = CommandType.INTEGER, description = "start port for this egress rule")
+ @Parameter(name = ApiConstants.START_PORT, type = CommandType.INTEGER, description = "Start port for this egress rule")
private Integer startPort;
- @Parameter(name = ApiConstants.END_PORT, type = CommandType.INTEGER, description = "end port for this egress rule")
+ @Parameter(name = ApiConstants.END_PORT, type = CommandType.INTEGER, description = "End port for this egress rule")
private Integer endPort;
- @Parameter(name = ApiConstants.ICMP_TYPE, type = CommandType.INTEGER, description = "type of the icmp message being sent")
+ @Parameter(name = ApiConstants.ICMP_TYPE, type = CommandType.INTEGER, description = "Type of the ICMP message being sent")
private Integer icmpType;
- @Parameter(name = ApiConstants.ICMP_CODE, type = CommandType.INTEGER, description = "error code for this icmp message")
+ @Parameter(name = ApiConstants.ICMP_CODE, type = CommandType.INTEGER, description = "Error code for this icmp message")
private Integer icmpCode;
- @Parameter(name = ApiConstants.CIDR_LIST, type = CommandType.LIST, collectionType = CommandType.STRING, description = "the cidr list associated. Multiple entries must be separated by a single comma character (,).")
+ @Parameter(name = ApiConstants.CIDR_LIST, type = CommandType.LIST, collectionType = CommandType.STRING, description = "The CIDR list associated. Multiple entries must be separated by a single comma character (,).")
private List cidrList;
- @Parameter(name = ApiConstants.USER_SECURITY_GROUP_LIST, type = CommandType.MAP, description = "user to security group mapping")
+ @Parameter(name = ApiConstants.USER_SECURITY_GROUP_LIST, type = CommandType.MAP, description = "User to security group mapping")
private Map userSecurityGroupList;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
- description = "an optional domainId for the security group. If the account parameter is used, domainId must also be used.",
+ description = "An optional domainId for the security group. If the account parameter is used, domainId must also be used.",
entityType = DomainResponse.class)
private Long domainId;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "an optional account for the security group. Must be used with domainId.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "An optional account for the security group. Must be used with domainId.")
private String accountName;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, description = "an optional project of the security group", entityType = ProjectResponse.class)
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, description = "An optional project of the security group", entityType = ProjectResponse.class)
private Long projectId;
@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name=ApiConstants.SECURITY_GROUP_ID, type=CommandType.UUID, description="The ID of the security group. Mutually exclusive with securityGroupName parameter", entityType=SecurityGroupResponse.class)
+ @Parameter(name=ApiConstants.SECURITY_GROUP_ID, type=CommandType.UUID, description = "The ID of the security group. Mutually exclusive with securityGroupName parameter", entityType=SecurityGroupResponse.class)
private Long securityGroupId;
// This @ACL will not work, since we don't have a way to convert this parameter to the entity like securityGroupId.
//@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name=ApiConstants.SECURITY_GROUP_NAME, type=CommandType.STRING, description="The name of the security group. Mutually exclusive with securityGroupId parameter")
+ @Parameter(name=ApiConstants.SECURITY_GROUP_NAME, type=CommandType.STRING, description = "The name of the security group. Mutually exclusive with securityGroupId parameter")
private String securityGroupName;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/securitygroup/AuthorizeSecurityGroupIngressCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/securitygroup/AuthorizeSecurityGroupIngressCmd.java
index 640870fc3de..07a4df9eb5d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/securitygroup/AuthorizeSecurityGroupIngressCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/securitygroup/AuthorizeSecurityGroupIngressCmd.java
@@ -55,46 +55,46 @@ public class AuthorizeSecurityGroupIngressCmd extends BaseAsyncCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.PROTOCOL, type = CommandType.STRING, description = "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number (see /etc/protocols). ALL is default.")
+ @Parameter(name = ApiConstants.PROTOCOL, type = CommandType.STRING, description = "The protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number (see /etc/protocols). ALL is default.")
private String protocol;
- @Parameter(name = ApiConstants.START_PORT, type = CommandType.INTEGER, description = "start port for this ingress rule")
+ @Parameter(name = ApiConstants.START_PORT, type = CommandType.INTEGER, description = "Start port for this ingress rule")
private Integer startPort;
- @Parameter(name = ApiConstants.END_PORT, type = CommandType.INTEGER, description = "end port for this ingress rule")
+ @Parameter(name = ApiConstants.END_PORT, type = CommandType.INTEGER, description = "End port for this ingress rule")
private Integer endPort;
- @Parameter(name = ApiConstants.ICMP_TYPE, type = CommandType.INTEGER, description = "type of the icmp message being sent")
+ @Parameter(name = ApiConstants.ICMP_TYPE, type = CommandType.INTEGER, description = "Type of the icmp message being sent")
private Integer icmpType;
- @Parameter(name = ApiConstants.ICMP_CODE, type = CommandType.INTEGER, description = "error code for this icmp message")
+ @Parameter(name = ApiConstants.ICMP_CODE, type = CommandType.INTEGER, description = "Error code for this icmp message")
private Integer icmpCode;
- @Parameter(name = ApiConstants.CIDR_LIST, type = CommandType.LIST, collectionType = CommandType.STRING, description = "the cidr list associated. Multiple entries must be separated by a single comma character (,).")
+ @Parameter(name = ApiConstants.CIDR_LIST, type = CommandType.LIST, collectionType = CommandType.STRING, description = "The cidr list associated. Multiple entries must be separated by a single comma character (,).")
private List cidrList;
- @Parameter(name = ApiConstants.USER_SECURITY_GROUP_LIST, type = CommandType.MAP, description = "user to security group mapping")
+ @Parameter(name = ApiConstants.USER_SECURITY_GROUP_LIST, type = CommandType.MAP, description = "User to security group mapping")
private Map userSecurityGroupList;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
- description = "an optional domainId for the security group. If the account parameter is used, domainId must also be used.",
+ description = "An optional domainId for the security group. If the account parameter is used, domainId must also be used.",
entityType = DomainResponse.class)
private Long domainId;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "an optional account for the security group. Must be used with domainId.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "An optional account for the security group. Must be used with domainId.")
private String accountName;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, description = "an optional project of the security group", entityType = ProjectResponse.class)
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, description = "An optional project of the security group", entityType = ProjectResponse.class)
private Long projectId;
@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name=ApiConstants.SECURITY_GROUP_ID, type=CommandType.UUID, description="The ID of the security group. Mutually exclusive with securityGroupName parameter", entityType=SecurityGroupResponse.class)
+ @Parameter(name=ApiConstants.SECURITY_GROUP_ID, type=CommandType.UUID, description = "The ID of the security group. Mutually exclusive with securityGroupName parameter", entityType=SecurityGroupResponse.class)
private Long securityGroupId;
// This @ACL will not work, since we don't have a way to convert this parameter to the entity like securityGroupId.
//@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name=ApiConstants.SECURITY_GROUP_NAME, type=CommandType.STRING, description="The name of the security group. Mutually exclusive with securityGroupId parameter")
+ @Parameter(name=ApiConstants.SECURITY_GROUP_NAME, type=CommandType.STRING, description = "The name of the security group. Mutually exclusive with securityGroupId parameter")
private String securityGroupName;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/securitygroup/CreateSecurityGroupCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/securitygroup/CreateSecurityGroupCmd.java
index 673eaaef33d..333dc9ff748 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/securitygroup/CreateSecurityGroupCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/securitygroup/CreateSecurityGroupCmd.java
@@ -40,19 +40,19 @@ public class CreateSecurityGroupCmd extends BaseCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "an optional account for the security group. Must be used with domainId.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "An optional account for the security group. Must be used with domainId.")
private String accountName;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
- description = "an optional domainId for the security group. If the account parameter is used, domainId must also be used.",
+ description = "An optional domainId for the security group. If the account parameter is used, domainId must also be used.",
entityType = DomainResponse.class)
private Long domainId;
- @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "the description of the security group")
+ @Parameter(name = ApiConstants.DESCRIPTION, type = CommandType.STRING, description = "The description of the security group")
private String description;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "name of the security group")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "Name of the security group")
private String securityGroupName;
@Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, description = "Create security group for project", entityType = ProjectResponse.class)
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/securitygroup/DeleteSecurityGroupCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/securitygroup/DeleteSecurityGroupCmd.java
index b2ea90792b8..0636f03c92a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/securitygroup/DeleteSecurityGroupCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/securitygroup/DeleteSecurityGroupCmd.java
@@ -43,20 +43,20 @@ public class DeleteSecurityGroupCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "the account of the security group. Must be specified with domain ID")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "The account of the security group. Must be specified with domain ID")
private String accountName;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
- description = "the domain ID of account owning the security group",
+ description = "The domain ID of account owning the security group",
entityType = DomainResponse.class)
private Long domainId;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, description = "the project of the security group", entityType = ProjectResponse.class)
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, description = "The project of the security group", entityType = ProjectResponse.class)
private Long projectId;
@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name=ApiConstants.ID, type=CommandType.UUID, description="The ID of the security group. Mutually exclusive with name parameter", entityType=SecurityGroupResponse.class)
+ @Parameter(name=ApiConstants.ID, type=CommandType.UUID, description = "The ID of the security group. Mutually exclusive with name parameter", entityType=SecurityGroupResponse.class)
private Long id;
@Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The ID of the security group. Mutually exclusive with id parameter")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/securitygroup/ListSecurityGroupsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/securitygroup/ListSecurityGroupsCmd.java
index f93e7b39586..0de3bd5bdb6 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/securitygroup/ListSecurityGroupsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/securitygroup/ListSecurityGroupsCmd.java
@@ -37,16 +37,16 @@ public class ListSecurityGroupsCmd extends BaseListTaggedResourcesCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.SECURITY_GROUP_NAME, type = CommandType.STRING, description = "lists security groups by name")
+ @Parameter(name = ApiConstants.SECURITY_GROUP_NAME, type = CommandType.STRING, description = "Lists security groups by name")
private String securityGroupName;
@Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID,
type = CommandType.UUID,
- description = "lists security groups by virtual machine id",
+ description = "Lists security groups by Instance id",
entityType = UserVmResponse.class)
private Long virtualMachineId;
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, description = "list the security group by the id provided", entityType = SecurityGroupResponse.class)
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, description = "List the security group by the id provided", entityType = SecurityGroupResponse.class)
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/securitygroup/UpdateSecurityGroupCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/securitygroup/UpdateSecurityGroupCmd.java
index 801fb6ac5e5..ea756927b03 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/securitygroup/UpdateSecurityGroupCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/securitygroup/UpdateSecurityGroupCmd.java
@@ -42,7 +42,7 @@ public class UpdateSecurityGroupCmd extends BaseCustomIdCmd {
/////////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, required=true, description="The ID of the security group.", entityType=SecurityGroupResponse.class)
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, required=true, description = "The ID of the security group.", entityType=SecurityGroupResponse.class)
private Long id;
@Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The new name of the security group.")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/ArchiveSnapshotCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/ArchiveSnapshotCmd.java
index f72de2278cc..c6ed36ccef5 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/ArchiveSnapshotCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/ArchiveSnapshotCmd.java
@@ -36,7 +36,7 @@ import org.apache.cloudstack.api.response.SnapshotResponse;
import org.apache.cloudstack.api.response.SuccessResponse;
import org.apache.cloudstack.context.CallContext;
-@APICommand(name = "archiveSnapshot", description = "Archives (moves) a snapshot on primary storage to secondary storage",
+@APICommand(name = "archiveSnapshot", description = "Archives (moves) a Snapshot on primary storage to secondary storage",
responseObject = SnapshotResponse.class, entityType = {Snapshot.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ArchiveSnapshotCmd extends BaseAsyncCmd {
@@ -44,7 +44,7 @@ public class ArchiveSnapshotCmd extends BaseAsyncCmd {
@ACL(accessType = SecurityChecker.AccessType.OperateEntry)
@Parameter(name=ApiConstants.ID, type=CommandType.UUID, entityType = SnapshotResponse.class,
- required=true, description="The ID of the snapshot")
+ required=true, description = "The ID of the Snapshot")
private Long id;
@Override
@@ -54,7 +54,7 @@ public class ArchiveSnapshotCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "Archiving snapshot " + id + " to secondary storage";
+ return "Archiving Snapshot " + id + " to secondary storage";
}
@Override
@@ -65,7 +65,7 @@ public class ArchiveSnapshotCmd extends BaseAsyncCmd {
SuccessResponse response = new SuccessResponse(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to archive snapshot");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to archive Snapshot");
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/CreateSnapshotCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/CreateSnapshotCmd.java
index 3289ac2fe10..bd541b69183 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/CreateSnapshotCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/CreateSnapshotCmd.java
@@ -46,7 +46,7 @@ import com.cloud.storage.Volume;
import com.cloud.user.Account;
import com.cloud.utils.exception.CloudRuntimeException;
-@APICommand(name = "createSnapshot", description = "Creates an instant snapshot of a volume.", responseObject = SnapshotResponse.class, entityType = {Snapshot.class},
+@APICommand(name = "createSnapshot", description = "Creates an instant Snapshot of a volume.", responseObject = SnapshotResponse.class, entityType = {Snapshot.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class CreateSnapshotCmd extends BaseAsyncCreateCmd {
@@ -56,13 +56,13 @@ public class CreateSnapshotCmd extends BaseAsyncCreateCmd {
@Parameter(name = ApiConstants.ACCOUNT,
type = CommandType.STRING,
- description = "The account of the snapshot. The account parameter must be used with the domainId parameter.")
+ description = "The Account of the Snapshot. The Account parameter must be used with the domainId parameter.")
private String accountName;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "The domain ID of the snapshot. If used with the account parameter, specifies a domain for the account associated with the disk volume. If account is NOT provided then snapshot will be assigned to the caller account and domain.")
+ description = "The domain ID of the Snapshot. If used with the Account parameter, specifies a domain for the Account associated with the disk volume. If Account is NOT provided then snapshot will be assigned to the caller Account and domain.")
private Long domainId;
@Parameter(name = ApiConstants.VOLUME_ID, type = CommandType.UUID, entityType = VolumeResponse.class, required = true, description = "The ID of the disk volume")
@@ -71,20 +71,20 @@ public class CreateSnapshotCmd extends BaseAsyncCreateCmd {
@Parameter(name = ApiConstants.POLICY_ID,
type = CommandType.UUID,
entityType = SnapshotPolicyResponse.class,
- description = "policy id of the snapshot, if this is null, then use MANUAL_POLICY.")
+ description = "Policy ID of the Snapshot, if this is null, then use MANUAL_POLICY.")
private Long policyId;
- @Parameter(name = ApiConstants.SNAPSHOT_QUIESCEVM, type = CommandType.BOOLEAN, required = false, description = "quiesce vm if true")
+ @Parameter(name = ApiConstants.SNAPSHOT_QUIESCEVM, type = CommandType.BOOLEAN, required = false, description = "Quiesce Instance if true")
private Boolean quiescevm;
@Parameter(name = ApiConstants.LOCATION_TYPE, type = CommandType.STRING, required = false, description = "Currently applicable only for managed storage. " +
"Valid location types: 'primary', 'secondary'. Default = 'primary'.")
private String locationType;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the snapshot")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the Snapshot")
private String snapshotName;
- @Parameter(name = ApiConstants.ASYNC_BACKUP, type = CommandType.BOOLEAN, required = false, description = "asynchronous backup if true")
+ @Parameter(name = ApiConstants.ASYNC_BACKUP, type = CommandType.BOOLEAN, required = false, description = "Asynchronous backup if true")
private Boolean asyncBackup;
@Parameter(name = ApiConstants.TAGS, type = CommandType.MAP, description = "Map of tags (key/value pairs)")
@@ -186,7 +186,7 @@ public class CreateSnapshotCmd extends BaseAsyncCreateCmd {
" as it's no longer active");
}
} else if (account.getState() == Account.State.DISABLED) {
- throw new PermissionDeniedException("The owner of template is disabled: " + account);
+ throw new PermissionDeniedException("The owner of Template is disabled: " + account);
}
return volume.getAccountId();
@@ -199,7 +199,7 @@ public class CreateSnapshotCmd extends BaseAsyncCreateCmd {
@Override
public String getEventDescription() {
- return "creating snapshot for volume: " + getVolumeUuid();
+ return "Creating Snapshot for volume: " + getVolumeUuid();
}
@Override
@@ -214,7 +214,7 @@ public class CreateSnapshotCmd extends BaseAsyncCreateCmd {
setEntityId(snapshot.getId());
setEntityUuid(snapshot.getUuid());
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create snapshot for volume" + getVolumeUuid());
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create Snapshot for volume" + getVolumeUuid());
}
}
@@ -234,10 +234,10 @@ public class CreateSnapshotCmd extends BaseAsyncCreateCmd {
}
} catch (Exception e) {
if (e.getCause() instanceof UnsupportedOperationException) {
- throw new ServerApiException(ApiErrorCode.UNSUPPORTED_ACTION_ERROR, String.format("Failed to create snapshot due to unsupported operation: %s", e.getCause().getMessage()));
+ throw new ServerApiException(ApiErrorCode.UNSUPPORTED_ACTION_ERROR, String.format("Failed to create Snapshot due to unsupported operation: %s", e.getCause().getMessage()));
}
- String errorMessage = "Failed to create snapshot due to an internal error creating snapshot for volume " + getVolumeUuid();
+ String errorMessage = "Failed to create Snapshot due to an internal error creating Snapshot for volume " + getVolumeUuid();
logger.error(errorMessage, e);
throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, errorMessage);
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/CreateSnapshotFromVMSnapshotCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/CreateSnapshotFromVMSnapshotCmd.java
index cdd908dfb87..6b7e9e83d62 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/CreateSnapshotFromVMSnapshotCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/CreateSnapshotFromVMSnapshotCmd.java
@@ -39,7 +39,7 @@ import com.cloud.user.Account;
import com.cloud.uservm.UserVm;
import com.cloud.vm.snapshot.VMSnapshot;
-@APICommand(name = "createSnapshotFromVMSnapshot", description = "Creates an instant snapshot of a volume from existing vm snapshot.", responseObject = SnapshotResponse.class, entityType = {Snapshot.class}, since = "4.10.0",
+@APICommand(name = "createSnapshotFromVMSnapshot", description = "Creates an instant Snapshot of a volume from existing Instance Snapshot.", responseObject = SnapshotResponse.class, entityType = {Snapshot.class}, since = "4.10.0",
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class CreateSnapshotFromVMSnapshotCmd extends BaseAsyncCreateCmd {
@@ -51,10 +51,10 @@ public class CreateSnapshotFromVMSnapshotCmd extends BaseAsyncCreateCmd {
private Long volumeId;
@Parameter(name=ApiConstants.VM_SNAPSHOT_ID, type=CommandType.UUID, entityType=VMSnapshotResponse.class,
- required=true, description="The ID of the VM snapshot")
+ required=true, description = "The ID of the Instance Snapshot")
private Long vmSnapshotId;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the snapshot")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the Snapshot")
private String snapshotName;
private String syncObjectType = BaseAsyncCmd.snapshotHostSyncObject;
@@ -78,18 +78,18 @@ public class CreateSnapshotFromVMSnapshotCmd extends BaseAsyncCreateCmd {
private Long getVmId() {
VMSnapshot vmsnapshot = _entityMgr.findById(VMSnapshot.class, getVMSnapshotId());
if (vmsnapshot == null) {
- throw new InvalidParameterValueException("Unable to find vm snapshot by id=" + getVMSnapshotId());
+ throw new InvalidParameterValueException("Unable to find Instance Snapshot by id=" + getVMSnapshotId());
}
UserVm vm = _entityMgr.findById(UserVm.class, vmsnapshot.getVmId());
if (vm == null) {
- throw new InvalidParameterValueException("Unable to find vm by vm snapshot id=" + getVMSnapshotId());
+ throw new InvalidParameterValueException("Unable to find Instance by Instance Snapshot id=" + getVMSnapshotId());
}
return vm.getId();
}
private Long getHostId() {
VMSnapshot vmsnapshot = _entityMgr.findById(VMSnapshot.class, getVMSnapshotId());
if (vmsnapshot == null) {
- throw new InvalidParameterValueException("Unable to find vm snapshot by id=" + getVMSnapshotId());
+ throw new InvalidParameterValueException("Unable to find Instance Snapshot by id=" + getVMSnapshotId());
}
UserVm vm = _entityMgr.findById(UserVm.class, vmsnapshot.getVmId());
if (vm != null) {
@@ -124,13 +124,13 @@ public class CreateSnapshotFromVMSnapshotCmd extends BaseAsyncCreateCmd {
if (account.getType() == Account.Type.PROJECT) {
Project project = _projectService.findByProjectAccountId(vmsnapshot.getAccountId());
if (project == null) {
- throw new InvalidParameterValueException(String.format("Unable to find project by account %s", account));
+ throw new InvalidParameterValueException(String.format("Unable to find project by Account %s", account));
}
if (project.getState() != Project.State.Active) {
throw new PermissionDeniedException(String.format("Can't add resources to the project %s in state=%s as it's no longer active", project, project.getState()));
}
} else if (account.getState() == Account.State.DISABLED) {
- throw new PermissionDeniedException("The owner of template is disabled: " + account);
+ throw new PermissionDeniedException("The owner of Template is disabled: " + account);
}
return vmsnapshot.getAccountId();
@@ -143,7 +143,7 @@ public class CreateSnapshotFromVMSnapshotCmd extends BaseAsyncCreateCmd {
@Override
public String getEventDescription() {
- return "creating snapshot from vm snapshot : " + this._uuidMgr.getUuid(VMSnapshot.class, getVMSnapshotId());
+ return "Creating Snapshot from Instance Snapshot : " + this._uuidMgr.getUuid(VMSnapshot.class, getVMSnapshotId());
}
@Override
@@ -158,15 +158,15 @@ public class CreateSnapshotFromVMSnapshotCmd extends BaseAsyncCreateCmd {
this.setEntityId(snapshot.getId());
this.setEntityUuid(snapshot.getUuid());
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create snapshot from vm snapshot");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create Snapshot from Instance Snapshot");
}
}
@Override
public void execute() {
VMSnapshot vmSnapshot = _vmSnapshotService.getVMSnapshotById(getVMSnapshotId());
- logger.info("CreateSnapshotFromVMSnapshotCmd with vm snapshot {} with id {} and snapshot [id: {}, uuid: {}]", vmSnapshot, getVMSnapshotId(), getEntityId(), getEntityUuid());
- CallContext.current().setEventDetails("Vm Snapshot Id: " + vmSnapshot.getUuid());
+ logger.info("CreateSnapshotFromVMSnapshotCmd with Instance Snapshot {} with ID: {} and Snapshot [ID: {}, UUID: {}]", vmSnapshot, getVMSnapshotId(), getEntityId(), getEntityUuid());
+ CallContext.current().setEventDetails("Instance Snapshot Id: " + vmSnapshot.getUuid());
Snapshot snapshot = null;
try {
snapshot = _snapshotService.backupSnapshotFromVmSnapshot(getEntityId(), getVmId(), getVolumeId(), getVMSnapshotId());
@@ -175,19 +175,19 @@ public class CreateSnapshotFromVMSnapshotCmd extends BaseAsyncCreateCmd {
response.setResponseName(getCommandName());
this.setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, String.format("Failed to create snapshot due to an internal error creating snapshot from vm snapshot %s", vmSnapshot));
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, String.format("Failed to create Snapshot due to an internal error creating Snapshot from Instance Snapshot %s", vmSnapshot));
}
} catch (InvalidParameterValueException ex) {
throw ex;
} catch (Exception e) {
logger.debug("Failed to create snapshot", e);
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, String.format("Failed to create snapshot due to an internal error creating snapshot from vm snapshot %s", vmSnapshot));
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, String.format("Failed to create Snapshot due to an internal error creating Snapshot from Instance Snapshot %s", vmSnapshot));
} finally {
if (snapshot == null) {
try {
_snapshotService.deleteSnapshot(getEntityId(), null);
} catch (Exception e) {
- logger.debug("Failed to clean failed snapshot {} with id {}", () -> _entityMgr.findById(Snapshot.class, getEntityId()), this::getEntityId);
+ logger.debug("Failed to clean failed Snapshot {} with ID {}", () -> _entityMgr.findById(Snapshot.class, getEntityId()), this::getEntityId);
}
}
}
@@ -209,4 +209,9 @@ public class CreateSnapshotFromVMSnapshotCmd extends BaseAsyncCreateCmd {
}
return null;
}
+
+ @Override
+ public Long getApiResourceId() {
+ return getEntityId();
+ }
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/CreateSnapshotPolicyCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/CreateSnapshotPolicyCmd.java
index e30b897db2e..246a2fefa9f 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/CreateSnapshotPolicyCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/CreateSnapshotPolicyCmd.java
@@ -41,7 +41,7 @@ import com.cloud.storage.Volume;
import com.cloud.storage.snapshot.SnapshotPolicy;
import com.cloud.user.Account;
-@APICommand(name = "createSnapshotPolicy", description = "Creates a snapshot policy for the account.", responseObject = SnapshotPolicyResponse.class,
+@APICommand(name = "createSnapshotPolicy", description = "Creates a Snapshot policy for the account.", responseObject = SnapshotPolicyResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class CreateSnapshotPolicyCmd extends BaseCmd {
@@ -50,13 +50,13 @@ public class CreateSnapshotPolicyCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.INTERVAL_TYPE, type = CommandType.STRING, required = true, description = "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY")
+ @Parameter(name = ApiConstants.INTERVAL_TYPE, type = CommandType.STRING, required = true, description = "Valid values are HOURLY, DAILY, WEEKLY, and MONTHLY")
private String intervalType;
- @Parameter(name = ApiConstants.MAX_SNAPS, type = CommandType.INTEGER, required = true, description = "maximum number of snapshots to retain")
+ @Parameter(name = ApiConstants.MAX_SNAPS, type = CommandType.INTEGER, required = true, description = "Maximum number of Snapshots to retain")
private Integer maxSnaps;
- @Parameter(name = ApiConstants.SCHEDULE, type = CommandType.STRING, required = true, description = "time the snapshot is scheduled to be taken. " + "Format is:"
+ @Parameter(name = ApiConstants.SCHEDULE, type = CommandType.STRING, required = true, description = "Time the Snapshot is scheduled to be taken. " + "Format is:"
+ "* if HOURLY, MM" + "* if DAILY, MM:HH" + "* if WEEKLY, MM:HH:DD (1-7)" + "* if MONTHLY, MM:HH:DD (1-28)")
private String schedule;
@@ -66,10 +66,10 @@ public class CreateSnapshotPolicyCmd extends BaseCmd {
description = "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.")
private String timezone;
- @Parameter(name = ApiConstants.VOLUME_ID, type = CommandType.UUID, entityType = VolumeResponse.class, required = true, description = "the ID of the disk volume")
+ @Parameter(name = ApiConstants.VOLUME_ID, type = CommandType.UUID, entityType = VolumeResponse.class, required = true, description = "The ID of the disk volume")
private Long volumeId;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the policy to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the policy to the end user or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
@Parameter(name = ApiConstants.TAGS, type = CommandType.MAP, description = "Map of tags (key/value pairs)")
@@ -141,7 +141,7 @@ public class CreateSnapshotPolicyCmd extends BaseCmd {
throw ex;
}
} else if (account.getState() == Account.State.DISABLED) {
- throw new PermissionDeniedException("The owner of template is disabled: " + account);
+ throw new PermissionDeniedException("The owner of Template is disabled: " + account);
}
return volume.getAccountId();
@@ -167,7 +167,7 @@ public class CreateSnapshotPolicyCmd extends BaseCmd {
response.setResponseName(getCommandName());
this.setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create snapshot policy");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create Snapshot policy");
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/DeleteSnapshotCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/DeleteSnapshotCmd.java
index a0a8cfac9bd..89477737581 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/DeleteSnapshotCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/DeleteSnapshotCmd.java
@@ -35,7 +35,7 @@ import com.cloud.event.EventTypes;
import com.cloud.storage.Snapshot;
import com.cloud.user.Account;
-@APICommand(name = "deleteSnapshot", description = "Deletes a snapshot of a disk volume.", responseObject = SuccessResponse.class, entityType = {Snapshot.class},
+@APICommand(name = "deleteSnapshot", description = "Deletes a Snapshot of a disk volume.", responseObject = SuccessResponse.class, entityType = {Snapshot.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class DeleteSnapshotCmd extends BaseAsyncCmd {
@@ -45,7 +45,7 @@ public class DeleteSnapshotCmd extends BaseAsyncCmd {
@ACL(accessType = AccessType.OperateEntry)
@Parameter(name=ApiConstants.ID, type=CommandType.UUID, entityType = SnapshotResponse.class,
- required=true, description="The ID of the snapshot")
+ required=true, description = "The ID of the Snapshot")
private Long id;
@Parameter(name=ApiConstants.ZONE_ID, type=CommandType.UUID, entityType = ZoneResponse.class,
description="The ID of the zone for the snapshot", since = "4.19.0")
@@ -85,7 +85,7 @@ public class DeleteSnapshotCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "deleting snapshot: " + this._uuidMgr.getUuid(Snapshot.class, getId());
+ return "Deleting Snapshot: " + this._uuidMgr.getUuid(Snapshot.class, getId());
}
@Override
@@ -106,7 +106,7 @@ public class DeleteSnapshotCmd extends BaseAsyncCmd {
SuccessResponse response = new SuccessResponse(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to delete snapshot");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to delete Snapshot");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/DeleteSnapshotPoliciesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/DeleteSnapshotPoliciesCmd.java
index 6f4b60dc8b2..79ac80f78e8 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/DeleteSnapshotPoliciesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/DeleteSnapshotPoliciesCmd.java
@@ -30,7 +30,7 @@ import org.apache.cloudstack.api.response.SuccessResponse;
import com.cloud.user.Account;
-@APICommand(name = "deleteSnapshotPolicies", description = "Deletes snapshot policies for the account.", responseObject = SuccessResponse.class,
+@APICommand(name = "deleteSnapshotPolicies", description = "Deletes Snapshot policies for the account.", responseObject = SuccessResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class DeleteSnapshotPoliciesCmd extends BaseCmd {
@@ -39,14 +39,14 @@ public class DeleteSnapshotPoliciesCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = SnapshotPolicyResponse.class, description = "the Id of the snapshot policy")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = SnapshotPolicyResponse.class, description = "The ID of the Snapshot policy")
private Long id;
@Parameter(name = ApiConstants.IDS,
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = SnapshotPolicyResponse.class,
- description = "list of snapshots policy IDs separated by comma")
+ description = "List of Snapshots policy IDs separated by comma")
private List ids;
/////////////////////////////////////////////////////
@@ -77,7 +77,7 @@ public class DeleteSnapshotPoliciesCmd extends BaseCmd {
SuccessResponse response = new SuccessResponse(getCommandName());
this.setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to delete snapshot policy");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to delete Snapshot policy");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/ListSnapshotPoliciesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/ListSnapshotPoliciesCmd.java
index 126a4080e6d..06051492e85 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/ListSnapshotPoliciesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/ListSnapshotPoliciesCmd.java
@@ -32,7 +32,7 @@ import org.apache.cloudstack.api.response.VolumeResponse;
import com.cloud.storage.snapshot.SnapshotPolicy;
import com.cloud.utils.Pair;
-@APICommand(name = "listSnapshotPolicies", description = "Lists snapshot policies.", responseObject = SnapshotPolicyResponse.class,
+@APICommand(name = "listSnapshotPolicies", description = "Lists Snapshot policies.", responseObject = SnapshotPolicyResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListSnapshotPoliciesCmd extends BaseListCmd {
@@ -41,13 +41,13 @@ public class ListSnapshotPoliciesCmd extends BaseListCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.VOLUME_ID, type = CommandType.UUID, entityType = VolumeResponse.class, description = "the ID of the disk volume")
+ @Parameter(name = ApiConstants.VOLUME_ID, type = CommandType.UUID, entityType = VolumeResponse.class, description = "The ID of the disk volume")
private Long volumeId;
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = SnapshotPolicyResponse.class, description = "the ID of the snapshot policy")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = SnapshotPolicyResponse.class, description = "The ID of the Snapshot policy")
private Long id;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "list resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "List resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/ListSnapshotsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/ListSnapshotsCmd.java
index 826c54c2e05..316b9c8d0c9 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/ListSnapshotsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/ListSnapshotsCmd.java
@@ -31,7 +31,7 @@ import org.apache.cloudstack.api.response.ZoneResponse;
import com.cloud.storage.Snapshot;
-@APICommand(name = "listSnapshots", description = "Lists all available snapshots for the account.", responseObject = SnapshotResponse.class, entityType = {
+@APICommand(name = "listSnapshots", description = "Lists all available Snapshots for the Account.", responseObject = SnapshotResponse.class, entityType = {
Snapshot.class }, responseView = ResponseObject.ResponseView.Restricted, requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListSnapshotsCmd extends BaseListTaggedResourcesCmd {
@@ -40,25 +40,25 @@ public class ListSnapshotsCmd extends BaseListTaggedResourcesCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = SnapshotResponse.class, description = "lists snapshot by snapshot ID")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = SnapshotResponse.class, description = "Lists Snapshot by Snapshot ID")
private Long id;
- @Parameter(name=ApiConstants.IDS, type=CommandType.LIST, collectionType=CommandType.UUID, entityType=SnapshotResponse.class, description="the IDs of the snapshots, mutually exclusive with id", since = "4.9")
+ @Parameter(name=ApiConstants.IDS, type=CommandType.LIST, collectionType=CommandType.UUID, entityType=SnapshotResponse.class, description = "The IDs of the Snapshots, mutually exclusive with id", since = "4.9")
private List ids;
- @Parameter(name = ApiConstants.INTERVAL_TYPE, type = CommandType.STRING, description = "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.")
+ @Parameter(name = ApiConstants.INTERVAL_TYPE, type = CommandType.STRING, description = "Valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.")
private String intervalType;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "lists snapshot by snapshot name")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "Lists Snapshot by Snapshot name")
private String snapshotName;
- @Parameter(name = ApiConstants.SNAPSHOT_TYPE, type = CommandType.STRING, description = "valid values are MANUAL or RECURRING.")
+ @Parameter(name = ApiConstants.SNAPSHOT_TYPE, type = CommandType.STRING, description = "Valid values are MANUAL or RECURRING.")
private String snapshotType;
- @Parameter(name = ApiConstants.VOLUME_ID, type = CommandType.UUID, entityType = VolumeResponse.class, description = "the ID of the disk volume")
+ @Parameter(name = ApiConstants.VOLUME_ID, type = CommandType.UUID, entityType = VolumeResponse.class, description = "The ID of the disk volume")
private Long volumeId;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "list snapshots by zone id")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "List Snapshots by zone id")
private Long zoneId;
@Parameter(name = ApiConstants.SHOW_UNIQUE, type = CommandType.BOOLEAN, description = "If set to false, list templates across zones and their storages", since = "4.19.0")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/RevertSnapshotCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/RevertSnapshotCmd.java
index fe3b4da0160..7cee7e71cf3 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/RevertSnapshotCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/RevertSnapshotCmd.java
@@ -35,7 +35,7 @@ import com.cloud.event.EventTypes;
import com.cloud.storage.Snapshot;
import com.cloud.user.Account;
-@APICommand(name = "revertSnapshot", description = "This is supposed to revert a volume snapshot. This command is only supported with KVM so far", responseObject = SnapshotResponse.class, entityType = {Snapshot.class},
+@APICommand(name = "revertSnapshot", description = "This is supposed to revert a volume Snapshot. This command is only supported with KVM so far", responseObject = SnapshotResponse.class, entityType = {Snapshot.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class RevertSnapshotCmd extends BaseAsyncCmd {
@@ -44,7 +44,7 @@ public class RevertSnapshotCmd extends BaseAsyncCmd {
/////////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
@Parameter(name= ApiConstants.ID, type= BaseCmd.CommandType.UUID, entityType = SnapshotResponse.class,
- required=true, description="The ID of the snapshot")
+ required=true, description = "The ID of the Snapshot")
private Long id;
/////////////////////////////////////////////////////
@@ -74,7 +74,7 @@ public class RevertSnapshotCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "revert snapshot: " + this._uuidMgr.getUuid(Snapshot.class, getId());
+ return "revert Snapshot: " + this._uuidMgr.getUuid(Snapshot.class, getId());
}
@Override
@@ -96,7 +96,7 @@ public class RevertSnapshotCmd extends BaseAsyncCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to revert snapshot");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to revert Snapshot");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/UpdateSnapshotPolicyCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/UpdateSnapshotPolicyCmd.java
index e7feb11f4af..ba98956644c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/UpdateSnapshotPolicyCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/snapshot/UpdateSnapshotPolicyCmd.java
@@ -35,7 +35,7 @@ import org.apache.cloudstack.api.response.SnapshotPolicyResponse;
import org.apache.cloudstack.context.CallContext;
-@APICommand(name = "updateSnapshotPolicy", description = "Updates the snapshot policy.", responseObject = SnapshotPolicyResponse.class, responseView = ResponseObject.ResponseView.Restricted, entityType = {Volume.class},
+@APICommand(name = "updateSnapshotPolicy", description = "Updates the Snapshot policy.", responseObject = SnapshotPolicyResponse.class, responseView = ResponseObject.ResponseView.Restricted, entityType = {Volume.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class UpdateSnapshotPolicyCmd extends BaseAsyncCustomIdCmd {
@@ -44,12 +44,12 @@ public class UpdateSnapshotPolicyCmd extends BaseAsyncCustomIdCmd {
/////////////////////////////////////////////////////
@ACL(accessType = SecurityChecker.AccessType.OperateEntry)
- @Parameter(name= ApiConstants.ID, type=CommandType.UUID, entityType=SnapshotPolicyResponse.class, description="the ID of the snapshot policy")
+ @Parameter(name= ApiConstants.ID, type=CommandType.UUID, entityType=SnapshotPolicyResponse.class, description = "The ID of the Snapshot policy")
private Long id;
@Parameter(name = ApiConstants.FOR_DISPLAY,
type = CommandType.BOOLEAN,
- description = "an optional field, whether to the display the snapshot policy to the end user or not.",
+ description = "An optional field, whether to the display the Snapshot policy to the end user or not.",
since = "4.4",
authorized = {RoleType.Admin})
private Boolean display;
@@ -80,11 +80,11 @@ public class UpdateSnapshotPolicyCmd extends BaseAsyncCustomIdCmd {
SnapshotPolicy policy = _entityMgr.findById(SnapshotPolicy.class, getId());
if (policy == null) {
- throw new InvalidParameterValueException("Invalid snapshot policy id was provided");
+ throw new InvalidParameterValueException("Invalid Snapshot policy ID was provided");
}
Volume volume = _responseGenerator.findVolumeById(policy.getVolumeId());
if (volume == null) {
- throw new InvalidParameterValueException("Snapshot policy's volume id doesn't exist");
+ throw new InvalidParameterValueException("Snapshot policy's volume ID doesn't exist");
}else{
return volume.getAccountId();
}
@@ -97,21 +97,21 @@ public class UpdateSnapshotPolicyCmd extends BaseAsyncCustomIdCmd {
@Override
public String getEventDescription() {
- StringBuilder desc = new StringBuilder("Updating snapshot policy: ");
+ StringBuilder desc = new StringBuilder("Updating Snapshot policy: ");
desc.append(getId());
return desc.toString();
}
@Override
public void execute() {
- CallContext.current().setEventDetails("SnapshotPolicy Id: " + getId());
+ CallContext.current().setEventDetails("SnapshotPolicy ID: " + getId());
SnapshotPolicy result = _snapshotService.updateSnapshotPolicy(this);
if (result != null) {
SnapshotPolicyResponse response = _responseGenerator.createSnapshotPolicyResponse(result);
response.setResponseName(getCommandName());
this.setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update snapshot policy");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update Snapshot policy");
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/ssh/CreateSSHKeyPairCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/ssh/CreateSSHKeyPairCmd.java
index 5212779e965..a55b2059302 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/ssh/CreateSSHKeyPairCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/ssh/CreateSSHKeyPairCmd.java
@@ -40,16 +40,16 @@ public class CreateSSHKeyPairCmd extends BaseCmd {
private String name;
//Owner information
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "an optional account for the ssh key. Must be used with domainId.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "An optional Account for the SSH key. Must be used with domainId.")
private String accountName;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.")
+ description = "An optional domainId for the SSH key. If the Account parameter is used, domainId must also be used.")
private Long domainId;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "an optional project for the ssh key")
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "An optional project for the SSH key")
private Long projectId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/ssh/DeleteSSHKeyPairCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/ssh/DeleteSSHKeyPairCmd.java
index 364ca77ae1f..4ed8664a79d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/ssh/DeleteSSHKeyPairCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/ssh/DeleteSSHKeyPairCmd.java
@@ -41,13 +41,13 @@ public class DeleteSSHKeyPairCmd extends BaseCmd {
@Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "Name of the keypair")
private String name;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "the account associated with the keypair. Must be used with the domainId parameter.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "The Account associated with the keypair. Must be used with the domainId parameter.")
private String accountName;
- @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "the domain ID associated with the keypair")
+ @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "The domain ID associated with the keypair")
private Long domainId;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "the project associated with keypair")
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "The project associated with keypair")
private Long projectId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/ssh/ListSSHKeyPairsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/ssh/ListSSHKeyPairsCmd.java
index 6bf8dca864b..343db1bc956 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/ssh/ListSSHKeyPairsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/ssh/ListSSHKeyPairsCmd.java
@@ -37,7 +37,7 @@ public class ListSSHKeyPairsCmd extends BaseListProjectAndAccountResourcesCmd {
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = SSHKeyPairResponse.class, description = "the ID of the ssh keypair")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = SSHKeyPairResponse.class, description = "The ID of the SSH keypair")
private Long id;
@Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "A key pair name to look for")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/ssh/RegisterSSHKeyPairCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/ssh/RegisterSSHKeyPairCmd.java
index 6a0c0541bb4..36c708ea111 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/ssh/RegisterSSHKeyPairCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/ssh/RegisterSSHKeyPairCmd.java
@@ -43,16 +43,16 @@ public class RegisterSSHKeyPairCmd extends BaseCmd {
private String publicKey;
//Owner information
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "an optional account for the ssh key. Must be used with domainId.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "An optional Account for the SSH key. Must be used with domainId.")
private String accountName;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "an optional domainId for the ssh key. If the account parameter is used, domainId must also be used.")
+ description = "An optional domainId for the SSH key. If the Account parameter is used, domainId must also be used.")
private Long domainId;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "an optional project for the ssh key")
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "An optional project for the SSH key")
private Long projectId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/tag/CreateTagsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/tag/CreateTagsCmd.java
index 30904db46c4..6350baefe9a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/tag/CreateTagsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/tag/CreateTagsCmd.java
@@ -46,17 +46,17 @@ public class CreateTagsCmd extends BaseAsyncCmd {
@Parameter(name = ApiConstants.TAGS, type = CommandType.MAP, required = true, description = "Map of tags (key/value pairs)")
private Map tag;
- @Parameter(name = ApiConstants.RESOURCE_TYPE, type = CommandType.STRING, required = true, description = "type of the resource")
+ @Parameter(name = ApiConstants.RESOURCE_TYPE, type = CommandType.STRING, required = true, description = "Type of the resource")
private String resourceType;
@Parameter(name = ApiConstants.RESOURCE_IDS,
type = CommandType.LIST,
required = true,
collectionType = CommandType.STRING,
- description = "list of resources to create the tags for")
+ description = "List of resources to create the tags for")
private List resourceIds;
- @Parameter(name = ApiConstants.CUSTOMER, type = CommandType.STRING, description = "identifies client specific tag. "
+ @Parameter(name = ApiConstants.CUSTOMER, type = CommandType.STRING, description = "Identifies client specific tag. "
+ "When the value is not null, the tag can't be used by cloudStack code internally")
private String customer;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/tag/ListTagsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/tag/ListTagsCmd.java
index 8b3c83aa20a..2590f7d67b7 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/tag/ListTagsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/tag/ListTagsCmd.java
@@ -30,19 +30,19 @@ import com.cloud.server.ResourceTag;
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListTagsCmd extends BaseListProjectAndAccountResourcesCmd {
- @Parameter(name = ApiConstants.RESOURCE_TYPE, type = CommandType.STRING, description = "list by resource type")
+ @Parameter(name = ApiConstants.RESOURCE_TYPE, type = CommandType.STRING, description = "List by resource type")
private String resourceType;
- @Parameter(name = ApiConstants.RESOURCE_ID, type = CommandType.STRING, description = "list by resource id")
+ @Parameter(name = ApiConstants.RESOURCE_ID, type = CommandType.STRING, description = "List by resource ID")
private String resourceId;
- @Parameter(name = ApiConstants.KEY, type = CommandType.STRING, description = "list by key")
+ @Parameter(name = ApiConstants.KEY, type = CommandType.STRING, description = "List by key")
private String key;
- @Parameter(name = ApiConstants.VALUE, type = CommandType.STRING, description = "list by value")
+ @Parameter(name = ApiConstants.VALUE, type = CommandType.STRING, description = "List by value")
private String value;
- @Parameter(name = ApiConstants.CUSTOMER, type = CommandType.STRING, description = "list by customer name")
+ @Parameter(name = ApiConstants.CUSTOMER, type = CommandType.STRING, description = "List by customer name")
private String customer;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/template/CopyTemplateCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/template/CopyTemplateCmd.java
index f094bc43507..66a20fac860 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/template/CopyTemplateCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/template/CopyTemplateCmd.java
@@ -39,7 +39,7 @@ import com.cloud.exception.StorageUnavailableException;
import com.cloud.template.VirtualMachineTemplate;
import com.cloud.user.Account;
-@APICommand(name = "copyTemplate", description = "Copies a template from one zone to another.", responseObject = TemplateResponse.class, responseView = ResponseView.Restricted,
+@APICommand(name = "copyTemplate", description = "Copies a Template from one zone to another.", responseObject = TemplateResponse.class, responseView = ResponseView.Restricted,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class CopyTemplateCmd extends BaseAsyncCmd implements UserCmd {
private static final String s_name = "copytemplateresponse";
@@ -52,7 +52,7 @@ public class CopyTemplateCmd extends BaseAsyncCmd implements UserCmd {
type = CommandType.UUID,
entityType = ZoneResponse.class,
required = false,
- description = "ID of the zone the template is being copied to.")
+ description = "ID of the zone the Template is being copied to.")
protected Long destZoneId;
@Parameter(name = ApiConstants.ID, type = CommandType.UUID,
@@ -62,9 +62,9 @@ public class CopyTemplateCmd extends BaseAsyncCmd implements UserCmd {
@Parameter(name = ApiConstants.SOURCE_ZONE_ID,
type = CommandType.UUID,
entityType = ZoneResponse.class,
- description = "ID of the zone the template is currently hosted on. " +
- "If not specified and template is cross-zone, " +
- "then we will sync this template to region wide image store.")
+ description = "ID of the zone the Template is currently hosted on. " +
+ "If not specified and Template is cross-zone, " +
+ "then we will sync this Template to region wide image store.")
private Long sourceZoneId;
@Parameter(name = ApiConstants.DESTINATION_ZONE_ID_LIST,
@@ -72,8 +72,8 @@ public class CopyTemplateCmd extends BaseAsyncCmd implements UserCmd {
collectionType = CommandType.UUID,
entityType = ZoneResponse.class,
required = false,
- description = "A list of IDs of the zones that the template needs to be copied to." +
- "Specify this list if the template needs to copied to multiple zones in one go. " +
+ description = "A list of IDs of the zones that the Template needs to be copied to." +
+ "Specify this list if the Template needs to copied to multiple zones in one go. " +
"Do not specify destzoneid and destzoneids together, however one of them is required.")
protected List destZoneIds;
@@ -148,7 +148,7 @@ public class CopyTemplateCmd extends BaseAsyncCmd implements UserCmd {
}
}
- return "copying template: " + this._uuidMgr.getUuid(VirtualMachineTemplate.class, getId()) +((getSourceZoneId() != null) ? " from zone: " + this._uuidMgr.getUuid(DataCenter.class, getSourceZoneId()) : "") + ((descBuilder.length() > 0) ? " to zones: " + descBuilder.toString() : "");
+ return "Copying Template: " + this._uuidMgr.getUuid(VirtualMachineTemplate.class, getId()) +((getSourceZoneId() != null) ? " from zone: " + this._uuidMgr.getUuid(DataCenter.class, getSourceZoneId()) : "") + ((descBuilder.length() > 0) ? " to zones: " + descBuilder.toString() : "");
}
@Override
@@ -186,7 +186,7 @@ public class CopyTemplateCmd extends BaseAsyncCmd implements UserCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to copy template");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to copy Template");
}
} catch (StorageUnavailableException ex) {
logger.warn("Exception: ", ex);
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/template/CreateTemplateCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/template/CreateTemplateCmd.java
index 0a7bf291843..6e6acf16252 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/template/CreateTemplateCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/template/CreateTemplateCmd.java
@@ -20,6 +20,7 @@ import java.util.Collection;
import java.util.List;
import java.util.Map;
+import com.cloud.cpu.CPU;
import org.apache.cloudstack.acl.SecurityChecker;
import org.apache.cloudstack.api.APICommand;
import org.apache.cloudstack.api.ApiCommandResourceType;
@@ -50,8 +51,8 @@ import com.cloud.storage.Volume;
import com.cloud.template.VirtualMachineTemplate;
import com.cloud.user.Account;
-@APICommand(name = "createTemplate", responseObject = TemplateResponse.class, description = "Creates a template of a virtual machine. " + "The virtual machine must be in a STOPPED state. "
- + "A template created from this command is automatically designated as a private template visible to the account that created it.", responseView = ResponseView.Restricted,
+@APICommand(name = "createTemplate", responseObject = TemplateResponse.class, description = "Creates a Template of an Instance. " + "The Instance must be in a STOPPED state. "
+ + "A Template created from this command is automatically designated as a private Template visible to the account that created it.", responseView = ResponseView.Restricted,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class CreateTemplateCmd extends BaseAsyncCreateCmd implements UserCmd {
private static final String s_name = "createtemplateresponse";
@@ -65,60 +66,60 @@ public class CreateTemplateCmd extends BaseAsyncCreateCmd implements UserCmd {
@Parameter(name = ApiConstants.DISPLAY_TEXT,
type = CommandType.STRING,
- description = "The display text of the template, defaults to the 'name'.",
+ description = "The display text of the Template, defaults to the 'name'.",
length = 4096)
private String displayText;
- @Parameter(name = ApiConstants.IS_FEATURED, type = CommandType.BOOLEAN, description = "true if this template is a featured template, false otherwise")
+ @Parameter(name = ApiConstants.IS_FEATURED, type = CommandType.BOOLEAN, description = "True if this Template is a featured Template, false otherwise")
private Boolean featured;
- @Parameter(name = ApiConstants.IS_PUBLIC, type = CommandType.BOOLEAN, description = "true if this template is a public template, false otherwise")
+ @Parameter(name = ApiConstants.IS_PUBLIC, type = CommandType.BOOLEAN, description = "True if this Template is a public Template, false otherwise")
private Boolean publicTemplate;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "the name of the template")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "The name of the Template")
private String templateName;
@Parameter(name = ApiConstants.OS_TYPE_ID,
type = CommandType.UUID,
entityType = GuestOSResponse.class,
required = true,
- description = "the ID of the OS Type that best represents the OS of this template.")
+ description = "The ID of the OS Type that best represents the OS of this Template.")
private Long osTypeId;
@Parameter(name = ApiConstants.PASSWORD_ENABLED,
type = CommandType.BOOLEAN,
- description = "true if the template supports the password reset feature; default is false")
+ description = "True if the Template supports the password reset feature; default is false")
private Boolean passwordEnabled;
- @Parameter(name = ApiConstants.SSHKEY_ENABLED, type = CommandType.BOOLEAN, description = "true if the template supports the sshkey upload feature; default is false")
+ @Parameter(name = ApiConstants.SSHKEY_ENABLED, type = CommandType.BOOLEAN, description = "True if the Template supports the SSHkey upload feature; default is false")
private Boolean sshKeyEnabled;
- @Parameter(name = ApiConstants.REQUIRES_HVM, type = CommandType.BOOLEAN, description = "true if the template requires HVM, false otherwise")
+ @Parameter(name = ApiConstants.REQUIRES_HVM, type = CommandType.BOOLEAN, description = "True if the Template requires HVM, false otherwise")
private Boolean requiresHvm;
@Parameter(name = ApiConstants.SNAPSHOT_ID,
type = CommandType.UUID,
entityType = SnapshotResponse.class,
- description = "the ID of the snapshot the template is being created from. Either this parameter, or volumeId has to be passed in")
+ description = "The ID of the Snapshot the Template is being created from. Either this parameter, or volumeId has to be passed in")
protected Long snapshotId;
@Parameter(name = ApiConstants.VOLUME_ID,
type = CommandType.UUID,
entityType = VolumeResponse.class,
- description = "the ID of the disk volume the template is being created from. Either this parameter, or snapshotId has to be passed in")
+ description = "The ID of the disk volume the Template is being created from. Either this parameter, or snapshotId has to be passed in")
protected Long volumeId;
@Parameter(name=ApiConstants.VIRTUAL_MACHINE_ID, type=CommandType.UUID, entityType = UserVmResponse.class,
- description="Optional, VM ID. If this presents, it is going to create a baremetal template for VM this ID refers to. This is only for VM whose hypervisor type is BareMetal")
+ description = "Optional, Instance ID. If this presents, it is going to create a baremetal Template for Instance this ID refers to. This is only for Instance whose hypervisor type is BareMetal")
protected Long vmId;
@Parameter(name = ApiConstants.URL,
type = CommandType.STRING,
length = 2048,
- description = "Optional, only for baremetal hypervisor. The directory name where template stored on CIFS server")
+ description = "Optional, only for baremetal hypervisor. The directory name where Template stored on CIFS server")
private String url;
- @Parameter(name = ApiConstants.TEMPLATE_TAG, type = CommandType.STRING, description = "the tag for this template.")
+ @Parameter(name = ApiConstants.TEMPLATE_TAG, type = CommandType.STRING, description = "The tag for this Template.")
private String templateTag;
@Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61")
@@ -126,10 +127,10 @@ public class CreateTemplateCmd extends BaseAsyncCreateCmd implements UserCmd {
@Parameter(name = ApiConstants.IS_DYNAMICALLY_SCALABLE,
type = CommandType.BOOLEAN,
- description = "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory")
+ description = "True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory")
protected Boolean isDynamicallyScalable;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "create template for the project")
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "Create Template for the project")
private Long projectId;
@Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "the zone for the template. Can be specified with snapshot only", since = "4.19.0")
@@ -148,6 +149,11 @@ public class CreateTemplateCmd extends BaseAsyncCreateCmd implements UserCmd {
since = "4.19.0")
private String accountName;
+ @Parameter(name = ApiConstants.ARCH, type = CommandType.STRING,
+ description = "the CPU arch of the template. Valid options are: x86_64, aarch64. Defaults to x86_64",
+ since = "4.20.2")
+ private String arch;
+
// ///////////////////////////////////////////////////
// ///////////////// Accessors ///////////////////////
// ///////////////////////////////////////////////////
@@ -205,7 +211,7 @@ public class CreateTemplateCmd extends BaseAsyncCreateCmd implements UserCmd {
}
public String getTemplateTag() {
- return templateTag;
+ return StringUtils.isBlank(templateTag) ? null : templateTag;
}
public Map getDetails() {
@@ -234,6 +240,10 @@ public class CreateTemplateCmd extends BaseAsyncCreateCmd implements UserCmd {
return accountName;
}
+ public CPU.CPUArch getArch() {
+ return CPU.CPUArch.fromType(arch);
+ }
+
// ///////////////////////////////////////////////////
// ///////////// API Implementation///////////////////
// ///////////////////////////////////////////////////
@@ -262,7 +272,7 @@ public class CreateTemplateCmd extends BaseAsyncCreateCmd implements UserCmd {
@Override
public String getEventDescription() {
- return "creating template: " + getTemplateName();
+ return "Creating Template: " + getTemplateName();
}
@Override
@@ -283,7 +293,7 @@ public class CreateTemplateCmd extends BaseAsyncCreateCmd implements UserCmd {
setEntityId(template.getId());
setEntityUuid(template.getUuid());
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create a template");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create a Template");
}
}
@@ -291,7 +301,7 @@ public class CreateTemplateCmd extends BaseAsyncCreateCmd implements UserCmd {
@Override
public void execute() {
CallContext.current().setEventDetails(
- "Template Id: " + getEntityUuid() + ((getSnapshotId() == null) ? " from volume Id: " + this._uuidMgr.getUuid(Volume.class, getVolumeId()) : " from snapshot Id: " + this._uuidMgr.getUuid(Snapshot.class, getSnapshotId())));
+ "Template Id: " + getEntityUuid() + ((getSnapshotId() == null) ? " from volume Id: " + this._uuidMgr.getUuid(Volume.class, getVolumeId()) : " from Snapshot Id: " + this._uuidMgr.getUuid(Snapshot.class, getSnapshotId())));
VirtualMachineTemplate template = _templateService.createPrivateTemplate(this);
if (template != null) {
@@ -308,7 +318,7 @@ public class CreateTemplateCmd extends BaseAsyncCreateCmd implements UserCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create private template");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create private Template");
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/template/DeleteTemplateCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/template/DeleteTemplateCmd.java
index 5e9bf317fe1..fef70d188e5 100755
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/template/DeleteTemplateCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/template/DeleteTemplateCmd.java
@@ -37,7 +37,7 @@ import com.cloud.user.Account;
@APICommand(name = "deleteTemplate",
responseObject = SuccessResponse.class,
- description = "Deletes a template from the system. All virtual machines using the deleted template will not be affected.",
+ description = "Deletes a Template from the system. All Instances using the deleted Template will not be affected.",
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class DeleteTemplateCmd extends BaseAsyncCmd {
@@ -45,13 +45,13 @@ public class DeleteTemplateCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TemplateResponse.class, required = true, description = "the ID of the template")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TemplateResponse.class, required = true, description = "The ID of the Template")
private Long id;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "the ID of zone of the template")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "The ID of zone of the Template")
private Long zoneId;
- @Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN, required = false, description = "Force delete a template.", since = "4.9+")
+ @Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN, required = false, description = "Force delete a Template.", since = "4.9+")
private Boolean forced;
@Parameter(name = ApiConstants.IS_SYSTEM, type = CommandType.BOOLEAN, required = false, description = "Necessary if the template's type is system.", since = "4.20.0", authorized = {RoleType.Admin})
@@ -98,7 +98,7 @@ public class DeleteTemplateCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "Deleting template " + this._uuidMgr.getUuid(VirtualMachineTemplate.class, getId());
+ return "Deleting Template " + this._uuidMgr.getUuid(VirtualMachineTemplate.class, getId());
}
@Override
@@ -119,7 +119,7 @@ public class DeleteTemplateCmd extends BaseAsyncCmd {
SuccessResponse response = new SuccessResponse(getCommandName());
this.setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to delete template");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to delete Template");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/template/ExtractTemplateCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/template/ExtractTemplateCmd.java
index 22f59351e9a..b0215b12ef2 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/template/ExtractTemplateCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/template/ExtractTemplateCmd.java
@@ -34,7 +34,7 @@ import com.cloud.exception.InternalErrorException;
import com.cloud.template.VirtualMachineTemplate;
import com.cloud.user.Account;
-@APICommand(name = "extractTemplate", description = "Extracts a template", responseObject = ExtractResponse.class,
+@APICommand(name = "extractTemplate", description = "Extracts a Template", responseObject = ExtractResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ExtractTemplateCmd extends BaseAsyncCmd {
@@ -43,20 +43,20 @@ public class ExtractTemplateCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TemplateResponse.class, required = true, description = "the ID of the template")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TemplateResponse.class, required = true, description = "The ID of the Template")
private Long id;
- @Parameter(name = ApiConstants.URL, type = CommandType.STRING, required = false, length = 2048, description = "the url to which the ISO would be extracted")
+ @Parameter(name = ApiConstants.URL, type = CommandType.STRING, required = false, length = 2048, description = "The url to which the ISO would be extracted")
private String url;
@Parameter(name = ApiConstants.ZONE_ID,
type = CommandType.UUID,
entityType = ZoneResponse.class,
required = false,
- description = "the ID of the zone where the ISO is originally located")
+ description = "The ID of the zone where the ISO is originally located")
private Long zoneId;
- @Parameter(name = ApiConstants.MODE, type = CommandType.STRING, required = true, description = "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD")
+ @Parameter(name = ApiConstants.MODE, type = CommandType.STRING, required = true, description = "The mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD")
private String mode;
/////////////////////////////////////////////////////
@@ -102,7 +102,7 @@ public class ExtractTemplateCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
String templateId = this._uuidMgr.getUuid(VirtualMachineTemplate.class, getId());
- String baseDescription = String.format("Extracting template: %s", templateId);
+ String baseDescription = String.format("Extracting Template: %s", templateId);
Long zoneId = getZoneId();
if (zoneId == null) {
@@ -133,7 +133,7 @@ public class ExtractTemplateCmd extends BaseAsyncCmd {
response.setObjectName("template");
this.setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to extract template");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to extract Template");
}
} catch (InternalErrorException ex) {
logger.warn("Exception: ", ex);
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/template/GetUploadParamsForTemplateCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/template/GetUploadParamsForTemplateCmd.java
index 8fa1a5d53eb..9671dd42b98 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/template/GetUploadParamsForTemplateCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/template/GetUploadParamsForTemplateCmd.java
@@ -38,7 +38,7 @@ import org.apache.commons.lang3.StringUtils;
import com.cloud.exception.ResourceAllocationException;
-@APICommand(name = "getUploadParamsForTemplate", description = "upload an existing template into the CloudStack cloud. ",
+@APICommand(name = "getUploadParamsForTemplate", description = "Upload an existing Template into the CloudStack cloud. ",
responseObject = GetUploadParamsResponse.class, since = "4.6.0",
authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
@@ -46,14 +46,14 @@ public class GetUploadParamsForTemplateCmd extends AbstractGetUploadParamsCmd {
private static final String s_name = "postuploadtemplateresponse";
- @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "the display text of the template. This is usually used for display purposes.", length = 4096)
+ @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "The display text of the Template. This is usually used for display purposes.", length = 4096)
private String displayText;
- @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, required = true, description = "the target hypervisor for the template")
+ @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, required = true, description = "The target hypervisor for the Template")
private String hypervisor;
@Parameter(name = ApiConstants.OS_TYPE_ID, type = CommandType.UUID, entityType = GuestOSResponse.class, required = false,
- description = "the ID of the OS Type that best represents the OS of this template. Not required for VMware as the guest OS is obtained from the OVF file.")
+ description = "The ID of the OS Type that best represents the OS of this Template. Not required for VMware as the guest OS is obtained from the OVF file.")
private Long osTypeId;
@Parameter(name = ApiConstants.ARCH, type = CommandType.STRING,
@@ -67,36 +67,36 @@ public class GetUploadParamsForTemplateCmd extends AbstractGetUploadParamsCmd {
@Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "Template details in key/value pairs.")
private Map details;
- @Parameter(name = ApiConstants.IS_DYNAMICALLY_SCALABLE, type = CommandType.BOOLEAN, description = "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory")
+ @Parameter(name = ApiConstants.IS_DYNAMICALLY_SCALABLE, type = CommandType.BOOLEAN, description = "True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory")
private Boolean isDynamicallyScalable;
- @Parameter(name = ApiConstants.IS_EXTRACTABLE, type = CommandType.BOOLEAN, description = "true if the template or its derivatives are extractable; default is false")
+ @Parameter(name = ApiConstants.IS_EXTRACTABLE, type = CommandType.BOOLEAN, description = "True if the Template or its derivatives are extractable; default is false")
private Boolean extractable;
- @Parameter(name = ApiConstants.IS_FEATURED, type = CommandType.BOOLEAN, description = "true if this template is a featured template, false otherwise")
+ @Parameter(name = ApiConstants.IS_FEATURED, type = CommandType.BOOLEAN, description = "True if this Template is a featured Template, false otherwise")
private Boolean featured;
- @Parameter(name = ApiConstants.IS_PUBLIC, type = CommandType.BOOLEAN, description = "true if the template is available to all accounts; default is true")
+ @Parameter(name = ApiConstants.IS_PUBLIC, type = CommandType.BOOLEAN, description = "True if the Template is available to all accounts; default is true")
private Boolean publicTemplate;
- @Parameter(name = ApiConstants.ROUTING, type = CommandType.BOOLEAN, description = "true if the template type is routing i.e., if template is used to deploy router")
+ @Parameter(name = ApiConstants.ROUTING, type = CommandType.BOOLEAN, description = "True if the Template type is routing i.e., if Template is used to deploy router")
private Boolean isRoutingType;
- @Parameter(name = ApiConstants.PASSWORD_ENABLED, type = CommandType.BOOLEAN, description = "true if the template supports the password reset feature; default is false")
+ @Parameter(name = ApiConstants.PASSWORD_ENABLED, type = CommandType.BOOLEAN, description = "True if the Template supports the password reset feature; default is false")
private Boolean passwordEnabled;
- @Parameter(name = ApiConstants.REQUIRES_HVM, type = CommandType.BOOLEAN, description = "true if this template requires HVM")
+ @Parameter(name = ApiConstants.REQUIRES_HVM, type = CommandType.BOOLEAN, description = "True if this Template requires HVM")
private Boolean requiresHvm;
- @Parameter(name = ApiConstants.SSHKEY_ENABLED, type = CommandType.BOOLEAN, description = "true if the template supports the sshkey upload feature; default is false")
+ @Parameter(name = ApiConstants.SSHKEY_ENABLED, type = CommandType.BOOLEAN, description = "True if the Template supports the SSHkey upload feature; default is false")
private Boolean sshKeyEnabled;
- @Parameter(name = ApiConstants.TEMPLATE_TAG, type = CommandType.STRING, description = "the tag for this template.")
+ @Parameter(name = ApiConstants.TEMPLATE_TAG, type = CommandType.STRING, description = "The tag for this Template.")
private String templateTag;
@Parameter(name=ApiConstants.DEPLOY_AS_IS,
type = CommandType.BOOLEAN,
- description = "(VMware only) true if VM deployments should preserve all the configurations defined for this template", since = "4.15.1")
+ description = "(VMware only) true if Instance deployments should preserve all the configurations defined for this Template", since = "4.15.1")
private Boolean deployAsIs;
public String getDisplayText() {
@@ -160,7 +160,7 @@ public class GetUploadParamsForTemplateCmd extends AbstractGetUploadParamsCmd {
}
public String getTemplateTag() {
- return templateTag;
+ return StringUtils.isBlank(templateTag) ? null : templateTag;
}
public boolean isDeployAsIs() {
@@ -180,14 +180,14 @@ public class GetUploadParamsForTemplateCmd extends AbstractGetUploadParamsCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} catch (ResourceAllocationException | MalformedURLException e) {
- logger.error("exception while registering template", e);
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "exception while registering template: " + e.getMessage());
+ logger.error("Exception while registering Template", e);
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Exception while registering Template: " + e.getMessage());
}
}
private void validateRequest() {
if (getZoneId() <= 0) {
- throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "invalid zoneid");
+ throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "Invalid zoneid");
}
if (!isDeployAsIs() && osTypeId == null) {
throw new ServerApiException(ApiErrorCode.PARAM_ERROR, "Missing parameter ostypeid");
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/template/ListTemplatePermissionsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/template/ListTemplatePermissionsCmd.java
index 6d544df4187..9dabbec3750 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/template/ListTemplatePermissionsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/template/ListTemplatePermissionsCmd.java
@@ -26,7 +26,7 @@ import org.apache.cloudstack.api.response.TemplatePermissionsResponse;
import com.cloud.storage.Storage.ImageFormat;
import com.cloud.template.VirtualMachineTemplate;
-@APICommand(name = "listTemplatePermissions", description = "List template visibility and all accounts that have permissions to view this template.", responseObject = TemplatePermissionsResponse.class, responseView = ResponseView.Restricted,
+@APICommand(name = "listTemplatePermissions", description = "List Template visibility and all accounts that have permissions to view this Template.", responseObject = TemplatePermissionsResponse.class, responseView = ResponseView.Restricted,
requestHasSensitiveInfo = false,
responseHasSensitiveInfo = false)
public class ListTemplatePermissionsCmd extends BaseListTemplateOrIsoPermissionsCmd implements UserCmd {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/template/ListTemplatesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/template/ListTemplatesCmd.java
index bff65ef70a9..9edca36147c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/template/ListTemplatesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/template/ListTemplatesCmd.java
@@ -44,7 +44,7 @@ import com.cloud.template.VirtualMachineTemplate.TemplateFilter;
import com.cloud.user.Account;
import org.apache.commons.lang3.StringUtils;
-@APICommand(name = "listTemplates", description = "List all public, private, and privileged templates.", responseObject = TemplateResponse.class, entityType = {VirtualMachineTemplate.class}, responseView = ResponseView.Restricted,
+@APICommand(name = "listTemplates", description = "List all public, private, and privileged Templates.", responseObject = TemplateResponse.class, entityType = {VirtualMachineTemplate.class}, responseView = ResponseView.Restricted,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListTemplatesCmd extends BaseListTaggedResourcesCmd implements UserCmd {
@@ -54,47 +54,47 @@ public class ListTemplatesCmd extends BaseListTaggedResourcesCmd implements User
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, description = "the hypervisor for which to restrict the search")
+ @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, description = "The hypervisor for which to restrict the search")
private String hypervisor;
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TemplateResponse.class, description = "the template ID")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = TemplateResponse.class, description = "The Template ID")
private Long id;
- @Parameter(name=ApiConstants.IDS, type=CommandType.LIST, collectionType=CommandType.UUID, entityType=TemplateResponse.class, description="the IDs of the templates, mutually exclusive with id", since = "4.9")
+ @Parameter(name=ApiConstants.IDS, type=CommandType.LIST, collectionType=CommandType.UUID, entityType=TemplateResponse.class, description = "The IDs of the Templates, mutually exclusive with id", since = "4.9")
private List ids;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the template name")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The Template name")
private String templateName;
@Parameter(name = ApiConstants.TEMPLATE_FILTER,
type = CommandType.STRING,
required = true,
- description = "possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". "
- + "* featured : templates that have been marked as featured and public. "
- + "* self : templates that have been registered or created by the calling user. "
- + "* selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. "
- + "* sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. "
- + "* executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. "
- + "* community : templates that have been marked as public but not featured. " + "* all : all templates (only usable by admins).")
+ description = "Possible values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\", and \"community\". "
+ + "* featured : Templates that have been marked as featured and public. "
+ + "* self : Templates that have been registered or created by the calling user. "
+ + "* selfexecutable : same as self, but only returns Templates that can be used to deploy a new Instance. "
+ + "* sharedexecutable : Templates ready to be deployed that have been granted to the calling user by another user. "
+ + "* executable : Templates that are owned by the calling user, or public Templates, that can be used to deploy an Instance. "
+ + "* community : Templates that have been marked as public but not featured. " + "* all : all Templates (only usable by admins).")
private String templateFilter;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "list templates by zoneId")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "List Templates by zoneId")
private Long zoneId;
- @Parameter(name = ApiConstants.SHOW_REMOVED, type = CommandType.BOOLEAN, description = "show removed templates as well")
+ @Parameter(name = ApiConstants.SHOW_REMOVED, type = CommandType.BOOLEAN, description = "Show removed Templates as well")
private Boolean showRemoved;
- @Parameter(name = ApiConstants.SHOW_UNIQUE, type = CommandType.BOOLEAN, description = "If set to true, list only unique templates across zones", since = "4.13.2")
+ @Parameter(name = ApiConstants.SHOW_UNIQUE, type = CommandType.BOOLEAN, description = "If set to true, list only unique Templates across zones", since = "4.13.2")
private Boolean showUnique;
- @Parameter(name = ApiConstants.PARENT_TEMPLATE_ID, type = CommandType.UUID, entityType = TemplateResponse.class, description = "list datadisk templates by parent template id", since = "4.4")
+ @Parameter(name = ApiConstants.PARENT_TEMPLATE_ID, type = CommandType.UUID, entityType = TemplateResponse.class, description = "List datadisk Templates by parent Template id", since = "4.4")
private Long parentTemplateId;
@Parameter(name = ApiConstants.DETAILS,
type = CommandType.LIST,
collectionType = CommandType.STRING,
since = "4.15",
- description = "comma separated list of template details requested, value can be a list of [ all, min]")
+ description = "Comma separated list of Template details requested, value can be a list of [all, min]")
private List viewDetails;
@Parameter(name = ApiConstants.TEMPLATE_TYPE, type = CommandType.STRING,
@@ -183,7 +183,7 @@ public class ListTemplatesCmd extends BaseListTaggedResourcesCmd implements User
return onlyReady;
}
- @Parameter(name = ApiConstants.SHOW_RESOURCE_ICON, type = CommandType.BOOLEAN, description = "flag to display the resource image for the templates")
+ @Parameter(name = ApiConstants.SHOW_RESOURCE_ICON, type = CommandType.BOOLEAN, description = "Flag to display the resource image for the Templates")
private Boolean showIcon;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/template/RegisterTemplateCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/template/RegisterTemplateCmd.java
index 1f968b869b9..851dbaa192f 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/template/RegisterTemplateCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/template/RegisterTemplateCmd.java
@@ -46,7 +46,7 @@ import org.apache.commons.lang3.StringUtils;
import com.cloud.exception.ResourceAllocationException;
import com.cloud.template.VirtualMachineTemplate;
-@APICommand(name = "registerTemplate", description = "Registers an existing template into the CloudStack cloud. ", responseObject = TemplateResponse.class, responseView = ResponseView.Restricted,
+@APICommand(name = "registerTemplate", description = "Registers an existing Template into the CloudStack cloud. ", responseObject = TemplateResponse.class, responseView = ResponseView.Restricted,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class RegisterTemplateCmd extends BaseCmd implements UserCmd {
@@ -61,76 +61,76 @@ public class RegisterTemplateCmd extends BaseCmd implements UserCmd {
@Parameter(name = ApiConstants.DISPLAY_TEXT,
type = CommandType.STRING,
- description = "The display text of the template, defaults to 'name'.",
+ description = "The display text of the Template, defaults to 'name'.",
length = 4096)
private String displayText;
@Parameter(name = ApiConstants.FORMAT,
type = CommandType.STRING,
required = true,
- description = "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.")
+ description = "The format for the Template. Possible values include QCOW2, RAW, VHD and OVA.")
private String format;
- @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, required = true, description = "the target hypervisor for the template")
+ @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, required = true, description = "The target hypervisor for the Template")
protected String hypervisor;
- @Parameter(name = ApiConstants.IS_FEATURED, type = CommandType.BOOLEAN, description = "true if this template is a featured template, false otherwise")
+ @Parameter(name = ApiConstants.IS_FEATURED, type = CommandType.BOOLEAN, description = "True if this Template is a featured Template, false otherwise")
private Boolean featured;
- @Parameter(name = ApiConstants.IS_PUBLIC, type = CommandType.BOOLEAN, description = "true if the template is available to all accounts; default is true")
+ @Parameter(name = ApiConstants.IS_PUBLIC, type = CommandType.BOOLEAN, description = "True if the Template is available to all accounts; default is true")
private Boolean publicTemplate;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "the name of the template")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "The name of the Template")
private String templateName;
@Parameter(name = ApiConstants.OS_TYPE_ID,
type = CommandType.UUID,
entityType = GuestOSResponse.class,
required = false,
- description = "the ID of the OS Type that best represents the OS of this template. Not applicable with VMware, as we honour what is defined in the template")
+ description = "The ID of the OS Type that best represents the OS of this Template. Not applicable with VMware, as we honour what is defined in the Template")
private Long osTypeId;
@Parameter(name = ApiConstants.PASSWORD_ENABLED,
type = CommandType.BOOLEAN,
- description = "true if the template supports the password reset feature; default is false")
+ description = "True if the Template supports the password reset feature; default is false")
private Boolean passwordEnabled;
- @Parameter(name = ApiConstants.SSHKEY_ENABLED, type = CommandType.BOOLEAN, description = "true if the template supports the sshkey upload feature; default is false")
+ @Parameter(name = ApiConstants.SSHKEY_ENABLED, type = CommandType.BOOLEAN, description = "True if the Template supports the sshkey upload feature; default is false")
private Boolean sshKeyEnabled;
- @Parameter(name = ApiConstants.IS_EXTRACTABLE, type = CommandType.BOOLEAN, description = "true if the template or its derivatives are extractable; default is false")
+ @Parameter(name = ApiConstants.IS_EXTRACTABLE, type = CommandType.BOOLEAN, description = "True if the Template or its derivatives are extractable; default is false")
private Boolean extractable;
- @Parameter(name = ApiConstants.REQUIRES_HVM, type = CommandType.BOOLEAN, description = "true if this template requires HVM")
+ @Parameter(name = ApiConstants.REQUIRES_HVM, type = CommandType.BOOLEAN, description = "True if this Template requires HVM")
private Boolean requiresHvm;
@Parameter(name = ApiConstants.URL,
type = CommandType.STRING,
required = true,
length = 2048,
- description = "the URL of where the template is hosted. Possible URL include http:// and https://")
+ description = "The URL of where the Template is hosted. Possible URL include http:// and https://")
private String url;
@Parameter(name=ApiConstants.ZONE_ID, type=CommandType.UUID, entityType = ZoneResponse.class,
- required=false, description="the ID of the zone the template is to be hosted on")
+ required=false, description = "The ID of the zone the Template is to be hosted on")
protected Long zoneId;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "an optional domainId. If the account parameter is used, domainId must also be used.")
+ description = "An optional domainId. If the account parameter is used, domainId must also be used.")
private Long domainId;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "an optional accountName. Must be used with domainId.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "An optional accountName. Must be used with domainId.")
private String accountName;
- @Parameter(name = ApiConstants.CHECKSUM, type = CommandType.STRING, description = "the checksum value of this template. " + ApiConstants.CHECKSUM_PARAMETER_PREFIX_DESCRIPTION)
+ @Parameter(name = ApiConstants.CHECKSUM, type = CommandType.STRING, description = "The checksum value of this Template. " + ApiConstants.CHECKSUM_PARAMETER_PREFIX_DESCRIPTION)
private String checksum;
- @Parameter(name = ApiConstants.TEMPLATE_TAG, type = CommandType.STRING, description = "the tag for this template.")
+ @Parameter(name = ApiConstants.TEMPLATE_TAG, type = CommandType.STRING, description = "The tag for this Template.")
private String templateTag;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "Register template for the project")
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "Register Template for the project")
private Long projectId;
@Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP,
@@ -139,11 +139,11 @@ public class RegisterTemplateCmd extends BaseCmd implements UserCmd {
@Parameter(name = ApiConstants.IS_DYNAMICALLY_SCALABLE,
type = CommandType.BOOLEAN,
- description = "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory")
+ description = "True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance cpu/memory")
protected Boolean isDynamicallyScalable;
@Deprecated
- @Parameter(name = ApiConstants.ROUTING, type = CommandType.BOOLEAN, description = "true if the template type is routing i.e., if template is used to deploy router")
+ @Parameter(name = ApiConstants.ROUTING, type = CommandType.BOOLEAN, description = "True if the Template type is routing i.e., if Template is used to deploy router")
protected Boolean isRoutingType;
@Parameter(name=ApiConstants.ZONE_ID_LIST,
@@ -151,21 +151,21 @@ public class RegisterTemplateCmd extends BaseCmd implements UserCmd {
collectionType = CommandType.UUID,
entityType = ZoneResponse.class,
required=false,
- description="A list of zone ids where the template will be hosted. Use this parameter if the template needs " +
- "to be registered to multiple zones in one go. Use zoneid if the template " +
+ description = "A list of zone IDs where the Template will be hosted. Use this parameter if the Template needs " +
+ "to be registered to multiple zones in one go. Use zoneid if the Template " +
"needs to be registered to only one zone." +
- "Passing only -1 to this will cause the template to be registered as a cross " +
- "zone template and will be copied to all zones. ")
+ "Passing only -1 to this will cause the Template to be registered as a cross " +
+ "zone Template and will be copied to all zones. ")
protected List zoneIds;
@Parameter(name=ApiConstants.DIRECT_DOWNLOAD,
type = CommandType.BOOLEAN,
- description = "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment")
+ description = "True if Template should bypass Secondary Storage and be downloaded to Primary Storage on deployment")
private Boolean directDownload;
@Parameter(name=ApiConstants.DEPLOY_AS_IS,
type = CommandType.BOOLEAN,
- description = "(VMware only) true if VM deployments should preserve all the configurations defined for this template", since = "4.15.1")
+ description = "(VMware only) true if Instance deployments should preserve all the configurations defined for this Template", since = "4.15.1")
protected Boolean deployAsIs;
@Parameter(name = ApiConstants.TEMPLATE_TYPE, type = CommandType.STRING,
@@ -265,7 +265,7 @@ public class RegisterTemplateCmd extends BaseCmd implements UserCmd {
}
public String getTemplateTag() {
- return templateTag;
+ return StringUtils.isBlank(templateTag) ? null : templateTag;
}
public Map getDetails() {
@@ -340,7 +340,7 @@ public class RegisterTemplateCmd extends BaseCmd implements UserCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to register template");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to register Template");
}
} catch (URISyntaxException ex1) {
logger.info(ex1);
@@ -367,7 +367,7 @@ public class RegisterTemplateCmd extends BaseCmd implements UserCmd {
.isFunctionalitySupported(Hypervisor.HypervisorType.Functionality.DirectDownloadTemplate)
|| getHypervisor().equalsIgnoreCase(customHypervisor))) {
throw new ServerApiException(ApiErrorCode.PARAM_ERROR, String.format("Parameter directdownload " +
- "is only allowed for KVM or %s templates", customHypervisor));
+ "is only allowed for KVM or %s Templates", customHypervisor));
}
if (!isDeployAsIs() && osTypeId == null) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/template/UpdateTemplateCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/template/UpdateTemplateCmd.java
index dbbd771293a..f51e5169b37 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/template/UpdateTemplateCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/template/UpdateTemplateCmd.java
@@ -30,7 +30,7 @@ import org.apache.cloudstack.api.response.TemplateResponse;
import com.cloud.template.VirtualMachineTemplate;
import com.cloud.user.Account;
-@APICommand(name = "updateTemplate", description = "Updates attributes of a template.", responseObject = TemplateResponse.class, responseView = ResponseView.Restricted,
+@APICommand(name = "updateTemplate", description = "Updates attributes of a Template.", responseObject = TemplateResponse.class, responseView = ResponseView.Restricted,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class UpdateTemplateCmd extends BaseUpdateTemplateOrIsoCmd implements UserCmd {
private static final String s_name = "updatetemplateresponse";
@@ -40,7 +40,7 @@ public class UpdateTemplateCmd extends BaseUpdateTemplateOrIsoCmd implements Use
/////////////////////////////////////////////////////
@Parameter(name = ApiConstants.TEMPLATE_TYPE, type = CommandType.STRING,
- description = "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).")
+ description = "The type of the Template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).")
private String templateType;
@Parameter(name = ApiConstants.TEMPLATE_TAG, type = CommandType.STRING, description = "the tag for this template.", since = "4.20.0")
@@ -106,7 +106,7 @@ public class UpdateTemplateCmd extends BaseUpdateTemplateOrIsoCmd implements Use
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update template");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update Template");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/template/UpdateTemplatePermissionsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/template/UpdateTemplatePermissionsCmd.java
index de8f09a6400..9c408238fe2 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/template/UpdateTemplatePermissionsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/template/UpdateTemplatePermissionsCmd.java
@@ -24,9 +24,9 @@ import org.apache.cloudstack.api.response.SuccessResponse;
import com.cloud.template.VirtualMachineTemplate;
import com.cloud.user.Account;
-@APICommand(name = "updateTemplatePermissions", responseObject = SuccessResponse.class, description = "Updates a template visibility permissions. "
- + "A public template is visible to all accounts within the same domain. " + "A private template is visible only to the owner of the template. "
- + "A privileged template is a private template with account permissions added. " + "Only accounts specified under the template permissions are visible to them.", entityType = {VirtualMachineTemplate.class},
+@APICommand(name = "updateTemplatePermissions", responseObject = SuccessResponse.class, description = "Updates a Template visibility permissions. "
+ + "A public Template is visible to all accounts within the same domain. " + "A private Template is visible only to the owner of the Template. "
+ + "A privileged Template is a private Template with account permissions added. " + "Only accounts specified under the Template permissions are visible to them.", entityType = {VirtualMachineTemplate.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class UpdateTemplatePermissionsCmd extends BaseUpdateTemplateOrIsoPermissionsCmd {
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/userdata/DeleteUserDataCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/userdata/DeleteUserDataCmd.java
index a1d1afc7b05..f6d29e5dc40 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/userdata/DeleteUserDataCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/userdata/DeleteUserDataCmd.java
@@ -43,20 +43,20 @@ public class DeleteUserDataCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, required = true, entityType = UserDataResponse.class, description = "the ID of the Userdata")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, required = true, entityType = UserDataResponse.class, description = "The ID of the Userdata")
private Long id;
//Owner information
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "an optional account for the userdata. Must be used with domainId.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "An optional account for the userdata. Must be used with domainId.")
private String accountName;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.")
+ description = "An optional domainId for the userdata. If the account parameter is used, domainId must also be used.")
private Long domainId;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "an optional project for the userdata")
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "An optional project for the userdata")
private Long projectId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/userdata/LinkUserDataToTemplateCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/userdata/LinkUserDataToTemplateCmd.java
index e322de00bb1..c8c6d17d416 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/userdata/LinkUserDataToTemplateCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/userdata/LinkUserDataToTemplateCmd.java
@@ -34,7 +34,7 @@ import com.cloud.user.Account;
import com.cloud.user.UserData;
import com.cloud.utils.exception.CloudRuntimeException;
-@APICommand(name = "linkUserDataToTemplate", description = "Link or unlink a userdata to a template.", responseObject = TemplateResponse.class, responseView = ResponseObject.ResponseView.Restricted,
+@APICommand(name = "linkUserDataToTemplate", description = "Link or unlink a userdata to a Template.", responseObject = TemplateResponse.class, responseView = ResponseObject.ResponseView.Restricted,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false, since = "4.18.0",
authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User})
public class LinkUserDataToTemplateCmd extends BaseCmd implements AdminCmd {
@@ -47,24 +47,24 @@ public class LinkUserDataToTemplateCmd extends BaseCmd implements AdminCmd {
@Parameter(name = ApiConstants.TEMPLATE_ID,
type = CommandType.UUID,
entityType = TemplateResponse.class,
- description = "the ID of the template for the virtual machine")
+ description = "The ID of the Template for the Instance")
private Long templateId;
@Parameter(name = ApiConstants.ISO_ID,
type = CommandType.UUID,
entityType = TemplateResponse.class,
- description = "the ID of the ISO for the virtual machine")
+ description = "The ID of the ISO for the Instance")
private Long isoId;
@Parameter(name = ApiConstants.USER_DATA_ID,
type = CommandType.UUID,
entityType = UserDataResponse.class,
- description = "the ID of the userdata that has to be linked to template/ISO. If not provided existing userdata will be unlinked from the template/ISO")
+ description = "The ID of the userdata that has to be linked to Template/ISO. If not provided existing userdata will be unlinked from the Template/ISO")
private Long userdataId;
@Parameter(name = ApiConstants.USER_DATA_POLICY,
type = CommandType.STRING,
- description = "an optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride")
+ description = "An optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride")
private String userdataPolicy;
/////////////////////////////////////////////////////
@@ -96,7 +96,7 @@ public class LinkUserDataToTemplateCmd extends BaseCmd implements AdminCmd {
try {
result = _templateService.linkUserDataToTemplate(this);
} catch (Exception e) {
- throw new CloudRuntimeException(String.format("Failed to link userdata to template, due to: %s", e.getLocalizedMessage()), e);
+ throw new CloudRuntimeException(String.format("Failed to link userdata to Template, due to: %s", e.getLocalizedMessage()), e);
}
if (result != null) {
TemplateResponse response = _responseGenerator.createTemplateUpdateResponse(getResponseView(), result);
@@ -109,7 +109,7 @@ public class LinkUserDataToTemplateCmd extends BaseCmd implements AdminCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to link userdata to template");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to link userdata to Template");
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/userdata/ListUserDataCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/userdata/ListUserDataCmd.java
index 64ab3ec3d70..c2da0e25e20 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/userdata/ListUserDataCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/userdata/ListUserDataCmd.java
@@ -38,7 +38,7 @@ public class ListUserDataCmd extends BaseListProjectAndAccountResourcesCmd {
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = UserDataResponse.class, description = "the ID of the Userdata")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = UserDataResponse.class, description = "The ID of the Userdata")
private Long id;
@Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "Userdata name to look for")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/userdata/RegisterUserDataCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/userdata/RegisterUserDataCmd.java
index 41d865d678c..4d455f913c5 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/userdata/RegisterUserDataCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/userdata/RegisterUserDataCmd.java
@@ -43,7 +43,7 @@ import com.cloud.network.NetworkModel;
import com.cloud.user.UserData;
@APICommand(name = "registerUserData",
- description = "Register a new userdata.",
+ description = "Register a new User Data.",
since = "4.18",
responseObject = SuccessResponse.class,
requestHasSensitiveInfo = false,
@@ -56,33 +56,33 @@ public class RegisterUserDataCmd extends BaseCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "Name of the userdata")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "Name of the User Data")
private String name;
//Owner information
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "an optional account for the userdata. Must be used with domainId.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "An optional Account for the User Data. Must be used with domainId.")
private String accountName;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.")
+ description = "An optional domainId for the User Data. If the Account parameter is used, domainId must also be used.")
private Long domainId;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "an optional project for the userdata")
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "An optional project for the User Data")
private Long projectId;
@Parameter(name = ApiConstants.USER_DATA,
type = CommandType.STRING,
required = true,
- description = "Base64 encoded userdata content. " +
+ description = "Base64 encoded User Data content. " +
"Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. " +
- "Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. " +
- "You also need to change vm.userdata.max.length value",
+ "Using HTTP POST (via POST body), you can send up to 32KB of data after base64 encoding, " +
+ "which can be increased upto 1MB using the vm.userdata.max.length setting",
length = 1048576)
private String userData;
- @Parameter(name = ApiConstants.PARAMS, type = CommandType.STRING, description = "comma separated list of variables declared in userdata content")
+ @Parameter(name = ApiConstants.PARAMS, type = CommandType.STRING, description = "Comma separated list of variables declared in the User Data content")
private String params;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/AddIpToVmNicCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/AddIpToVmNicCmd.java
index e76a75ae398..3882b157e6e 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/AddIpToVmNicCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/AddIpToVmNicCmd.java
@@ -50,7 +50,7 @@ public class AddIpToVmNicCmd extends BaseAsyncCreateCmd {
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.NIC_ID, type = CommandType.UUID, entityType = NicResponse.class, required = true, description = "the ID of the nic to which you want to assign private IP")
+ @Parameter(name = ApiConstants.NIC_ID, type = CommandType.UUID, entityType = NicResponse.class, required = true, description = "The ID of the NIC to which you want to assign private IP")
private Long nicId;
@Parameter(name = ApiConstants.IP_ADDRESS, type = CommandType.STRING, required = false, description = "Secondary IP Address")
@@ -67,7 +67,7 @@ public class AddIpToVmNicCmd extends BaseAsyncCreateCmd {
private long getNetworkId() {
Nic nic = _entityMgr.findById(Nic.class, nicId);
if (nic == null) {
- throw new InvalidParameterValueException("Can't find network id for specified nic");
+ throw new InvalidParameterValueException("Can't find Network ID for specified NIC");
}
return nic.getNetworkId();
}
@@ -89,7 +89,7 @@ public class AddIpToVmNicCmd extends BaseAsyncCreateCmd {
@Override
public String getEventDescription() {
- return "associating ip to nic id=" + this._uuidMgr.getUuid(Nic.class, getNicId()) + " belonging to network id=" + this._uuidMgr.getUuid(Network.class, getNetworkId());
+ return "Associating IP to NIC id=" + this._uuidMgr.getUuid(Nic.class, getNicId()) + " belonging to Network id=" + this._uuidMgr.getUuid(Network.class, getNetworkId());
}
/////////////////////////////////////////////////////
@@ -117,14 +117,14 @@ public class AddIpToVmNicCmd extends BaseAsyncCreateCmd {
success = _networkService.configureNicSecondaryIp(result, isZoneSGEnabled());
if (success == false) {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to set security group rules for the secondary ip");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to set security group rules for the secondary IP");
}
NicSecondaryIpResponse response = _responseGenerator.createSecondaryIPToNicResponse(result);
response.setResponseName(getCommandName());
this.setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to assign secondary ip to nic");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to assign secondary IP to NIC");
}
}
@@ -142,7 +142,7 @@ public class AddIpToVmNicCmd extends BaseAsyncCreateCmd {
public long getEntityOwnerId() {
Nic nic = _entityMgr.findById(Nic.class, nicId);
if (nic == null) {
- throw new InvalidParameterValueException("Can't find nic for id specified");
+ throw new InvalidParameterValueException("Can't find NIC for id specified");
}
long vmId = nic.getInstanceId();
VirtualMachine vm = _entityMgr.findById(VirtualMachine.class, vmId);
@@ -166,11 +166,11 @@ public class AddIpToVmNicCmd extends BaseAsyncCreateCmd {
setEntityUuid(result.getUuid());
}
} catch (InsufficientAddressCapacityException e) {
- throw new InvalidParameterValueException("Allocating guest ip for nic failed : " + e.getMessage());
+ throw new InvalidParameterValueException("Allocating guest IP for NIC failed : " + e.getMessage());
}
if (result == null) {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to assign secondary ip to nic");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to assign secondary IP to NIC");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/AddNicToVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/AddNicToVMCmd.java
index ecd066d98cd..cf91e15601b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/AddNicToVMCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/AddNicToVMCmd.java
@@ -47,7 +47,7 @@ import com.cloud.utils.net.Dhcp;
import com.cloud.utils.net.NetUtils;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "addNicToVirtualMachine", description = "Adds VM to specified network by creating a NIC", responseObject = UserVmResponse.class, responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
+@APICommand(name = "addNicToVirtualMachine", description = "Adds Instance to specified Network by creating a NIC", responseObject = UserVmResponse.class, responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class AddNicToVMCmd extends BaseAsyncCmd implements UserCmd {
private static final String s_name = "addnictovirtualmachineresponse";
@@ -57,19 +57,19 @@ public class AddNicToVMCmd extends BaseAsyncCmd implements UserCmd {
/////////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
@Parameter(name=ApiConstants.VIRTUAL_MACHINE_ID, type=CommandType.UUID, entityType=UserVmResponse.class,
- required=true, description="Virtual Machine ID")
+ required=true, description = "Instance ID")
private Long vmId;
@Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, required = true, description = "Network ID")
private Long netId;
- @Parameter(name = ApiConstants.IP_ADDRESS, type = CommandType.STRING, description = "IP Address for the new network")
+ @Parameter(name = ApiConstants.IP_ADDRESS, type = CommandType.STRING, description = "IP Address for the new Network")
private String ipaddr;
- @Parameter(name = ApiConstants.MAC_ADDRESS, type = CommandType.STRING, description = "Mac Address for the new network")
+ @Parameter(name = ApiConstants.MAC_ADDRESS, type = CommandType.STRING, description = "Mac Address for the new Network")
private String macaddr;
- @Parameter(name = ApiConstants.DHCP_OPTIONS, type = CommandType.MAP, description = "DHCP options which are passed to the nic"
+ @Parameter(name = ApiConstants.DHCP_OPTIONS, type = CommandType.MAP, description = "DHCP options which are passed to the NIC"
+ " Example: dhcpoptions[0].dhcp:114=url&dhcpoptions[0].dhcp:66=www.test.com")
private Map dhcpOptions;
@@ -121,7 +121,7 @@ public class AddNicToVMCmd extends BaseAsyncCmd implements UserCmd {
@Override
public String getEventDescription() {
- return "Adding network " + this._uuidMgr.getUuid(Network.class, getNetworkId()) + " to user vm: " + this._uuidMgr.getUuid(VirtualMachine.class, getVmId());
+ return "Adding Network " + this._uuidMgr.getUuid(Network.class, getNetworkId()) + " to User Instance: " + this._uuidMgr.getUuid(VirtualMachine.class, getVmId());
}
@Override
@@ -177,7 +177,7 @@ public class AddNicToVMCmd extends BaseAsyncCmd implements UserCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to add NIC to vm. Refer to server logs for details.");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to add NIC to Instance. Refer to server logs for details.");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/CreateVMScheduleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/CreateVMScheduleCmd.java
index 5811eb1abfc..7e9bdd942ed 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/CreateVMScheduleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/CreateVMScheduleCmd.java
@@ -32,7 +32,7 @@ import org.apache.cloudstack.vm.schedule.VMScheduleManager;
import javax.inject.Inject;
import java.util.Date;
-@APICommand(name = "createVMSchedule", description = "Create VM Schedule", responseObject = VMScheduleResponse.class,
+@APICommand(name = "createVMSchedule", description = "Create Instance Schedule", responseObject = VMScheduleResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false, since = "4.19.0",
authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User})
public class CreateVMScheduleCmd extends BaseCmd {
@@ -44,7 +44,7 @@ public class CreateVMScheduleCmd extends BaseCmd {
type = CommandType.UUID,
entityType = UserVmResponse.class,
required = true,
- description = "ID of the VM for which schedule is to be defined")
+ description = "ID of the Instance for which schedule is to be defined")
private Long vmId;
@Parameter(name = ApiConstants.DESCRIPTION,
@@ -56,7 +56,7 @@ public class CreateVMScheduleCmd extends BaseCmd {
@Parameter(name = ApiConstants.SCHEDULE,
type = CommandType.STRING,
required = true,
- description = "Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'")
+ description = "Schedule for action on Instance in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'")
private String schedule;
@Parameter(name = ApiConstants.TIMEZONE,
@@ -68,27 +68,27 @@ public class CreateVMScheduleCmd extends BaseCmd {
@Parameter(name = ApiConstants.ACTION,
type = CommandType.STRING,
required = true,
- description = "Action to take on the VM (start/stop/reboot/force_stop/force_reboot).")
+ description = "Action to take on the Instance (start/stop/reboot/force_stop/force_reboot).")
private String action;
@Parameter(name = ApiConstants.START_DATE,
type = CommandType.DATE,
required = false,
- description = "start date from which the schedule becomes active. Defaults to current date plus 1 minute."
+ description = "Start date from which the schedule becomes active. Defaults to current date plus 1 minute."
+ "Use format \"yyyy-MM-dd hh:mm:ss\")")
private Date startDate;
@Parameter(name = ApiConstants.END_DATE,
type = CommandType.DATE,
required = false,
- description = "end date after which the schedule becomes inactive"
+ description = "End date after which the schedule becomes inactive"
+ "Use format \"yyyy-MM-dd hh:mm:ss\")")
private Date endDate;
@Parameter(name = ApiConstants.ENABLED,
type = CommandType.BOOLEAN,
required = false,
- description = "Enable VM schedule. Defaults to true")
+ description = "Enable Instance schedule. Defaults to true")
private Boolean enabled;
/////////////////////////////////////////////////////
@@ -145,7 +145,7 @@ public class CreateVMScheduleCmd extends BaseCmd {
public long getEntityOwnerId() {
VirtualMachine vm = _entityMgr.findById(VirtualMachine.class, getVmId());
if (vm == null) {
- throw new InvalidParameterValueException(String.format("Unable to find VM by id=%d", getVmId()));
+ throw new InvalidParameterValueException(String.format("Unable to find Instance by id=%d", getVmId()));
}
return vm.getAccountId();
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/DeleteVMScheduleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/DeleteVMScheduleCmd.java
index 775a902e0bb..f34d07b045d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/DeleteVMScheduleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/DeleteVMScheduleCmd.java
@@ -37,7 +37,7 @@ import javax.inject.Inject;
import java.util.Collections;
import java.util.List;
-@APICommand(name = "deleteVMSchedule", description = "Delete VM Schedule.", responseObject = SuccessResponse.class,
+@APICommand(name = "deleteVMSchedule", description = "Delete Instance Schedule.", responseObject = SuccessResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false, since = "4.19.0",
authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User})
public class DeleteVMScheduleCmd extends BaseCmd {
@@ -48,20 +48,20 @@ public class DeleteVMScheduleCmd extends BaseCmd {
type = CommandType.UUID,
entityType = UserVmResponse.class,
required = true,
- description = "ID of VM")
+ description = "ID of Instance")
private Long vmId;
@Parameter(name = ApiConstants.ID,
type = CommandType.UUID,
entityType = VMScheduleResponse.class,
required = false,
- description = "ID of VM schedule")
+ description = "ID of Instance schedule")
private Long id;
@Parameter(name = ApiConstants.IDS,
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = VMScheduleResponse.class,
required = false,
- description = "IDs of VM schedule")
+ description = "IDs of Instance schedule")
private List ids;
/////////////////////////////////////////////////////
@@ -97,7 +97,7 @@ public class DeleteVMScheduleCmd extends BaseCmd {
response.setObjectName(VMSchedule.class.getSimpleName().toLowerCase());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to delete VM Schedules");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to delete Instance Schedules");
}
}
@@ -105,7 +105,7 @@ public class DeleteVMScheduleCmd extends BaseCmd {
public long getEntityOwnerId() {
VirtualMachine vm = _entityMgr.findById(VirtualMachine.class, getVmId());
if (vm == null) {
- throw new InvalidParameterValueException(String.format("Unable to find VM by id=%d", getVmId()));
+ throw new InvalidParameterValueException(String.format("Unable to find Instance by id=%d", getVmId()));
}
return vm.getAccountId();
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/DeployVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/DeployVMCmd.java
index 52d42a95d98..e3b7e343623 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/DeployVMCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/DeployVMCmd.java
@@ -77,7 +77,7 @@ import com.cloud.utils.net.NetUtils;
import com.cloud.vm.VirtualMachine;
import com.cloud.vm.VmDetailConstants;
-@APICommand(name = "deployVirtualMachine", description = "Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.", responseObject = UserVmResponse.class, responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
+@APICommand(name = "deployVirtualMachine", description = "Creates and automatically starts an Instance based on a service offering, disk offering, and Template.", responseObject = UserVmResponse.class, responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class DeployVMCmd extends BaseAsyncCreateCustomIdCmd implements SecurityGroupAction, UserCmd {
@@ -87,21 +87,21 @@ public class DeployVMCmd extends BaseAsyncCreateCustomIdCmd implements SecurityG
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, required = true, description = "availability zone for the virtual machine")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, required = true, description = "Availability zone for the Instance")
private Long zoneId;
@ACL
- @Parameter(name = ApiConstants.SERVICE_OFFERING_ID, type = CommandType.UUID, entityType = ServiceOfferingResponse.class, required = true, description = "the ID of the service offering for the virtual machine")
+ @Parameter(name = ApiConstants.SERVICE_OFFERING_ID, type = CommandType.UUID, entityType = ServiceOfferingResponse.class, required = true, description = "The ID of the Service offering for the Instance")
private Long serviceOfferingId;
@ACL
- @Parameter(name = ApiConstants.TEMPLATE_ID, type = CommandType.UUID, entityType = TemplateResponse.class, required = true, description = "the ID of the template for the virtual machine")
+ @Parameter(name = ApiConstants.TEMPLATE_ID, type = CommandType.UUID, entityType = TemplateResponse.class, required = true, description = "The ID of the Template for the Instance")
private Long templateId;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "host name for the virtual machine", validations = {ApiArgValidator.RFCComplianceDomainName})
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "Host name for the Instance", validations = {ApiArgValidator.RFCComplianceDomainName})
private String name;
- @Parameter(name = ApiConstants.DISPLAY_NAME, type = CommandType.STRING, description = "an optional user generated name for the virtual machine")
+ @Parameter(name = ApiConstants.DISPLAY_NAME, type = CommandType.STRING, description = "An optional User generated name for the Instance")
private String displayName;
@Parameter(name=ApiConstants.PASSWORD, type=CommandType.STRING, description="The password of the virtual machine. If null, a random password will be generated for the VM.",
@@ -109,36 +109,36 @@ public class DeployVMCmd extends BaseAsyncCreateCustomIdCmd implements SecurityG
protected String password;
//Owner information
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "an optional account for the virtual machine. Must be used with domainId.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "An optional Account for the Instance. Must be used with domainId.")
private String accountName;
- @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.")
+ @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "An optional domainId for the Instance. If the Account parameter is used, domainId must also be used. If Account is NOT provided then Instance will be assigned to the caller Account and domain.")
private Long domainId;
//Network information
//@ACL(accessType = AccessType.UseEntry)
- @Parameter(name = ApiConstants.NETWORK_IDS, type = CommandType.LIST, collectionType = CommandType.UUID, entityType = NetworkResponse.class, description = "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter")
+ @Parameter(name = ApiConstants.NETWORK_IDS, type = CommandType.LIST, collectionType = CommandType.UUID, entityType = NetworkResponse.class, description = "List of Network IDs used by Instance. Can't be specified with ipToNetworkList parameter")
private List networkIds;
- @Parameter(name = ApiConstants.BOOT_TYPE, type = CommandType.STRING, required = false, description = "Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", since = "4.14.0.0")
+ @Parameter(name = ApiConstants.BOOT_TYPE, type = CommandType.STRING, required = false, description = "Guest Instance Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the Template is marked as deploy-as-is, as we honour what is defined in the Template.", since = "4.14.0.0")
private String bootType;
- @Parameter(name = ApiConstants.BOOT_MODE, type = CommandType.STRING, required = false, description = "Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.", since = "4.14.0.0")
+ @Parameter(name = ApiConstants.BOOT_MODE, type = CommandType.STRING, required = false, description = "Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMWare if the Template is marked as deploy-as-is, as we honour what is defined in the Template.", since = "4.14.0.0")
private String bootMode;
- @Parameter(name = ApiConstants.BOOT_INTO_SETUP, type = CommandType.BOOLEAN, required = false, description = "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", since = "4.15.0.0")
+ @Parameter(name = ApiConstants.BOOT_INTO_SETUP, type = CommandType.BOOLEAN, required = false, description = "Boot into hardware setup or not (ignored if startVm = false, only valid for VMWare)", since = "4.15.0.0")
private Boolean bootIntoSetup;
//DataDisk information
@ACL
- @Parameter(name = ApiConstants.DISK_OFFERING_ID, type = CommandType.UUID, entityType = DiskOfferingResponse.class, description = "the ID of the disk offering for the virtual machine. If the template is of ISO format,"
+ @Parameter(name = ApiConstants.DISK_OFFERING_ID, type = CommandType.UUID, entityType = DiskOfferingResponse.class, description = "The ID of the disk offering for the Instance. If the Template is of ISO format,"
+ " the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the "
+ "offering for the data disk volume. If the templateId parameter passed is from a Template object,"
+ " the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is "
+ "from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.")
private Long diskOfferingId;
- @Parameter(name = ApiConstants.SIZE, type = CommandType.LONG, description = "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId")
+ @Parameter(name = ApiConstants.SIZE, type = CommandType.LONG, description = "The arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId")
private Long size;
@Parameter(name = ApiConstants.ROOT_DISK_SIZE,
@@ -147,15 +147,15 @@ public class DeployVMCmd extends BaseAsyncCreateCustomIdCmd implements SecurityG
since = "4.4")
private Long rootdisksize;
- @Parameter(name = ApiConstants.GROUP, type = CommandType.STRING, description = "an optional group for the virtual machine")
+ @Parameter(name = ApiConstants.GROUP, type = CommandType.STRING, description = "An optional group for the Instance")
private String group;
- @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, description = "the hypervisor on which to deploy the virtual machine. "
+ @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, description = "The hypervisor on which to deploy the Instance. "
+ "The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call")
private String hypervisor;
@Parameter(name = ApiConstants.USER_DATA, type = CommandType.STRING,
- description = "an optional binary data that can be sent to the virtual machine upon a successful deployment. " +
+ description = "An optional binary data that can be sent to the Instance upon a successful deployment. " +
"This binary data must be base64 encoded before adding it to the request. " +
"Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. " +
"Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. " +
@@ -163,104 +163,104 @@ public class DeployVMCmd extends BaseAsyncCreateCustomIdCmd implements SecurityG
length = 1048576)
private String userData;
- @Parameter(name = ApiConstants.USER_DATA_ID, type = CommandType.UUID, entityType = UserDataResponse.class, description = "the ID of the Userdata", since = "4.18")
+ @Parameter(name = ApiConstants.USER_DATA_ID, type = CommandType.UUID, entityType = UserDataResponse.class, description = "The ID of the Userdata", since = "4.18")
private Long userdataId;
- @Parameter(name = ApiConstants.USER_DATA_DETAILS, type = CommandType.MAP, description = "used to specify the parameters values for the variables in userdata.", since = "4.18")
+ @Parameter(name = ApiConstants.USER_DATA_DETAILS, type = CommandType.MAP, description = "Used to specify the parameters values for the variables in userdata.", since = "4.18")
private Map userdataDetails;
@Deprecated
- @Parameter(name = ApiConstants.SSH_KEYPAIR, type = CommandType.STRING, description = "name of the ssh key pair used to login to the virtual machine")
+ @Parameter(name = ApiConstants.SSH_KEYPAIR, type = CommandType.STRING, description = "Name of the SSH key pair used to login to the Instance")
private String sshKeyPairName;
- @Parameter(name = ApiConstants.SSH_KEYPAIRS, type = CommandType.LIST, collectionType = CommandType.STRING, since="4.17", description = "names of the ssh key pairs used to login to the virtual machine")
+ @Parameter(name = ApiConstants.SSH_KEYPAIRS, type = CommandType.LIST, collectionType = CommandType.STRING, since="4.17", description = "Names of the SSH key pairs used to login to the Instance")
private List sshKeyPairNames;
- @Parameter(name = ApiConstants.HOST_ID, type = CommandType.UUID, entityType = HostResponse.class, description = "destination Host ID to deploy the VM to - parameter available for root admin only")
+ @Parameter(name = ApiConstants.HOST_ID, type = CommandType.UUID, entityType = HostResponse.class, description = "Destination Host ID to deploy the Instance to - parameter available for root admin only")
private Long hostId;
@ACL
- @Parameter(name = ApiConstants.SECURITY_GROUP_IDS, type = CommandType.LIST, collectionType = CommandType.UUID, entityType = SecurityGroupResponse.class, description = "comma separated list of security groups id that going to be applied to the virtual machine. "
- + "Should be passed only when vm is created from a zone with Basic Network support." + " Mutually exclusive with securitygroupnames parameter")
+ @Parameter(name = ApiConstants.SECURITY_GROUP_IDS, type = CommandType.LIST, collectionType = CommandType.UUID, entityType = SecurityGroupResponse.class, description = "Comma separated list of security groups id that going to be applied to the Instance. "
+ + "Should be passed only when Instance is created from a zone with Basic Network support." + " Mutually exclusive with securitygroupnames parameter")
private List securityGroupIdList;
@ACL
- @Parameter(name = ApiConstants.SECURITY_GROUP_NAMES, type = CommandType.LIST, collectionType = CommandType.STRING, entityType = SecurityGroupResponse.class, description = "comma separated list of security groups names that going to be applied to the virtual machine."
- + " Should be passed only when vm is created from a zone with Basic Network support. " + "Mutually exclusive with securitygroupids parameter")
+ @Parameter(name = ApiConstants.SECURITY_GROUP_NAMES, type = CommandType.LIST, collectionType = CommandType.STRING, entityType = SecurityGroupResponse.class, description = "Comma separated list of security groups names that going to be applied to the Instance."
+ + " Should be passed only when Instance is created from a zone with Basic Network support. " + "Mutually exclusive with securitygroupids parameter")
private List securityGroupNameList;
- @Parameter(name = ApiConstants.IP_NETWORK_LIST, type = CommandType.MAP, description = "ip to network mapping. Can't be specified with networkIds parameter."
- + " Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid")
+ @Parameter(name = ApiConstants.IP_NETWORK_LIST, type = CommandType.MAP, description = "IP to network mapping. Can't be specified with networkIds parameter."
+ + " Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use IP 10.10.10.11 in network id=uuid")
private Map ipToNetworkList;
- @Parameter(name = ApiConstants.IP_ADDRESS, type = CommandType.STRING, description = "the ip address for default vm's network")
+ @Parameter(name = ApiConstants.IP_ADDRESS, type = CommandType.STRING, description = "The IP address for default Instance's Network")
private String ipAddress;
- @Parameter(name = ApiConstants.IP6_ADDRESS, type = CommandType.STRING, description = "the ipv6 address for default vm's network")
+ @Parameter(name = ApiConstants.IP6_ADDRESS, type = CommandType.STRING, description = "The IPv6 address for default Instance's Network")
private String ip6Address;
- @Parameter(name = ApiConstants.MAC_ADDRESS, type = CommandType.STRING, description = "the mac address for default vm's network")
+ @Parameter(name = ApiConstants.MAC_ADDRESS, type = CommandType.STRING, description = "The MAC address for default Instance's Network")
private String macAddress;
- @Parameter(name = ApiConstants.KEYBOARD, type = CommandType.STRING, description = "an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us")
+ @Parameter(name = ApiConstants.KEYBOARD, type = CommandType.STRING, description = "An optional keyboard device type for the Instance. valid value can be one of de,de-ch,es,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us")
private String keyboard;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "Deploy vm for the project")
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "Deploy Instance for the project")
private Long projectId;
- @Parameter(name = ApiConstants.START_VM, type = CommandType.BOOLEAN, description = "true if start vm after creating; defaulted to true if not specified")
+ @Parameter(name = ApiConstants.START_VM, type = CommandType.BOOLEAN, description = "True if start Instance after creating; defaulted to true if not specified")
private Boolean startVm;
@ACL
- @Parameter(name = ApiConstants.AFFINITY_GROUP_IDS, type = CommandType.LIST, collectionType = CommandType.UUID, entityType = AffinityGroupResponse.class, description = "comma separated list of affinity groups id that are going to be applied to the virtual machine."
+ @Parameter(name = ApiConstants.AFFINITY_GROUP_IDS, type = CommandType.LIST, collectionType = CommandType.UUID, entityType = AffinityGroupResponse.class, description = "Comma separated list of affinity groups id that are going to be applied to the Instance."
+ " Mutually exclusive with affinitygroupnames parameter")
private List affinityGroupIdList;
@ACL
- @Parameter(name = ApiConstants.AFFINITY_GROUP_NAMES, type = CommandType.LIST, collectionType = CommandType.STRING, entityType = AffinityGroupResponse.class, description = "comma separated list of affinity groups names that are going to be applied to the virtual machine."
+ @Parameter(name = ApiConstants.AFFINITY_GROUP_NAMES, type = CommandType.LIST, collectionType = CommandType.STRING, entityType = AffinityGroupResponse.class, description = "Comma separated list of affinity groups names that are going to be applied to the Instance."
+ "Mutually exclusive with affinitygroupids parameter")
private List affinityGroupNameList;
- @Parameter(name = ApiConstants.DISPLAY_VM, type = CommandType.BOOLEAN, since = "4.2", description = "an optional field, whether to the display the vm to the end user or not.", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.DISPLAY_VM, type = CommandType.BOOLEAN, since = "4.2", description = "An optional field, whether to the display the Instance to the end user or not.", authorized = {RoleType.Admin})
private Boolean displayVm;
- @Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, since = "4.3", description = "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details")
+ @Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, since = "4.3", description = "Used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details")
private Map details;
- @Parameter(name = ApiConstants.DEPLOYMENT_PLANNER, type = CommandType.STRING, description = "Deployment planner to use for vm allocation. Available to ROOT admin only", since = "4.4", authorized = { RoleType.Admin })
+ @Parameter(name = ApiConstants.DEPLOYMENT_PLANNER, type = CommandType.STRING, description = "Deployment planner to use for Instance allocation. Available to ROOT admin only", since = "4.4", authorized = { RoleType.Admin })
private String deploymentPlanner;
- @Parameter(name = ApiConstants.DHCP_OPTIONS_NETWORK_LIST, type = CommandType.MAP, description = "DHCP options which are passed to the VM on start up"
+ @Parameter(name = ApiConstants.DHCP_OPTIONS_NETWORK_LIST, type = CommandType.MAP, description = "DHCP options which are passed to the Instance on start up"
+ " Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com")
private Map dhcpOptionsNetworkList;
- @Parameter(name = ApiConstants.DATADISK_OFFERING_LIST, type = CommandType.MAP, since = "4.11", description = "datadisk template to disk-offering mapping;" +
- " an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter")
+ @Parameter(name = ApiConstants.DATADISK_OFFERING_LIST, type = CommandType.MAP, since = "4.11", description = "Datadisk Template to disk-offering mapping;" +
+ " an optional parameter used to create additional data disks from datadisk Templates; can't be specified with diskOfferingId parameter")
private Map dataDiskTemplateToDiskOfferingList;
- @Parameter(name = ApiConstants.EXTRA_CONFIG, type = CommandType.STRING, since = "4.12", description = "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", length = 5120)
+ @Parameter(name = ApiConstants.EXTRA_CONFIG, type = CommandType.STRING, since = "4.12", description = "An optional URL encoded string that can be passed to the Instance upon successful deployment", length = 5120)
private String extraConfig;
- @Parameter(name = ApiConstants.COPY_IMAGE_TAGS, type = CommandType.BOOLEAN, since = "4.13", description = "if true the image tags (if any) will be copied to the VM, default value is false")
+ @Parameter(name = ApiConstants.COPY_IMAGE_TAGS, type = CommandType.BOOLEAN, since = "4.13", description = "If true the image tags (if any) will be copied to the Instance, default value is false")
private Boolean copyImageTags;
@Parameter(name = ApiConstants.PROPERTIES, type = CommandType.MAP, since = "4.15",
- description = "used to specify the vApp properties.")
+ description = "Used to specify the vApp properties.")
@LogLevel(LogLevel.Log4jLevel.Off)
private Map vAppProperties;
@Parameter(name = ApiConstants.NIC_NETWORK_LIST, type = CommandType.MAP, since = "4.15",
- description = "VMware only: used to specify network mapping of a vApp VMware template registered \"as-is\"." +
+ description = "VMware only: used to specify network mapping of a vApp VMware Template registered \"as-is\"." +
" Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid")
@LogLevel(LogLevel.Log4jLevel.Off)
private Map vAppNetworks;
@Parameter(name = ApiConstants.DYNAMIC_SCALING_ENABLED, type = CommandType.BOOLEAN, since = "4.16",
- description = "true if virtual machine needs to be dynamically scalable")
+ description = "True if Instance needs to be dynamically scalable")
protected Boolean dynamicScalingEnabled;
- @Parameter(name = ApiConstants.OVERRIDE_DISK_OFFERING_ID, type = CommandType.UUID, since = "4.17", entityType = DiskOfferingResponse.class, description = "the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering." +
- "In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id")
+ @Parameter(name = ApiConstants.OVERRIDE_DISK_OFFERING_ID, type = CommandType.UUID, since = "4.17", entityType = DiskOfferingResponse.class, description = "The ID of the disk offering for the Instance to be used for root volume instead of the disk offering mapped in service offering." +
+ "In case of Instance deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id")
private Long overrideDiskOfferingId;
@Parameter(name = ApiConstants.IOTHREADS_ENABLED, type = CommandType.BOOLEAN, required = false,
@@ -314,7 +314,7 @@ public class DeployVMCmd extends BaseAsyncCreateCustomIdCmd implements SecurityG
String type = bootType.trim().toUpperCase();
return ApiConstants.BootType.valueOf(type);
} catch (IllegalArgumentException e) {
- String errMesg = "Invalid bootType " + bootType + "Specified for vm " + getName()
+ String errMesg = "Invalid bootType " + bootType + "Specified for Instance " + getName()
+ " Valid values are: " + Arrays.toString(ApiConstants.BootType.values());
logger.warn(errMesg);
throw new InvalidParameterValueException(errMesg);
@@ -361,14 +361,14 @@ public class DeployVMCmd extends BaseAsyncCreateCustomIdCmd implements SecurityG
String mode = bootMode.trim().toUpperCase();
return ApiConstants.BootMode.valueOf(mode);
} catch (IllegalArgumentException e) {
- String msg = String.format("Invalid %s: %s specified for VM: %s. Valid values are: %s",
+ String msg = String.format("Invalid %s: %s specified for Instance: %s. Valid values are: %s",
ApiConstants.BOOT_MODE, bootMode, getName(), Arrays.toString(ApiConstants.BootMode.values()));
logger.error(msg);
throw new InvalidParameterValueException(msg);
}
}
if (ApiConstants.BootType.UEFI.equals(getBootType())) {
- String msg = String.format("%s must be specified for the VM with boot type: %s. Valid values are: %s",
+ String msg = String.format("%s must be specified for the Instance with boot type: %s. Valid values are: %s",
ApiConstants.BOOT_MODE, getBootType(), Arrays.toString(ApiConstants.BootMode.values()));
logger.error(msg);
throw new InvalidParameterValueException(msg);
@@ -713,7 +713,7 @@ public class DeployVMCmd extends BaseAsyncCreateCustomIdCmd implements SecurityG
String policyType = ioDriverPolicy.trim().toUpperCase();
return ApiConstants.IoDriverPolicy.valueOf(policyType);
} catch (IllegalArgumentException e) {
- String errMesg = String.format("Invalid io policy %s specified for vm %s. Valid values are: %s", ioDriverPolicy, getName(), Arrays.toString(ApiConstants.IoDriverPolicy.values()));
+ String errMesg = String.format("Invalid I/O policy %s specified for Instance %s. Valid values are: %s", ioDriverPolicy, getName(), Arrays.toString(ApiConstants.IoDriverPolicy.values()));
logger.warn(errMesg);
throw new InvalidParameterValueException(errMesg);
}
@@ -755,15 +755,15 @@ public class DeployVMCmd extends BaseAsyncCreateCustomIdCmd implements SecurityG
@Override
public String getCreateEventDescription() {
- return "creating Vm";
+ return "creating Instance";
}
@Override
public String getEventDescription() {
if(getStartVm()) {
- return "starting Vm. Vm Id: " + getEntityUuid();
+ return "starting Instance. Instance Id: " + getEntityUuid();
}
- return "deploying Vm. Vm Id: " + getEntityUuid();
+ return "deploying Instance. Instance Id: " + getEntityUuid();
}
@Override
@@ -775,7 +775,7 @@ public class DeployVMCmd extends BaseAsyncCreateCustomIdCmd implements SecurityG
public void execute() {
UserVm result;
- CallContext.current().setEventDetails("Vm Id: " + getEntityUuid());
+ CallContext.current().setEventDetails("Instance Id: " + getEntityUuid());
if (getStartVm()) {
try {
result = _userVmService.startVirtualMachine(this);
@@ -800,7 +800,7 @@ public class DeployVMCmd extends BaseAsyncCreateCustomIdCmd implements SecurityG
throw new ServerApiException(ApiErrorCode.INSUFFICIENT_CAPACITY_ERROR, message.toString());
}
} else {
- logger.info("VM " + getEntityUuid() + " already created, load UserVm from DB");
+ logger.info("Instance " + getEntityUuid() + " already created, load UserVm from DB");
result = _userVmService.finalizeCreateVirtualMachine(getEntityId());
}
@@ -809,7 +809,7 @@ public class DeployVMCmd extends BaseAsyncCreateCustomIdCmd implements SecurityG
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to deploy vm uuid:"+getEntityUuid());
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to deploy Instance UUID:"+getEntityUuid());
}
}
@@ -823,7 +823,7 @@ public class DeployVMCmd extends BaseAsyncCreateCustomIdCmd implements SecurityG
setEntityId(vm.getId());
setEntityUuid(vm.getUuid());
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to deploy vm");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to deploy Instance");
}
} catch (InsufficientCapacityException ex) {
logger.info(ex);
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/DestroyVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/DestroyVMCmd.java
index aa121162cb4..1ca73c0cb3c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/DestroyVMCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/DestroyVMCmd.java
@@ -41,7 +41,7 @@ import com.cloud.user.Account;
import com.cloud.uservm.UserVm;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "destroyVirtualMachine", description = "Destroys a virtual machine.", responseObject = UserVmResponse.class, responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
+@APICommand(name = "destroyVirtualMachine", description = "Destroys an Instance.", responseObject = UserVmResponse.class, responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false,
responseHasSensitiveInfo = true)
public class DestroyVMCmd extends BaseAsyncCmd implements UserCmd {
@@ -54,12 +54,12 @@ public class DestroyVMCmd extends BaseAsyncCmd implements UserCmd {
@ACL(accessType = AccessType.OperateEntry)
@Parameter(name=ApiConstants.ID, type=CommandType.UUID, entityType=UserVmResponse.class,
- required=true, description="The ID of the virtual machine")
+ required=true, description = "The ID of the Instance")
private Long id;
@Parameter(name = ApiConstants.EXPUNGE,
type = CommandType.BOOLEAN,
- description = "If true is passed, the vm is expunged immediately. False by default.",
+ description = "If true is passed, the Instance is expunged immediately. False by default.",
since = "4.2.1")
private Boolean expunge;
@@ -116,7 +116,7 @@ public class DestroyVMCmd extends BaseAsyncCmd implements UserCmd {
@Override
public String getEventDescription() {
- return "destroying vm: " + this._uuidMgr.getUuid(VirtualMachine.class, getId());
+ return "destroying Instance: " + this._uuidMgr.getUuid(VirtualMachine.class, getId());
}
@Override
@@ -140,10 +140,11 @@ public class DestroyVMCmd extends BaseAsyncCmd implements UserCmd {
if (responses != null && !responses.isEmpty()) {
response = responses.get(0);
}
- response.setResponseName("virtualmachine");
+ response.setResponseName(getCommandName());
+ response.setObjectName("virtualmachine");
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to destroy vm");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to destroy Instance");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/GetVMPasswordCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/GetVMPasswordCmd.java
index 11534fd4375..d2e6ef9e742 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/GetVMPasswordCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/GetVMPasswordCmd.java
@@ -30,7 +30,7 @@ import com.cloud.user.Account;
import com.cloud.uservm.UserVm;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "getVMPassword", responseObject = GetVMPasswordResponse.class, description = "Returns an encrypted password for the VM", entityType = {VirtualMachine.class},
+@APICommand(name = "getVMPassword", responseObject = GetVMPasswordResponse.class, description = "Returns an encrypted password for the Instance", entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class GetVMPasswordCmd extends BaseCmd {
@@ -40,7 +40,7 @@ public class GetVMPasswordCmd extends BaseCmd {
@ACL(accessType = AccessType.OperateEntry)
@Parameter(name=ApiConstants.ID, type=CommandType.UUID, entityType=UserVmResponse.class
- , required=true, description="The ID of the virtual machine")
+ , required=true, description = "The ID of the Instance")
private Long id;
/////////////////////////////////////////////////////
@@ -59,7 +59,7 @@ public class GetVMPasswordCmd extends BaseCmd {
public void execute() {
String passwd = _mgr.getVMPassword(this);
if (passwd == null || passwd.equals(""))
- throw new InvalidParameterValueException("No password for VM with id '" + getId() + "' found.");
+ throw new InvalidParameterValueException("No password for Instance with ID '" + getId() + "' found.");
setResponseObject(new GetVMPasswordResponse(getCommandName(), passwd));
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ListNicsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ListNicsCmd.java
index 0e659fc02a1..7d2b27e7ac5 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ListNicsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ListNicsCmd.java
@@ -41,7 +41,7 @@ import com.cloud.exception.ResourceUnavailableException;
import com.cloud.user.Account;
import com.cloud.vm.Nic;
-@APICommand(name = "listNics", description = "list the vm nics IP to NIC", responseObject = NicResponse.class,
+@APICommand(name = "listNics", description = "List the Instance NICs IP to NIC", responseObject = NicResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListNicsCmd extends BaseListCmd {
@@ -49,16 +49,16 @@ public class ListNicsCmd extends BaseListCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.NIC_ID, type = CommandType.UUID, entityType = NicResponse.class, required = false, description = "the ID of the nic to list IPs")
+ @Parameter(name = ApiConstants.NIC_ID, type = CommandType.UUID, entityType = NicResponse.class, required = false, description = "The ID of the NIC to list IPs")
private Long nicId;
- @Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID, type = CommandType.UUID, entityType = UserVmResponse.class, required = true, description = "the ID of the vm")
+ @Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID, type = CommandType.UUID, entityType = UserVmResponse.class, required = true, description = "The ID of the Instance")
private Long vmId;
- @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "list nic of the specific vm's network")
+ @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "List NIC of the specific Instance's Network")
private Long networkId;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "list resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "List resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
/////////////////////////////////////////////////////
@@ -155,7 +155,7 @@ public class ListNicsCmd extends BaseListCmd {
this.setResponseObject(response);
}
} catch (Exception e) {
- logger.warn("Failed to list secondary ip address per nic ");
+ logger.warn("Failed to list secondary ip address per NIC");
throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, e.getMessage());
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ListVMScheduleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ListVMScheduleCmd.java
index 3474f1ddcaa..be94315abe7 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ListVMScheduleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ListVMScheduleCmd.java
@@ -31,7 +31,7 @@ import org.apache.cloudstack.vm.schedule.VMScheduleManager;
import javax.inject.Inject;
-@APICommand(name = "listVMSchedule", description = "List VM Schedules.", responseObject = VMScheduleResponse.class,
+@APICommand(name = "listVMSchedule", description = "List Instance Schedules.", responseObject = VMScheduleResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false, since = "4.19.0",
authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User})
public class ListVMScheduleCmd extends BaseListCmd {
@@ -42,14 +42,14 @@ public class ListVMScheduleCmd extends BaseListCmd {
type = CommandType.UUID,
entityType = UserVmResponse.class,
required = true,
- description = "ID of the VM for which schedule is to be defined")
+ description = "ID of the Instance for which schedule is to be defined")
private Long vmId;
@Parameter(name = ApiConstants.ID,
type = CommandType.UUID,
entityType = VMScheduleResponse.class,
required = false,
- description = "ID of VM schedule")
+ description = "ID of Instance schedule")
private Long id;
@Parameter(name = ApiConstants.ACTION,
@@ -61,7 +61,7 @@ public class ListVMScheduleCmd extends BaseListCmd {
@Parameter(name = ApiConstants.ENABLED,
type = CommandType.BOOLEAN,
required = false,
- description = "ID of VM schedule")
+ description = "ID of Instance schedule")
private Boolean enabled;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ListVMsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ListVMsCmd.java
index c205b357732..397669995ce 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ListVMsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ListVMsCmd.java
@@ -57,7 +57,7 @@ import com.cloud.server.ResourceTag;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "listVirtualMachines", description = "List the virtual machines owned by the account.", responseObject = UserVmResponse.class, responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
+@APICommand(name = "listVirtualMachines", description = "List the Instances owned by the Account.", responseObject = UserVmResponse.class, responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class ListVMsCmd extends BaseListRetrieveOnlyResourceCountCmd implements UserCmd {
@@ -66,90 +66,90 @@ public class ListVMsCmd extends BaseListRetrieveOnlyResourceCountCmd implements
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.GROUP_ID, type = CommandType.UUID, entityType = InstanceGroupResponse.class, description = "the group ID")
+ @Parameter(name = ApiConstants.GROUP_ID, type = CommandType.UUID, entityType = InstanceGroupResponse.class, description = "The group ID")
private Long groupId;
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = UserVmResponse.class, description = "the ID of the virtual machine")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = UserVmResponse.class, description = "The ID of the Instance")
private Long id;
- @Parameter(name=ApiConstants.IDS, type=CommandType.LIST, collectionType=CommandType.UUID, entityType=UserVmResponse.class, description="the IDs of the virtual machines, mutually exclusive with id", since = "4.4")
+ @Parameter(name=ApiConstants.IDS, type=CommandType.LIST, collectionType=CommandType.UUID, entityType=UserVmResponse.class, description = "The IDs of the Instances, mutually exclusive with id", since = "4.4")
private List ids;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "Name of the Instance (a substring match is made against the parameter value, data for all matching Instances will be returned)")
private String name;
- @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "state of the virtual machine. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.")
+ @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "State of the Instance. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.")
private String state;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "the availability zone ID")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "The availability zone ID")
private Long zoneId;
@Parameter(name = ApiConstants.FOR_VIRTUAL_NETWORK,
type = CommandType.BOOLEAN,
- description = "list by network type; true if need to list vms using Virtual Network, false otherwise")
+ description = "List by Network type; true if need to list Instances using Virtual Network, false otherwise")
private Boolean forVirtualNetwork;
- @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "list by network id")
+ @Parameter(name = ApiConstants.NETWORK_ID, type = CommandType.UUID, entityType = NetworkResponse.class, description = "List by Network ID")
private Long networkId;
- @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, description = "the target hypervisor for the template")
+ @Parameter(name = ApiConstants.HYPERVISOR, type = CommandType.STRING, description = "The target hypervisor for the Template")
private String hypervisor;
@Parameter(name = ApiConstants.DETAILS,
type = CommandType.LIST,
collectionType = CommandType.STRING,
- description = "comma separated list of vm details requested, "
+ description = "Comma separated list of Instance details requested, "
+ "value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]."
+ " When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default),"
+ " otherwise when list.vm.default.details.stats is false the API response will exclude the stats details.")
private List viewDetails;
- @Parameter(name = ApiConstants.TEMPLATE_ID, type = CommandType.UUID, entityType = TemplateResponse.class, description = "list vms by template")
+ @Parameter(name = ApiConstants.TEMPLATE_ID, type = CommandType.UUID, entityType = TemplateResponse.class, description = "List Instances by Template")
private Long templateId;
- @Parameter(name = ApiConstants.ISO_ID, type = CommandType.UUID, entityType = IsoVmResponse.class, description = "list vms by iso")
+ @Parameter(name = ApiConstants.ISO_ID, type = CommandType.UUID, entityType = IsoVmResponse.class, description = "List Instances by ISO")
private Long isoId;
- @Parameter(name = ApiConstants.VPC_ID, type = CommandType.UUID, entityType = VpcResponse.class, description = "list vms by vpc")
+ @Parameter(name = ApiConstants.VPC_ID, type = CommandType.UUID, entityType = VpcResponse.class, description = "List Instances by VPC")
private Long vpcId;
- @Parameter(name = ApiConstants.AFFINITY_GROUP_ID, type = CommandType.UUID, entityType = AffinityGroupResponse.class, description = "list vms by affinity group")
+ @Parameter(name = ApiConstants.AFFINITY_GROUP_ID, type = CommandType.UUID, entityType = AffinityGroupResponse.class, description = "List Instances by affinity group")
private Long affinityGroupId;
- @Parameter(name = ApiConstants.SSH_KEYPAIR, type = CommandType.STRING, description = "list vms by ssh keypair name")
+ @Parameter(name = ApiConstants.SSH_KEYPAIR, type = CommandType.STRING, description = "List Instances by SSH keypair name")
private String keypair;
- @Parameter(name = ApiConstants.SERVICE_OFFERING_ID, type = CommandType.UUID, entityType = ServiceOfferingResponse.class, description = "list by the service offering", since = "4.4")
+ @Parameter(name = ApiConstants.SERVICE_OFFERING_ID, type = CommandType.UUID, entityType = ServiceOfferingResponse.class, description = "List by the service offering", since = "4.4")
private Long serviceOffId;
- @Parameter(name = ApiConstants.BACKUP_OFFERING_ID, type = CommandType.UUID, entityType = BackupOfferingResponse.class, description = "list by the backup offering", since = "4.17")
+ @Parameter(name = ApiConstants.BACKUP_OFFERING_ID, type = CommandType.UUID, entityType = BackupOfferingResponse.class, description = "List by the backup offering", since = "4.17")
private Long backupOffId;
- @Parameter(name = ApiConstants.DISPLAY_VM, type = CommandType.BOOLEAN, description = "list resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.DISPLAY_VM, type = CommandType.BOOLEAN, description = "List resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
- @Parameter(name = ApiConstants.USER_ID, type = CommandType.UUID, entityType = UserResponse.class, required = false, description = "the user ID that created the VM and is under the account that owns the VM")
+ @Parameter(name = ApiConstants.USER_ID, type = CommandType.UUID, entityType = UserResponse.class, required = false, description = "The user ID that created the Instance and is under the Account that owns the Instance")
private Long userId;
- @Parameter(name = ApiConstants.SECURITY_GROUP_ID, type = CommandType.UUID, entityType = SecurityGroupResponse.class, description = "the security group ID", since = "4.15")
+ @Parameter(name = ApiConstants.SECURITY_GROUP_ID, type = CommandType.UUID, entityType = SecurityGroupResponse.class, description = "The security group ID", since = "4.15")
private Long securityGroupId;
- @Parameter(name = ApiConstants.HA_ENABLE, type = CommandType.BOOLEAN, description = "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", since = "4.15")
+ @Parameter(name = ApiConstants.HA_ENABLE, type = CommandType.BOOLEAN, description = "List by the High Availability offering; true if filtering Instances with HA enabled; false for Instances with HA disabled", since = "4.15")
private Boolean haEnabled;
- @Parameter(name = ApiConstants.AUTOSCALE_VMGROUP_ID, type = CommandType.UUID, entityType = AutoScaleVmGroupResponse.class, description = "the ID of AutoScaling VM Group", since = "4.18.0")
+ @Parameter(name = ApiConstants.AUTOSCALE_VMGROUP_ID, type = CommandType.UUID, entityType = AutoScaleVmGroupResponse.class, description = "The ID of AutoScaling Instance Group", since = "4.18.0")
private Long autoScaleVmGroupId;
@Parameter(name = ApiConstants.SHOW_RESOURCE_ICON, type = CommandType.BOOLEAN,
- description = "flag to display the resource icon for VMs", since = "4.16.0.0")
+ description = "Flag to display the resource icon for Instances", since = "4.16.0.0")
private Boolean showIcon;
@Parameter(name = ApiConstants.ACCUMULATE, type = CommandType.BOOLEAN,
- description = "Accumulates the VM metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.",
+ description = "Accumulates the Instance metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.",
since = "4.17.0")
private Boolean accumulate;
- @Parameter(name = ApiConstants.USER_DATA, type = CommandType.BOOLEAN, description = "Whether to return the VMs' user data or not. By default, user data will not be returned.", since = "4.18.0.0")
+ @Parameter(name = ApiConstants.USER_DATA, type = CommandType.BOOLEAN, description = "Whether to return the Instances' User data or not. By default, User data will not be returned.", since = "4.18.0.0")
private Boolean showUserData;
@Parameter(name = ApiConstants.USER_DATA_ID, type = CommandType.UUID, entityType = UserDataResponse.class, required = false, description = "the instances by userdata", since = "4.20.1")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/RebootVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/RebootVMCmd.java
index 153f5ea6563..32756755f39 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/RebootVMCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/RebootVMCmd.java
@@ -39,7 +39,7 @@ import com.cloud.user.Account;
import com.cloud.uservm.UserVm;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "rebootVirtualMachine", description = "Reboots a virtual machine.", responseObject = UserVmResponse.class, responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
+@APICommand(name = "rebootVirtualMachine", description = "Reboots an Instance.", responseObject = UserVmResponse.class, responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class RebootVMCmd extends BaseAsyncCmd implements UserCmd {
private static final String s_name = "rebootvirtualmachineresponse";
@@ -49,10 +49,10 @@ public class RebootVMCmd extends BaseAsyncCmd implements UserCmd {
/////////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
@Parameter(name=ApiConstants.ID, type=CommandType.UUID, entityType=UserVmResponse.class,
- required=true, description="The ID of the virtual machine")
+ required=true, description = "The ID of the Instance")
private Long id;
- @Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN, required = false, description = "Force reboot the VM (VM is Stopped and then Started)", since = "4.16.0")
+ @Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN, required = false, description = "Force reboot the Instance (It is Stopped and then Started)", since = "4.16.0")
private Boolean forced;
@Parameter(name = ApiConstants.BOOT_INTO_SETUP, type = CommandType.BOOLEAN, required = false, description = "Boot into hardware setup menu or not", since = "4.15.0.0")
@@ -100,7 +100,7 @@ public class RebootVMCmd extends BaseAsyncCmd implements UserCmd {
@Override
public String getEventDescription() {
- return "rebooting user vm: " + this._uuidMgr.getUuid(VirtualMachine.class, getId());
+ return "Rebooting User Instance: " + this._uuidMgr.getUuid(VirtualMachine.class, getId());
}
@Override
@@ -123,7 +123,7 @@ public class RebootVMCmd extends BaseAsyncCmd implements UserCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to reboot vm instance");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to reboot Instance");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/RemoveIpFromVmNicCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/RemoveIpFromVmNicCmd.java
index 2f53c3d4e4c..09c84fdbb38 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/RemoveIpFromVmNicCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/RemoveIpFromVmNicCmd.java
@@ -48,7 +48,7 @@ public class RemoveIpFromVmNicCmd extends BaseAsyncCmd {
type = CommandType.UUID,
required = true,
entityType = NicSecondaryIpResponse.class,
- description = "the ID of the secondary ip address to nic")
+ description = "The ID of the secondary ip address to NIC")
private Long id;
// unexposed parameter needed for events logging
@@ -159,10 +159,10 @@ public class RemoveIpFromVmNicCmd extends BaseAsyncCmd {
SuccessResponse response = new SuccessResponse(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to remove secondary ip address for the nic");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to remove secondary IP address for the NIC");
}
} catch (InvalidParameterValueException e) {
- throw new InvalidParameterValueException("Removing guest ip from nic failed");
+ throw new InvalidParameterValueException("Removing guest IP from NIC failed");
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/RemoveNicFromVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/RemoveNicFromVMCmd.java
index d9024f34022..8a891e824ee 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/RemoveNicFromVMCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/RemoveNicFromVMCmd.java
@@ -41,7 +41,7 @@ import com.cloud.user.Account;
import com.cloud.uservm.UserVm;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "removeNicFromVirtualMachine", description = "Removes VM from specified network by deleting a NIC", responseObject = UserVmResponse.class, responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
+@APICommand(name = "removeNicFromVirtualMachine", description = "Removes Instance from specified Network by deleting a NIC", responseObject = UserVmResponse.class, responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class RemoveNicFromVMCmd extends BaseAsyncCmd implements UserCmd {
private static final String s_name = "removenicfromvirtualmachineresponse";
@@ -51,7 +51,7 @@ public class RemoveNicFromVMCmd extends BaseAsyncCmd implements UserCmd {
/////////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
@Parameter(name=ApiConstants.VIRTUAL_MACHINE_ID, type=CommandType.UUID, entityType=UserVmResponse.class,
- required=true, description="Virtual Machine ID")
+ required=true, description = "Instance ID")
private Long vmId;
@Parameter(name = ApiConstants.NIC_ID, type = CommandType.UUID, entityType = NicResponse.class, required = true, description = "NIC ID")
@@ -89,7 +89,7 @@ public class RemoveNicFromVMCmd extends BaseAsyncCmd implements UserCmd {
@Override
public String getEventDescription() {
- return "Removing NIC " + this._uuidMgr.getUuid(Nic.class, getNicId()) + " from user vm: " + this._uuidMgr.getUuid(VirtualMachine.class, getVmId());
+ return "Removing NIC " + this._uuidMgr.getUuid(Nic.class, getNicId()) + " from User Instance: " + this._uuidMgr.getUuid(VirtualMachine.class, getVmId());
}
@Override
@@ -113,7 +113,7 @@ public class RemoveNicFromVMCmd extends BaseAsyncCmd implements UserCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to remove NIC from vm, see error log for details");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to remove NIC from Instance, see error log for details");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ResetVMPasswordCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ResetVMPasswordCmd.java
index 7270004aeed..dbf11de8325 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ResetVMPasswordCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ResetVMPasswordCmd.java
@@ -39,8 +39,8 @@ import com.cloud.user.Account;
import com.cloud.uservm.UserVm;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "resetPasswordForVirtualMachine", responseObject=UserVmResponse.class, description="Resets the password for virtual machine. " +
- "The virtual machine must be in a \"Stopped\" state and the template must already " +
+@APICommand(name = "resetPasswordForVirtualMachine", responseObject=UserVmResponse.class, description = "Resets the password for the Instance. " +
+ "The Instance must be in a \"Stopped\" state and the Template must already " +
"support this feature for this command to take effect. [async]", responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class ResetVMPasswordCmd extends BaseAsyncCmd implements UserCmd {
@@ -52,7 +52,7 @@ public class ResetVMPasswordCmd extends BaseAsyncCmd implements UserCmd {
/////////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
@Parameter(name=ApiConstants.ID, type=CommandType.UUID, entityType=UserVmResponse.class,
- required=true, description="The ID of the virtual machine")
+ required=true, description = "The ID of the Instance")
private Long id;
@Parameter(name=ApiConstants.PASSWORD, type=CommandType.STRING, description="The new password of the virtual machine. If null, a random password will be generated for the VM.", since="4.19.0")
@@ -101,7 +101,7 @@ public class ResetVMPasswordCmd extends BaseAsyncCmd implements UserCmd {
@Override
public String getEventDescription() {
- return "resetting password for vm: " + getId();
+ return "resetting password for Instance: " + getId();
}
@Override
@@ -131,7 +131,7 @@ public class ResetVMPasswordCmd extends BaseAsyncCmd implements UserCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to reset vm password");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to reset Instance password");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ResetVMSSHKeyCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ResetVMSSHKeyCmd.java
index a4019411e1d..530677edf38 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ResetVMSSHKeyCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ResetVMSSHKeyCmd.java
@@ -44,8 +44,8 @@ import com.cloud.vm.VirtualMachine;
import java.util.ArrayList;
import java.util.List;
-@APICommand(name = "resetSSHKeyForVirtualMachine", responseObject = UserVmResponse.class, description = "Resets the SSH Key for virtual machine. " +
- "The virtual machine must be in a \"Stopped\" state. [async]", responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
+@APICommand(name = "resetSSHKeyForVirtualMachine", responseObject = UserVmResponse.class, description = "Resets the SSH Key for the Instance. " +
+ "The Instance must be in a \"Stopped\" state. [async]", responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class ResetVMSSHKeyCmd extends BaseAsyncCmd implements UserCmd {
@@ -56,27 +56,27 @@ public class ResetVMSSHKeyCmd extends BaseAsyncCmd implements UserCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = UserVmResponse.class, required = true, description = "The ID of the virtual machine")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = UserVmResponse.class, required = true, description = "The ID of the Instance")
private Long id;
@Deprecated
- @Parameter(name = ApiConstants.SSH_KEYPAIR, type = CommandType.STRING ,description = "name of the ssh key pair used to login to the virtual machine")
+ @Parameter(name = ApiConstants.SSH_KEYPAIR, type = CommandType.STRING ,description = "Name of the SSH key pair used to login to the Instance")
String name;
- @Parameter(name = ApiConstants.SSH_KEYPAIRS, type = CommandType.LIST, collectionType = CommandType.STRING, since="4.17", description = "names of the ssh key pairs to be used to login to the virtual machine")
+ @Parameter(name = ApiConstants.SSH_KEYPAIRS, type = CommandType.LIST, collectionType = CommandType.STRING, since="4.17", description = "Names of the SSH key pairs to be used to login to the Instance")
List names;
//Owner information
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "an optional account for the ssh key. Must be used with domainId.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "An optional Account for the SSH key. Must be used with domainId.")
private String accountName;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.")
+ description = "An optional domainId for the Instance. If the Account parameter is used, domainId must also be used.")
private Long domainId;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "an optional project for the ssh key")
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "An optional project for the SSH key")
private Long projectId;
/////////////////////////////////////////////////////
@@ -121,7 +121,7 @@ public class ResetVMSSHKeyCmd extends BaseAsyncCmd implements UserCmd {
@Override
public String getEventDescription() {
- return "resetting SSHKey for vm: " + getId();
+ return "resetting SSHKey for Instance: " + getId();
}
@Override
@@ -160,7 +160,7 @@ public class ResetVMSSHKeyCmd extends BaseAsyncCmd implements UserCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to reset vm SSHKey");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to reset SSHKey");
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ResetVMUserDataCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ResetVMUserDataCmd.java
index 0ecf4ff1384..9fb60b537c5 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ResetVMUserDataCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ResetVMUserDataCmd.java
@@ -40,8 +40,8 @@ import org.apache.cloudstack.context.CallContext;
import java.util.Map;
-@APICommand(name = "resetUserDataForVirtualMachine", responseObject = UserVmResponse.class, description = "Resets the UserData for virtual machine. " +
- "The virtual machine must be in a \"Stopped\" state.", responseView = ResponseObject.ResponseView.Restricted, entityType = {VirtualMachine.class},
+@APICommand(name = "resetUserDataForVirtualMachine", responseObject = UserVmResponse.class, description = "Resets the UserData for Instance. " +
+ "The Instance must be in a \"Stopped\" state.", responseView = ResponseObject.ResponseView.Restricted, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true, since = "4.18.0")
public class ResetVMUserDataCmd extends BaseCmd implements UserCmd {
@@ -52,12 +52,12 @@ public class ResetVMUserDataCmd extends BaseCmd implements UserCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
@ACL(accessType = SecurityChecker.AccessType.OperateEntry)
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = UserVmResponse.class, required = true, description = "The ID of the virtual machine")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = UserVmResponse.class, required = true, description = "The ID of the Instance")
private Long id;
@Parameter(name = ApiConstants.USER_DATA,
type = CommandType.STRING,
- description = "an optional binary data that can be sent to the virtual machine upon a successful deployment. " +
+ description = "An optional binary data that can be sent to the Instance upon a successful deployment. " +
"This binary data must be base64 encoded before adding it to the request. " +
"Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. " +
"Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. " +
@@ -65,23 +65,23 @@ public class ResetVMUserDataCmd extends BaseCmd implements UserCmd {
length = 1048576)
private String userData;
- @Parameter(name = ApiConstants.USER_DATA_ID, type = CommandType.UUID, entityType = UserDataResponse.class, description = "the ID of the userdata")
+ @Parameter(name = ApiConstants.USER_DATA_ID, type = CommandType.UUID, entityType = UserDataResponse.class, description = "The ID of the userdata")
private Long userdataId;
- @Parameter(name = ApiConstants.USER_DATA_DETAILS, type = CommandType.MAP, description = "used to specify the parameters values for the variables in userdata.")
+ @Parameter(name = ApiConstants.USER_DATA_DETAILS, type = CommandType.MAP, description = "Used to specify the parameters values for the variables in userdata.")
private Map userdataDetails;
//Owner information
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "an optional account for the virtual machine. Must be used with domainId.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "An optional Account for the Instance. Must be used with domainId.")
private String accountName;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.")
+ description = "An optional domainId for the Instance. If the Account parameter is used, domainId must also be used.")
private Long domainId;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "an optional project for the virtual machine")
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "An optional project for the Instance")
private Long projectId;
/////////////////////////////////////////////////////
@@ -151,7 +151,7 @@ public class ResetVMUserDataCmd extends BaseCmd implements UserCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to reset vm SSHKey");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to reset SSHKey");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/RestoreVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/RestoreVMCmd.java
index 3839049eee5..b92b2d1b3c1 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/RestoreVMCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/RestoreVMCmd.java
@@ -44,7 +44,7 @@ import com.cloud.vm.VirtualMachine;
import java.util.Map;
-@APICommand(name = "restoreVirtualMachine", description = "Restore a VM to original template/ISO or new template/ISO", responseObject = UserVmResponse.class, since = "3.0.0", responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
+@APICommand(name = "restoreVirtualMachine", description = "Restore an Instance to original Template/ISO or new Template/ISO", responseObject = UserVmResponse.class, since = "3.0.0", responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false,
responseHasSensitiveInfo = true)
public class RestoreVMCmd extends BaseAsyncCmd implements UserCmd {
@@ -52,13 +52,13 @@ public class RestoreVMCmd extends BaseAsyncCmd implements UserCmd {
@ACL(accessType = AccessType.OperateEntry)
@Parameter(name=ApiConstants.VIRTUAL_MACHINE_ID, type=CommandType.UUID, entityType=UserVmResponse.class,
- required=true, description="Virtual Machine ID")
+ required=true, description = "Instance ID")
private Long vmId;
@Parameter(name = ApiConstants.TEMPLATE_ID,
type = CommandType.UUID,
entityType = TemplateResponse.class,
- description = "an optional template Id to restore vm from the new template. This can be an ISO id in case of restore vm deployed using ISO")
+ description = "An optional Template Id to restore Instance from the new Template. This can be an ISO id in case of restore Instance deployed using ISO")
private Long templateId;
@Parameter(name = ApiConstants.DISK_OFFERING_ID,
@@ -90,7 +90,7 @@ public class RestoreVMCmd extends BaseAsyncCmd implements UserCmd {
@Override
public String getEventDescription() {
- return "Restore a VM to original template or specific snapshot";
+ return "Restore an Instance to original Template or specific Snapshot";
}
@Override
@@ -104,7 +104,7 @@ public class RestoreVMCmd extends BaseAsyncCmd implements UserCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to restore vm " + getVmId());
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to restore Instance " + getVmId());
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ScaleVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ScaleVMCmd.java
index 3af6d5245f0..cd3aeefc44b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ScaleVMCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/ScaleVMCmd.java
@@ -45,7 +45,7 @@ import com.cloud.uservm.UserVm;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "scaleVirtualMachine", description = "Scales the virtual machine to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume.", responseObject = UserVmResponse.class, responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
+@APICommand(name = "scaleVirtualMachine", description = "Scales the Instance to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume.", responseObject = UserVmResponse.class, responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ScaleVMCmd extends BaseAsyncCmd implements UserCmd {
private static final String s_name = "scalevirtualmachineresponse";
@@ -55,14 +55,14 @@ public class ScaleVMCmd extends BaseAsyncCmd implements UserCmd {
/////////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
@Parameter(name=ApiConstants.ID, type=CommandType.UUID, entityType=UserVmResponse.class,
- required=true, description="The ID of the virtual machine")
+ required=true, description = "The ID of the Instance")
private Long id;
@Parameter(name=ApiConstants.SERVICE_OFFERING_ID, type=CommandType.UUID, entityType=ServiceOfferingResponse.class,
- required=true, description="the ID of the service offering for the virtual machine")
+ required=true, description = "The ID of the service offering for the Instance")
private Long serviceOfferingId;
- @Parameter(name = ApiConstants.DETAILS, type = BaseCmd.CommandType.MAP, description = "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value")
+ @Parameter(name = ApiConstants.DETAILS, type = BaseCmd.CommandType.MAP, description = "Name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value")
private Map details;
@Parameter(name = ApiConstants.MIN_IOPS, type = CommandType.LONG, required = false, description = "New minimum number of IOPS for the custom disk offering", since = "4.17")
@@ -148,7 +148,7 @@ public class ScaleVMCmd extends BaseAsyncCmd implements UserCmd {
@Override
public String getEventDescription() {
- return "upgrading vm: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()) + " to service offering: " + this._uuidMgr.getUuid(ServiceOffering.class, getServiceOfferingId());
+ return "Upgrading Instance: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()) + " to service offering: " + this._uuidMgr.getUuid(ServiceOffering.class, getServiceOfferingId());
}
@Override
@@ -185,7 +185,7 @@ public class ScaleVMCmd extends BaseAsyncCmd implements UserCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to scale vm");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to scale Instance");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/StartVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/StartVMCmd.java
index c0311d59997..af7058d4492 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/StartVMCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/StartVMCmd.java
@@ -47,7 +47,7 @@ import com.cloud.uservm.UserVm;
import com.cloud.utils.exception.ExecutionException;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "startVirtualMachine", responseObject = UserVmResponse.class, description = "Starts a virtual machine.", responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
+@APICommand(name = "startVirtualMachine", responseObject = UserVmResponse.class, description = "Starts an Instance.", responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class StartVMCmd extends BaseAsyncCmd implements UserCmd {
@@ -58,37 +58,37 @@ public class StartVMCmd extends BaseAsyncCmd implements UserCmd {
// ///////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType=UserVmResponse.class,
- required = true, description = "The ID of the virtual machine")
+ required = true, description = "The ID of the Instance")
private Long id;
@Parameter(name = ApiConstants.POD_ID,
type = CommandType.UUID,
entityType = PodResponse.class,
- description = "destination Pod ID to deploy the VM to - parameter available for root admin only")
+ description = "Destination Pod ID to deploy the Instance to - parameter available for root admin only")
private Long podId;
@Parameter(name = ApiConstants.CLUSTER_ID,
type = CommandType.UUID,
entityType = ClusterResponse.class,
- description = "destination Cluster ID to deploy the VM to - parameter available for root admin only")
+ description = "Destination Cluster ID to deploy the Instance to - parameter available for root admin only")
private Long clusterId;
@Parameter(name = ApiConstants.HOST_ID,
type = CommandType.UUID,
entityType = HostResponse.class,
- description = "destination Host ID to deploy the VM to - parameter available for root admin only",
+ description = "Destination Host ID to deploy the Instance to - parameter available for root admin only",
since = "3.0.1")
private Long hostId;
@Parameter(name = ApiConstants.CONSIDER_LAST_HOST,
type = CommandType.BOOLEAN,
- description = "True by default, CloudStack will firstly try to start the VM on the last host where it run on before stopping, if destination host is not specified. " +
- "If false, CloudStack will not consider the last host and start the VM by normal process.",
+ description = "True by default, CloudStack will firstly try to start the Instance on the last host where it run on before stopping, if destination host is not specified. " +
+ "If false, CloudStack will not consider the last host and start the Instance by normal process.",
since = "4.18.0",
authorized = {RoleType.Admin})
private Boolean considerLastHost;
- @Parameter(name = ApiConstants.DEPLOYMENT_PLANNER, type = CommandType.STRING, description = "Deployment planner to use for vm allocation. Available to ROOT admin only", since = "4.4", authorized = { RoleType.Admin })
+ @Parameter(name = ApiConstants.DEPLOYMENT_PLANNER, type = CommandType.STRING, description = "Deployment planner to use for Instance allocation. Available to ROOT admin only", since = "4.4", authorized = { RoleType.Admin })
private String deploymentPlanner;
@Parameter(name = ApiConstants.BOOT_INTO_SETUP, type = CommandType.BOOLEAN, required = false, description = "Boot into hardware setup menu or not", since = "4.15.0.0")
@@ -161,7 +161,7 @@ public class StartVMCmd extends BaseAsyncCmd implements UserCmd {
@Override
public String getEventDescription() {
- return "starting user vm: " + this._uuidMgr.getUuid(VirtualMachine.class, getId());
+ return "Starting User Instance: " + this._uuidMgr.getUuid(VirtualMachine.class, getId());
}
@Override
@@ -187,7 +187,7 @@ public class StartVMCmd extends BaseAsyncCmd implements UserCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to start a vm");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to start an Instance");
}
} catch (ConcurrentOperationException ex) {
logger.warn("Exception: ", ex);
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 bfd5d8d07f6..d20f27eb56d 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
@@ -37,7 +37,7 @@ import com.cloud.user.Account;
import com.cloud.uservm.UserVm;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "stopVirtualMachine", responseObject = UserVmResponse.class, description = "Stops a virtual machine.", responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
+@APICommand(name = "stopVirtualMachine", responseObject = UserVmResponse.class, description = "Stops an Instance.", responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class StopVMCmd extends BaseAsyncCmd implements UserCmd {
@@ -49,12 +49,12 @@ public class StopVMCmd extends BaseAsyncCmd implements UserCmd {
@ACL(accessType = AccessType.OperateEntry)
@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType=UserVmResponse.class,
- required = true, description = "The ID of the virtual machine")
+ required = true, description = "The ID of the Instance")
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)."
- + " This option is to be used if the caller knows the VM is stopped and should be marked as such.")
+ @Parameter(name = ApiConstants.FORCED, type = CommandType.BOOLEAN, required = false, description = "Force stop the Instance "
+ + "(Instance 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 Instance is stopped and should be marked as such.")
private Boolean forced;
// ///////////////////////////////////////////////////
@@ -96,7 +96,7 @@ public class StopVMCmd extends BaseAsyncCmd implements UserCmd {
@Override
public String getEventDescription() {
- return "stopping user vm: " + this._uuidMgr.getUuid(VirtualMachine.class, getId());
+ return "Stopping User Instance: " + this._uuidMgr.getUuid(VirtualMachine.class, getId());
}
@Override
@@ -125,7 +125,7 @@ public class StopVMCmd extends BaseAsyncCmd implements UserCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to stop vm");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to stop Instance");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/UpdateDefaultNicForVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/UpdateDefaultNicForVMCmd.java
index 837bde06a6c..591d3871493 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/UpdateDefaultNicForVMCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/UpdateDefaultNicForVMCmd.java
@@ -41,7 +41,7 @@ import com.cloud.user.Account;
import com.cloud.uservm.UserVm;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "updateDefaultNicForVirtualMachine", description = "Changes the default NIC on a VM", responseObject = UserVmResponse.class, responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
+@APICommand(name = "updateDefaultNicForVirtualMachine", description = "Changes the default NIC on an Instance", responseObject = UserVmResponse.class, responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class UpdateDefaultNicForVMCmd extends BaseAsyncCmd implements UserCmd {
private static final String s_name = "updatedefaultnicforvirtualmachineresponse";
@@ -52,7 +52,7 @@ public class UpdateDefaultNicForVMCmd extends BaseAsyncCmd implements UserCmd {
@ACL(accessType = AccessType.OperateEntry)
@Parameter(name=ApiConstants.VIRTUAL_MACHINE_ID, type=CommandType.UUID, entityType=UserVmResponse.class,
- required=true, description="Virtual Machine ID")
+ required=true, description = "Instance ID")
private Long vmId;
@Parameter(name = ApiConstants.NIC_ID, type = CommandType.UUID, entityType = NicResponse.class, required = true, description = "NIC ID")
@@ -90,7 +90,7 @@ public class UpdateDefaultNicForVMCmd extends BaseAsyncCmd implements UserCmd {
@Override
public String getEventDescription() {
- return "Updating NIC " + this._uuidMgr.getUuid(Nic.class, getNicId()) + " on user vm: " + this._uuidMgr.getUuid(VirtualMachine.class, getVmId());
+ return "Updating NIC " + this._uuidMgr.getUuid(Nic.class, getNicId()) + " on User Instance: " + this._uuidMgr.getUuid(VirtualMachine.class, getVmId());
}
@Override
@@ -114,7 +114,7 @@ public class UpdateDefaultNicForVMCmd extends BaseAsyncCmd implements UserCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to set default nic for VM. Refer to server logs for details.");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to set default NIC for Instance. Refer to server logs for details.");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/UpdateVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/UpdateVMCmd.java
index 0f5dade96d2..2185c042820 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/UpdateVMCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/UpdateVMCmd.java
@@ -50,9 +50,9 @@ import com.cloud.uservm.UserVm;
import com.cloud.utils.net.Dhcp;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "updateVirtualMachine", description="Updates properties of a virtual machine. The VM has to be stopped and restarted for the " +
- "new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. " +
- "Therefore, stop the VM manually before issuing this call.", responseObject = UserVmResponse.class, responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
+@APICommand(name = "updateVirtualMachine", description = "Updates properties of an Instance. The Instance has to be stopped and restarted for the " +
+ "new properties to take effect. UpdateVirtualMachine does not first check whether the Instance is stopped. " +
+ "Therefore, stop the Instance manually before issuing this call.", responseObject = UserVmResponse.class, responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class UpdateVMCmd extends BaseCustomIdCmd implements SecurityGroupAction, UserCmd {
private static final String s_name = "updatevirtualmachineresponse";
@@ -61,29 +61,29 @@ public class UpdateVMCmd extends BaseCustomIdCmd implements SecurityGroupAction,
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.DISPLAY_NAME, type = CommandType.STRING, description = "user generated name")
+ @Parameter(name = ApiConstants.DISPLAY_NAME, type = CommandType.STRING, description = "User generated name")
private String displayName;
- @Parameter(name = ApiConstants.GROUP, type = CommandType.STRING, description = "group of the virtual machine")
+ @Parameter(name = ApiConstants.GROUP, type = CommandType.STRING, description = "Group of the Instance")
private String group;
- @Parameter(name = ApiConstants.HA_ENABLE, type = CommandType.BOOLEAN, description = "true if high-availability is enabled for the virtual machine, false otherwise")
+ @Parameter(name = ApiConstants.HA_ENABLE, type = CommandType.BOOLEAN, description = "True if high-availability is enabled for the Instance, false otherwise")
private Boolean haEnable;
@ACL(accessType = AccessType.OperateEntry)
@Parameter(name=ApiConstants.ID, type=CommandType.UUID, entityType=UserVmResponse.class,
- required=true, description="The ID of the virtual machine")
+ required=true, description = "The ID of the Instance")
private Long id;
@Parameter(name = ApiConstants.OS_TYPE_ID,
type = CommandType.UUID,
entityType = GuestOSResponse.class,
- description = "the ID of the OS type that best represents this VM.")
+ description = "The ID of the OS type that best represents this Instance.")
private Long osTypeId;
@Parameter(name = ApiConstants.USER_DATA,
type = CommandType.STRING,
- description = "an optional binary data that can be sent to the virtual machine upon a successful deployment. " +
+ description = "An optional binary data that can be sent to the Instance upon a successful deployment. " +
"This binary data must be base64 encoded before adding it to the request. " +
"Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. " +
"Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. " +
@@ -92,24 +92,24 @@ public class UpdateVMCmd extends BaseCustomIdCmd implements SecurityGroupAction,
since = "4.16.0")
private String userData;
- @Parameter(name = ApiConstants.USER_DATA_ID, type = CommandType.UUID, entityType = UserDataResponse.class, description = "the ID of the userdata", since = "4.18")
+ @Parameter(name = ApiConstants.USER_DATA_ID, type = CommandType.UUID, entityType = UserDataResponse.class, description = "The ID of the userdata", since = "4.18")
private Long userdataId;
- @Parameter(name = ApiConstants.USER_DATA_DETAILS, type = CommandType.MAP, description = "used to specify the parameters values for the variables in userdata.", since = "4.18")
+ @Parameter(name = ApiConstants.USER_DATA_DETAILS, type = CommandType.MAP, description = "Used to specify the parameters values for the variables in userdata.", since = "4.18")
private Map userdataDetails;
- @Parameter(name = ApiConstants.DISPLAY_VM, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the vm to the end user or not.", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.DISPLAY_VM, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the Instance to the end User or not.", authorized = {RoleType.Admin})
private Boolean displayVm;
@Parameter(name = ApiConstants.IS_DYNAMICALLY_SCALABLE,
type = CommandType.BOOLEAN,
- description = "true if VM contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory. This can be updated only when dynamic scaling is enabled on template, service offering and the corresponding global setting")
+ description = "True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance cpu/memory. This can be updated only when dynamic scaling is enabled on Template, service offering and the corresponding global setting")
protected Boolean isDynamicallyScalable;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "new host name of the vm. The VM has to be stopped/started for this update to take affect", validations = {ApiArgValidator.RFCComplianceDomainName}, since = "4.4")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "New host name of the Instance. The Instance has to be stopped/started for this update to take affect", validations = {ApiArgValidator.RFCComplianceDomainName}, since = "4.4")
private String name;
- @Parameter(name = ApiConstants.INSTANCE_NAME, type = CommandType.STRING, description = "instance name of the user vm", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.INSTANCE_NAME, type = CommandType.STRING, description = "Instance name of the User Instance", since = "4.4", authorized = {RoleType.Admin})
private String instanceName;
@Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.")
@@ -120,7 +120,7 @@ public class UpdateVMCmd extends BaseCustomIdCmd implements SecurityGroupAction,
type = CommandType.LIST,
collectionType = CommandType.UUID,
entityType = SecurityGroupResponse.class,
- description = "list of security group ids to be applied on the virtual machine.")
+ description = "List of security group ids to be applied on the Instance.")
private List securityGroupIdList;
@ACL
@@ -128,22 +128,22 @@ public class UpdateVMCmd extends BaseCustomIdCmd implements SecurityGroupAction,
type = CommandType.LIST,
collectionType = CommandType.STRING,
entityType = SecurityGroupResponse.class,
- description = "comma separated list of security groups names that going to be applied to the virtual machine. " +
- "Should be passed only when vm is created from a zone with Basic Network support. " +
+ description = "Comma separated list of security groups names that going to be applied to the Instance. " +
+ "Should be passed only when Instance is created from a zone with Basic Network support. " +
"Mutually exclusive with securitygroupids parameter"
)
private List securityGroupNameList;
@Parameter(name = ApiConstants.CLEAN_UP_DETAILS,
type = CommandType.BOOLEAN,
- description = "optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)")
+ description = "Optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)")
private Boolean cleanupDetails;
- @Parameter(name = ApiConstants.DHCP_OPTIONS_NETWORK_LIST, type = CommandType.MAP, description = "DHCP options which are passed to the VM on start up"
+ @Parameter(name = ApiConstants.DHCP_OPTIONS_NETWORK_LIST, type = CommandType.MAP, description = "DHCP options which are passed to the Instance on start up"
+ " Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com")
private Map dhcpOptionsNetworkList;
- @Parameter(name = ApiConstants.EXTRA_CONFIG, type = CommandType.STRING, since = "4.12", description = "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", length = 5120)
+ @Parameter(name = ApiConstants.EXTRA_CONFIG, type = CommandType.STRING, since = "4.12", description = "An optional URL encoded string that can be passed to the Instance upon successful deployment", length = 5120)
private String extraConfig;
@Parameter(name = ApiConstants.DELETE_PROTECTION,
@@ -236,7 +236,7 @@ public class UpdateVMCmd extends BaseCustomIdCmd implements SecurityGroupAction,
String networkId = dhcpNetworkOptions.get(ApiConstants.NETWORK_ID);
if(networkId == null) {
- throw new IllegalArgumentException("No networkid specified when providing extra dhcp options.");
+ throw new IllegalArgumentException("No networkid specified when providing extra DHCP options.");
}
Map dhcpOptionsForNetwork = new HashMap<>();
@@ -291,19 +291,19 @@ public class UpdateVMCmd extends BaseCustomIdCmd implements SecurityGroupAction,
@Override
public void execute() throws ResourceUnavailableException, InsufficientCapacityException, ServerApiException {
- CallContext.current().setEventDetails("Vm Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()));
+ CallContext.current().setEventDetails("Instance Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getId()));
UserVm result = null;
try {
result = _userVmService.updateVirtualMachine(this);
} catch (CloudRuntimeException e) {
- throw new CloudRuntimeException(String.format("Failed to update VM, due to: %s", e.getLocalizedMessage()), e);
+ throw new CloudRuntimeException(String.format("Failed to update Instance, due to: %s", e.getLocalizedMessage()), e);
}
if (result != null) {
UserVmResponse response = _responseGenerator.createUserVmResponse(getResponseView(), "virtualmachine", result).get(0);
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update vm");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update Instance");
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/UpdateVMScheduleCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/UpdateVMScheduleCmd.java
index 72f85c1a99c..b7222944fe0 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/UpdateVMScheduleCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/UpdateVMScheduleCmd.java
@@ -32,7 +32,7 @@ import org.apache.cloudstack.vm.schedule.VMScheduleManager;
import javax.inject.Inject;
import java.util.Date;
-@APICommand(name = "updateVMSchedule", description = "Update VM Schedule.", responseObject = VMScheduleResponse.class,
+@APICommand(name = "updateVMSchedule", description = "Update Instance Schedule.", responseObject = VMScheduleResponse.class,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false, since = "4.19.0",
authorized = {RoleType.Admin, RoleType.ResourceAdmin, RoleType.DomainAdmin, RoleType.User})
public class UpdateVMScheduleCmd extends BaseCmd {
@@ -43,7 +43,7 @@ public class UpdateVMScheduleCmd extends BaseCmd {
type = CommandType.UUID,
entityType = VMScheduleResponse.class,
required = true,
- description = "ID of VM schedule")
+ description = "ID of Instance schedule")
private Long id;
@Parameter(name = ApiConstants.DESCRIPTION,
@@ -55,7 +55,7 @@ public class UpdateVMScheduleCmd extends BaseCmd {
@Parameter(name = ApiConstants.SCHEDULE,
type = CommandType.STRING,
required = false,
- description = "Schedule for action on VM in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'")
+ description = "Schedule for action on Instance in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'")
private String schedule;
@Parameter(name = ApiConstants.TIMEZONE,
@@ -67,21 +67,21 @@ public class UpdateVMScheduleCmd extends BaseCmd {
@Parameter(name = ApiConstants.START_DATE,
type = CommandType.DATE,
required = false,
- description = "start date from which the schedule becomes active"
+ description = "Start date from which the schedule becomes active"
+ "Use format \"yyyy-MM-dd hh:mm:ss\")")
private Date startDate;
@Parameter(name = ApiConstants.END_DATE,
type = CommandType.DATE,
required = false,
- description = "end date after which the schedule becomes inactive"
+ description = "End date after which the schedule becomes inactive"
+ "Use format \"yyyy-MM-dd hh:mm:ss\")")
private Date endDate;
@Parameter(name = ApiConstants.ENABLED,
type = CommandType.BOOLEAN,
required = false,
- description = "Enable VM schedule")
+ description = "Enable Instance schedule")
private Boolean enabled;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/UpdateVmNicIpCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/UpdateVmNicIpCmd.java
index 5c654701de9..f8ca0b7afea 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/UpdateVmNicIpCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/UpdateVmNicIpCmd.java
@@ -46,14 +46,14 @@ import com.cloud.uservm.UserVm;
import com.cloud.utils.net.NetUtils;
import com.cloud.vm.Nic;
-@APICommand(name = "updateVmNicIp", description = "Update the default Ip of a VM Nic", responseObject = UserVmResponse.class)
+@APICommand(name = "updateVmNicIp", description = "Update the default IP of an Instance NIC", responseObject = UserVmResponse.class)
public class UpdateVmNicIpCmd extends BaseAsyncCmd {
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
@Parameter(name=ApiConstants.NIC_ID, type=CommandType.UUID, entityType = NicResponse.class, required = true,
- description="the ID of the nic to which you want to assign private IP")
+ description = "The ID of the NIC to which you want to assign private IP")
private Long nicId;
@Parameter(name = ApiConstants.IP_ADDRESS, type = CommandType.STRING, required = false,
@@ -79,7 +79,7 @@ public class UpdateVmNicIpCmd extends BaseAsyncCmd {
private long getZoneId() {
Network ntwk = _entityMgr.findById(Network.class, getNetworkId());
if (ntwk == null) {
- throw new InvalidParameterValueException("Can't find zone id for specified");
+ throw new InvalidParameterValueException("Can't find zone ID for specified");
}
return ntwk.getDataCenterId();
}
@@ -87,7 +87,7 @@ public class UpdateVmNicIpCmd extends BaseAsyncCmd {
public Long getNetworkId() {
Nic nic = _entityMgr.findById(Nic.class, nicId);
if (nic == null) {
- throw new InvalidParameterValueException("Can't find network id for specified nic");
+ throw new InvalidParameterValueException("Can't find Network ID for specified NIC");
}
Long networkId = nic.getNetworkId();
return networkId;
@@ -123,7 +123,7 @@ public class UpdateVmNicIpCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "associating ip to nic id: " + this._uuidMgr.getUuid(Network.class, getNetworkId()) + " in zone " + this._uuidMgr.getUuid(DataCenter.class, getZoneId());
+ return "Associating IP to NIC id: " + this._uuidMgr.getUuid(Network.class, getNetworkId()) + " in zone " + this._uuidMgr.getUuid(DataCenter.class, getZoneId());
}
/////////////////////////////////////////////////////
@@ -143,7 +143,7 @@ public class UpdateVmNicIpCmd extends BaseAsyncCmd {
String ip;
if ((ip = getIpaddress()) != null) {
if (!NetUtils.isValidIp4(ip)) {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Invalid ip address " + ip);
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Invalid IP address " + ip);
}
}
@@ -156,7 +156,7 @@ public class UpdateVmNicIpCmd extends BaseAsyncCmd {
response.setResponseName(getCommandName());
this.setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update ip address on vm NIC. Refer to server logs for details.");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update IP address on Instance NIC. Refer to server logs for details.");
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/UpgradeVMCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/UpgradeVMCmd.java
index 6a7422e70bb..c45a18d2fa2 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vm/UpgradeVMCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vm/UpgradeVMCmd.java
@@ -41,8 +41,8 @@ import com.cloud.uservm.UserVm;
import com.cloud.vm.VirtualMachine;
@Deprecated(since = "4.18")
-@APICommand(name = "changeServiceForVirtualMachine", responseObject=UserVmResponse.class, description="(This API is deprecated, use scaleVirtualMachine API)" +
- "Changes the service offering for a virtual machine. The virtual machine must be in a \"Stopped\" state for " +
+@APICommand(name = "changeServiceForVirtualMachine", responseObject=UserVmResponse.class, description = "(This API is deprecated, use scaleVirtualMachine API)" +
+ "Changes the service offering for an Instance. The Instance must be in a \"Stopped\" state for " +
"this command to take effect.", responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class UpgradeVMCmd extends BaseCmd implements UserCmd {
@@ -54,14 +54,14 @@ public class UpgradeVMCmd extends BaseCmd implements UserCmd {
@ACL(accessType = AccessType.OperateEntry)
@Parameter(name=ApiConstants.ID, type=CommandType.UUID, entityType=UserVmResponse.class,
- required=true, description="The ID of the virtual machine")
+ required=true, description = "The ID of the Instance")
private Long id;
@Parameter(name=ApiConstants.SERVICE_OFFERING_ID, type=CommandType.UUID, entityType=ServiceOfferingResponse.class,
- required=true, description="the service offering ID to apply to the virtual machine")
+ required=true, description = "The service offering ID to apply to the Instance")
protected Long serviceOfferingId;
- @Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value")
+ @Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, description = "Name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value")
private Map details;
@Parameter(name = ApiConstants.MIN_IOPS, type = CommandType.LONG, required = false, description = "New minimum number of IOPS for the custom disk offering", since = "4.17")
@@ -153,7 +153,7 @@ public class UpgradeVMCmd extends BaseCmd implements UserCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to upgrade vm");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to upgrade Instance");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vmgroup/CreateVMGroupCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vmgroup/CreateVMGroupCmd.java
index e2952b5bd81..a142ffa2d49 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vmgroup/CreateVMGroupCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vmgroup/CreateVMGroupCmd.java
@@ -30,7 +30,7 @@ import org.apache.cloudstack.context.CallContext;
import com.cloud.vm.InstanceGroup;
-@APICommand(name = "createInstanceGroup", description = "Creates a vm group", responseObject = InstanceGroupResponse.class, entityType = {InstanceGroup.class},
+@APICommand(name = "createInstanceGroup", description = "Creates an Instance group", responseObject = InstanceGroupResponse.class, entityType = {InstanceGroup.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class CreateVMGroupCmd extends BaseCmd {
@@ -39,21 +39,21 @@ public class CreateVMGroupCmd extends BaseCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "the name of the instance group")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "The name of the Instance group")
private String groupName;
@Parameter(name = ApiConstants.ACCOUNT,
type = CommandType.STRING,
- description = "the account of the instance group. The account parameter must be used with the domainId parameter.")
+ description = "The account of the Instance group. The account parameter must be used with the domainId parameter.")
private String accountName;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "the domain ID of account owning the instance group")
+ description = "The domain ID of account owning the Instance group")
private Long domainId;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "The project of the instance group")
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "The project of the Instance group")
private Long projectId;
// ///////////////////////////////////////////////////
@@ -98,7 +98,7 @@ public class CreateVMGroupCmd extends BaseCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create vm instance group");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create Instance Instance group");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vmgroup/DeleteVMGroupCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vmgroup/DeleteVMGroupCmd.java
index b74bc43eeb7..b07084a273c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vmgroup/DeleteVMGroupCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vmgroup/DeleteVMGroupCmd.java
@@ -31,7 +31,7 @@ import org.apache.cloudstack.api.response.SuccessResponse;
import com.cloud.user.Account;
import com.cloud.vm.InstanceGroup;
-@APICommand(name = "deleteInstanceGroup", description = "Deletes a vm group", responseObject = SuccessResponse.class, entityType = {InstanceGroup.class},
+@APICommand(name = "deleteInstanceGroup", description = "Deletes an Instance group", responseObject = SuccessResponse.class, entityType = {InstanceGroup.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class DeleteVMGroupCmd extends BaseCmd {
@@ -40,7 +40,7 @@ public class DeleteVMGroupCmd extends BaseCmd {
/////////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = InstanceGroupResponse.class, required = true, description = "the ID of the instance group")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = InstanceGroupResponse.class, required = true, description = "The ID of the Instance group")
private Long id;
/////////////////////////////////////////////////////
@@ -72,7 +72,7 @@ public class DeleteVMGroupCmd extends BaseCmd {
SuccessResponse response = new SuccessResponse(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to delete vm group");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to delete Instance group");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vmgroup/ListVMGroupsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vmgroup/ListVMGroupsCmd.java
index 31845a956e9..ee918944046 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vmgroup/ListVMGroupsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vmgroup/ListVMGroupsCmd.java
@@ -26,7 +26,7 @@ import org.apache.cloudstack.api.response.ListResponse;
import com.cloud.vm.InstanceGroup;
-@APICommand(name = "listInstanceGroups", description = "Lists vm groups", responseObject = InstanceGroupResponse.class, entityType = {InstanceGroup.class},
+@APICommand(name = "listInstanceGroups", description = "Lists Instance groups", responseObject = InstanceGroupResponse.class, entityType = {InstanceGroup.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListVMGroupsCmd extends BaseListProjectAndAccountResourcesCmd {
@@ -35,10 +35,10 @@ public class ListVMGroupsCmd extends BaseListProjectAndAccountResourcesCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = InstanceGroupResponse.class, description = "list instance groups by ID")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = InstanceGroupResponse.class, description = "List Instance groups by ID")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "list instance groups by name")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "List Instance groups by name")
private String groupName;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vmgroup/UpdateVMGroupCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vmgroup/UpdateVMGroupCmd.java
index 5c553f06404..d63a5aea6de 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vmgroup/UpdateVMGroupCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vmgroup/UpdateVMGroupCmd.java
@@ -30,7 +30,7 @@ import org.apache.cloudstack.api.response.InstanceGroupResponse;
import com.cloud.user.Account;
import com.cloud.vm.InstanceGroup;
-@APICommand(name = "updateInstanceGroup", description = "Updates a vm group", responseObject = InstanceGroupResponse.class, entityType = {InstanceGroup.class},
+@APICommand(name = "updateInstanceGroup", description = "Updates an Instance group", responseObject = InstanceGroupResponse.class, entityType = {InstanceGroup.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class UpdateVMGroupCmd extends BaseCmd {
@@ -42,7 +42,7 @@ public class UpdateVMGroupCmd extends BaseCmd {
@Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = InstanceGroupResponse.class, required = true, description = "Instance group ID")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "new instance group name")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "New Instance group name")
private String groupName;
/////////////////////////////////////////////////////
@@ -79,7 +79,7 @@ public class UpdateVMGroupCmd extends BaseCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update vm instance group");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to update Instance group");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vmsnapshot/CreateVMSnapshotCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vmsnapshot/CreateVMSnapshotCmd.java
index 18a478e9dae..6e1a7daf4c2 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vmsnapshot/CreateVMSnapshotCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vmsnapshot/CreateVMSnapshotCmd.java
@@ -37,25 +37,25 @@ import com.cloud.uservm.UserVm;
import com.cloud.vm.VirtualMachine;
import com.cloud.vm.snapshot.VMSnapshot;
-@APICommand(name = "createVMSnapshot", description = "Creates snapshot for a vm.", responseObject = VMSnapshotResponse.class, since = "4.2.0", entityType = {VMSnapshot.class},
+@APICommand(name = "createVMSnapshot", description = "Creates Snapshot for an Instance.", responseObject = VMSnapshotResponse.class, since = "4.2.0", entityType = {VMSnapshot.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class CreateVMSnapshotCmd extends BaseAsyncCreateCmd {
@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID, type = CommandType.UUID, required = true, entityType = UserVmResponse.class, description = "The ID of the vm")
+ @Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID, type = CommandType.UUID, required = true, entityType = UserVmResponse.class, description = "The ID of the Instance")
private Long vmId;
- @Parameter(name = ApiConstants.VM_SNAPSHOT_DESCRIPTION, type = CommandType.STRING, required = false, description = "The description of the snapshot")
+ @Parameter(name = ApiConstants.VM_SNAPSHOT_DESCRIPTION, type = CommandType.STRING, required = false, description = "The description of the Snapshot")
private String description;
- @Parameter(name = ApiConstants.VM_SNAPSHOT_DISPLAYNAME, type = CommandType.STRING, required = false, description = "The display name of the snapshot")
+ @Parameter(name = ApiConstants.VM_SNAPSHOT_DISPLAYNAME, type = CommandType.STRING, required = false, description = "The display name of the Snapshot")
private String displayName;
- @Parameter(name = ApiConstants.VM_SNAPSHOT_MEMORY, type = CommandType.BOOLEAN, required = false, description = "snapshot memory if true")
+ @Parameter(name = ApiConstants.VM_SNAPSHOT_MEMORY, type = CommandType.BOOLEAN, required = false, description = "Snapshot memory if true")
private Boolean snapshotMemory;
- @Parameter(name = ApiConstants.VM_SNAPSHOT_QUIESCEVM, type = CommandType.BOOLEAN, required = false, description = "quiesce vm if true")
+ @Parameter(name = ApiConstants.VM_SNAPSHOT_QUIESCEVM, type = CommandType.BOOLEAN, required = false, description = "Quiesce Instance if true")
private Boolean quiescevm;
public Boolean snapshotMemory() {
@@ -92,20 +92,20 @@ public class CreateVMSnapshotCmd extends BaseAsyncCreateCmd {
try {
vmsnapshot = _vmSnapshotService.allocVMSnapshot(getVmId(), getDisplayName(), getDescription(), snapshotMemory());
} catch (CloudRuntimeException e) {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create vm snapshot: " + e.getMessage(), e);
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create Instance Snapshot: " + e.getMessage(), e);
}
if (vmsnapshot != null) {
setEntityId(vmsnapshot.getId());
setEntityUuid(vmsnapshot.getUuid());
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create vm snapshot");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create Instance Snapshot");
}
}
@Override
public String getEventDescription() {
- return "creating snapshot for VM: " + this._uuidMgr.getUuid(VirtualMachine.class, getVmId());
+ return "Creating Snapshot for Instance: " + this._uuidMgr.getUuid(VirtualMachine.class, getVmId());
}
@Override
@@ -122,7 +122,7 @@ public class CreateVMSnapshotCmd extends BaseAsyncCreateCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create vm snapshot due to an internal error creating snapshot for vm " + getVmId());
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create Instance Snapshot due to an internal error creating Snapshot for Instance " + getVmId());
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vmsnapshot/DeleteVMSnapshotCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vmsnapshot/DeleteVMSnapshotCmd.java
index 94b8824f868..afd63e8e64b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vmsnapshot/DeleteVMSnapshotCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vmsnapshot/DeleteVMSnapshotCmd.java
@@ -35,7 +35,7 @@ import com.cloud.event.EventTypes;
import com.cloud.user.Account;
import com.cloud.vm.snapshot.VMSnapshot;
-@APICommand(name = "deleteVMSnapshot", description = "Deletes a vmsnapshot.", responseObject = SuccessResponse.class, since = "4.2.0", entityType = {VMSnapshot.class},
+@APICommand(name = "deleteVMSnapshot", description = "Deletes an Instance Snapshot.", responseObject = SuccessResponse.class, since = "4.2.0", entityType = {VMSnapshot.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class DeleteVMSnapshotCmd extends BaseAsyncCmd {
@@ -44,7 +44,7 @@ public class DeleteVMSnapshotCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = VMSnapshotResponse.class,
required = true,
- description = "The ID of the VM snapshot")
+ description = "The ID of the Instance Snapshot")
private Long id;
public Long getId() {
@@ -68,13 +68,13 @@ public class DeleteVMSnapshotCmd extends BaseAsyncCmd {
SuccessResponse response = new SuccessResponse(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to delete vm snapshot");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to delete Instance Snapshot");
}
}
@Override
public String getEventDescription() {
- return "Delete VM snapshot: " + this._uuidMgr.getUuid(VMSnapshot.class, getId());
+ return "Delete Instance Snapshot: " + this._uuidMgr.getUuid(VMSnapshot.class, getId());
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vmsnapshot/ListVMSnapshotCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vmsnapshot/ListVMSnapshotCmd.java
index 87dd6e0b478..b5d603e000c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vmsnapshot/ListVMSnapshotCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vmsnapshot/ListVMSnapshotCmd.java
@@ -31,24 +31,24 @@ import org.apache.cloudstack.api.response.VMSnapshotResponse;
import com.cloud.utils.Pair;
import com.cloud.vm.snapshot.VMSnapshot;
-@APICommand(name = "listVMSnapshot", description = "List virtual machine snapshot by conditions", responseObject = VMSnapshotResponse.class, since = "4.2.0", entityType = {VMSnapshot.class},
+@APICommand(name = "listVMSnapshot", description = "List Instance Snapshot by conditions", responseObject = VMSnapshotResponse.class, since = "4.2.0", entityType = {VMSnapshot.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListVMSnapshotCmd extends BaseListTaggedResourcesCmd {
- @Parameter(name = ApiConstants.VM_SNAPSHOT_ID, type = CommandType.UUID, entityType = VMSnapshotResponse.class, description = "The ID of the VM snapshot")
+ @Parameter(name = ApiConstants.VM_SNAPSHOT_ID, type = CommandType.UUID, entityType = VMSnapshotResponse.class, description = "The ID of the Instance Snapshot")
private Long id;
- @Parameter(name=ApiConstants.VM_SNAPSHOT_IDS, type=CommandType.LIST, collectionType=CommandType.UUID, entityType=VMSnapshotResponse.class, description="the IDs of the vm snapshots, mutually exclusive with vmsnapshotid", since = "4.9")
+ @Parameter(name=ApiConstants.VM_SNAPSHOT_IDS, type=CommandType.LIST, collectionType=CommandType.UUID, entityType=VMSnapshotResponse.class, description = "The IDs of the Instance Snapshots, mutually exclusive with vmsnapshotid", since = "4.9")
private List ids;
- @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "state of the virtual machine snapshot")
+ @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "State of the Instance Snapshot")
private String state;
- @Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID, type = CommandType.UUID, entityType = UserVmResponse.class, description = "the ID of the vm")
+ @Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID, type = CommandType.UUID, entityType = UserVmResponse.class, description = "The ID of the Instance")
private Long vmId;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "lists snapshot by snapshot name or display name")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "Lists Snapshot by Snapshot name or display name")
private String vmSnapshotName;
public String getState() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vmsnapshot/RevertToVMSnapshotCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vmsnapshot/RevertToVMSnapshotCmd.java
index 310b45687d4..43f20362e98 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vmsnapshot/RevertToVMSnapshotCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vmsnapshot/RevertToVMSnapshotCmd.java
@@ -41,7 +41,7 @@ import com.cloud.user.Account;
import com.cloud.uservm.UserVm;
import com.cloud.vm.snapshot.VMSnapshot;
-@APICommand(name = "revertToVMSnapshot", description = "Revert VM from a vmsnapshot.", responseObject = UserVmResponse.class, since = "4.2.0", responseView = ResponseView.Restricted,
+@APICommand(name = "revertToVMSnapshot", description = "Revert Instance from a vmsnapshot.", responseObject = UserVmResponse.class, since = "4.2.0", responseView = ResponseView.Restricted,
requestHasSensitiveInfo = false, responseHasSensitiveInfo = true)
public class RevertToVMSnapshotCmd extends BaseAsyncCmd implements UserCmd {
private static final String s_name = "reverttovmsnapshotresponse";
@@ -51,7 +51,7 @@ public class RevertToVMSnapshotCmd extends BaseAsyncCmd implements UserCmd {
type = CommandType.UUID,
required = true,
entityType = VMSnapshotResponse.class,
- description = "The ID of the vm snapshot")
+ description = "The ID of the Instance Snapshot")
private Long vmSnapShotId;
public Long getVmSnapShotId() {
@@ -82,13 +82,13 @@ public class RevertToVMSnapshotCmd extends BaseAsyncCmd implements UserCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to revert VM snapshot");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to revert Instance Snapshot");
}
}
@Override
public String getEventDescription() {
- return "Revert from VM snapshot: " + this._uuidMgr.getUuid(VMSnapshot.class, getVmSnapShotId());
+ return "Revert from Instance Snapshot: " + this._uuidMgr.getUuid(VMSnapshot.class, getVmSnapShotId());
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/AddResourceDetailCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/AddResourceDetailCmd.java
index 287991fa984..b1e58bb6ef6 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/AddResourceDetailCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/AddResourceDetailCmd.java
@@ -40,13 +40,13 @@ public class AddResourceDetailCmd extends BaseAsyncCmd {
@Parameter(name = ApiConstants.DETAILS, type = CommandType.MAP, required = true, description = "Map of (key/value pairs)")
private Map details;
- @Parameter(name = ApiConstants.RESOURCE_TYPE, type = CommandType.STRING, required = true, description = "type of the resource")
+ @Parameter(name = ApiConstants.RESOURCE_TYPE, type = CommandType.STRING, required = true, description = "Type of the resource")
private String resourceType;
- @Parameter(name = ApiConstants.RESOURCE_ID, type = CommandType.STRING, required = true, collectionType = CommandType.STRING, description = "resource id to create the details for")
+ @Parameter(name = ApiConstants.RESOURCE_ID, type = CommandType.STRING, required = true, collectionType = CommandType.STRING, description = "Resource ID to create the details for")
private String resourceId;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "pass false if you want this detail to be disabled for the regular user. True by default", since = "4.4")
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "Pass false if you want this detail to be disabled for the regular User. True by default", since = "4.4")
private Boolean display;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/AssignVolumeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/AssignVolumeCmd.java
index 1a51aa03c22..f3985351228 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/AssignVolumeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/AssignVolumeCmd.java
@@ -34,7 +34,7 @@ import com.cloud.storage.Volume;
import java.util.Map;
-@APICommand(name = AssignVolumeCmd.CMD_NAME, responseObject = VolumeResponse.class, description = "Changes ownership of a Volume from one account to another.", entityType = {
+@APICommand(name = AssignVolumeCmd.CMD_NAME, responseObject = VolumeResponse.class, description = "Changes ownership of a Volume from one Account to another.", entityType = {
Volume.class}, requestHasSensitiveInfo = false, responseHasSensitiveInfo = false, since = "4.18.0.0")
public class AssignVolumeCmd extends BaseCmd implements UserCmd {
public static final String CMD_NAME = "assignVolume";
@@ -47,7 +47,7 @@ public class AssignVolumeCmd extends BaseCmd implements UserCmd {
private Long volumeId;
@Parameter(name = ApiConstants.ACCOUNT_ID, type = CommandType.UUID, entityType = AccountResponse.class,
- description = "The ID of the account to which the volume will be assigned. Mutually exclusive with parameter 'projectid'.")
+ description = "The ID of the Account to which the volume will be assigned. Mutually exclusive with parameter 'projectid'.")
private Long accountId;
@Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class,
@@ -81,7 +81,7 @@ public class AssignVolumeCmd extends BaseCmd implements UserCmd {
if (result == null) {
Map fullParams = getFullUrlParams();
if (accountId != null) {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, String.format("Failed to move volume [%s] to account [%s].", fullParams.get(ApiConstants.VOLUME_ID),
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, String.format("Failed to move volume [%s] to Account [%s].", fullParams.get(ApiConstants.VOLUME_ID),
fullParams.get(ApiConstants.ACCOUNT_ID)));
}
throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, String.format("Failed to move volume [%s] to project [%s].", fullParams.get(ApiConstants.VOLUME_ID),
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/AttachVolumeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/AttachVolumeCmd.java
index 1a3b9220877..23fbc0fa0c7 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/AttachVolumeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/AttachVolumeCmd.java
@@ -37,7 +37,7 @@ import com.cloud.storage.Volume;
import com.cloud.user.Account;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "attachVolume", description = "Attaches a disk volume to a virtual machine.", responseObject = VolumeResponse.class, responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
+@APICommand(name = "attachVolume", description = "Attaches a disk volume to an Instance.", responseObject = VolumeResponse.class, responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class AttachVolumeCmd extends BaseAsyncCmd implements UserCmd {
private static final String s_name = "attachvolumeresponse";
@@ -52,12 +52,12 @@ public class AttachVolumeCmd extends BaseAsyncCmd implements UserCmd {
+ "Please refer to the docs of your hypervisor for the correct mapping of the deviceID and the actual logical disk structure.")
private Long deviceId;
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VolumeResponse.class, required = true, description = "the ID of the disk volume")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VolumeResponse.class, required = true, description = "The ID of the disk volume")
private Long id;
@ACL(accessType = AccessType.OperateEntry)
@Parameter(name=ApiConstants.VIRTUAL_MACHINE_ID, type=CommandType.UUID, entityType=UserVmResponse.class,
- required=true, description=" the ID of the virtual machine")
+ required=true, description = " the ID of the Instance")
private Long virtualMachineId;
/////////////////////////////////////////////////////
@@ -111,12 +111,12 @@ public class AttachVolumeCmd extends BaseAsyncCmd implements UserCmd {
@Override
public String getEventDescription() {
- return "attaching volume: " + this._uuidMgr.getUuid(Volume.class, getId()) + " to vm: " + this._uuidMgr.getUuid(VirtualMachine.class, getVirtualMachineId());
+ return "Attaching volume: " + this._uuidMgr.getUuid(Volume.class, getId()) + " to Instance: " + this._uuidMgr.getUuid(VirtualMachine.class, getVirtualMachineId());
}
@Override
public void execute() {
- CallContext.current().setEventDetails("Volume Id: " + this._uuidMgr.getUuid(Volume.class, getId()) + " VmId: " + this._uuidMgr.getUuid(VirtualMachine.class, getVirtualMachineId()));
+ CallContext.current().setEventDetails("Volume Id: " + this._uuidMgr.getUuid(Volume.class, getId()) + " Instance Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getVirtualMachineId()));
Volume result = _volumeService.attachVolumeToVM(this);
if (result != null) {
VolumeResponse response = _responseGenerator.createVolumeResponse(getResponseView(), result);
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/ChangeOfferingForVolumeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/ChangeOfferingForVolumeCmd.java
index 404a02b04b8..77c30aa6be9 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/ChangeOfferingForVolumeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/ChangeOfferingForVolumeCmd.java
@@ -50,14 +50,14 @@ public class ChangeOfferingForVolumeCmd extends BaseAsyncCmd implements UserCmd
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, entityType = VolumeResponse.class, required = true, type = CommandType.UUID, description = "the ID of the volume")
+ @Parameter(name = ApiConstants.ID, entityType = VolumeResponse.class, required = true, type = CommandType.UUID, description = "The ID of the volume")
private Long id;
@Parameter(name = ApiConstants.DISK_OFFERING_ID,
entityType = DiskOfferingResponse.class,
type = CommandType.UUID,
required = true,
- description = "new disk offering id")
+ description = "New disk offering ID")
private Long newDiskOfferingId;
@Parameter(name = ApiConstants.SIZE, type = CommandType.LONG, required = false, description = "New volume size in GB for the custom disk offering")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/CreateVolumeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/CreateVolumeCmd.java
index 7ffcea50b21..27b592aa8f1 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/CreateVolumeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/CreateVolumeCmd.java
@@ -43,7 +43,7 @@ import com.cloud.storage.Snapshot;
import com.cloud.storage.Volume;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "createVolume", responseObject = VolumeResponse.class, description = "Creates a disk volume from a disk offering. This disk volume must still be attached to a virtual machine to make use of it.", responseView = ResponseView.Restricted, entityType = {
+@APICommand(name = "createVolume", responseObject = VolumeResponse.class, description = "Creates a disk volume from a disk offering. This disk volume must still be attached to an Instance to make use of it.", responseView = ResponseView.Restricted, entityType = {
Volume.class, VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class CreateVolumeCmd extends BaseAsyncCreateCustomIdCmd implements UserCmd {
@@ -55,58 +55,58 @@ public class CreateVolumeCmd extends BaseAsyncCreateCustomIdCmd implements UserC
@Parameter(name = ApiConstants.ACCOUNT,
type = BaseCmd.CommandType.STRING,
- description = "the account associated with the disk volume. Must be used with the domainId parameter.")
+ description = "The Account associated with the disk volume. Must be used with the domainId parameter.")
private String accountName;
@Parameter(name = ApiConstants.PROJECT_ID,
type = CommandType.UUID,
entityType = ProjectResponse.class,
- description = "the project associated with the volume. Mutually exclusive with account parameter")
+ description = "The project associated with the volume. Mutually exclusive with Account parameter")
private Long projectId;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "the domain ID associated with the disk offering. If used with the account parameter"
- + " returns the disk volume associated with the account for the specified domain." +
- "If account is NOT provided then the volume will be assigned to the caller account and domain.")
+ description = "The domain ID associated with the disk offering. If used with the Account parameter"
+ + " returns the disk volume associated with the Account for the specified domain." +
+ "If account is NOT provided then the volume will be assigned to the caller Account and domain.")
private Long domainId;
@Parameter(name = ApiConstants.DISK_OFFERING_ID,
required = false,
type = CommandType.UUID,
entityType = DiskOfferingResponse.class,
- description = "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.")
+ description = "The ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.")
private Long diskOfferingId;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the disk volume")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the disk volume")
private String volumeName;
@Parameter(name = ApiConstants.SIZE, type = CommandType.LONG, description = "Arbitrary volume size")
private Long size;
- @Parameter(name = ApiConstants.MIN_IOPS, type = CommandType.LONG, description = "min iops")
+ @Parameter(name = ApiConstants.MIN_IOPS, type = CommandType.LONG, description = "Min IOPS")
private Long minIops;
- @Parameter(name = ApiConstants.MAX_IOPS, type = CommandType.LONG, description = "max iops")
+ @Parameter(name = ApiConstants.MAX_IOPS, type = CommandType.LONG, description = "Max IOPS")
private Long maxIops;
@Parameter(name = ApiConstants.SNAPSHOT_ID,
type = CommandType.UUID,
entityType = SnapshotResponse.class,
- description = "the snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.")
+ description = "The Snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.")
private Long snapshotId;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "the ID of the availability zone")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "The ID of the availability zone")
private Long zoneId;
- @Parameter(name = ApiConstants.DISPLAY_VOLUME, type = CommandType.BOOLEAN, description = "an optional field, whether to display the volume to the end user or not.", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.DISPLAY_VOLUME, type = CommandType.BOOLEAN, description = "An optional field, whether to display the volume to the end User or not.", authorized = {RoleType.Admin})
private Boolean displayVolume;
@Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID,
type = CommandType.UUID,
entityType = UserVmResponse.class,
- description = "the ID of the virtual machine; to be used with snapshot Id, VM to which the volume gets attached after creation")
+ description = "The ID of the Instance; to be used with snapshot Id, Instance to which the volume gets attached after creation")
private Long virtualMachineId;
/////////////////////////////////////////////////////
@@ -203,7 +203,7 @@ public class CreateVolumeCmd extends BaseAsyncCreateCustomIdCmd implements UserC
@Override
public String getEventDescription() {
- return "creating volume: " + getVolumeName() + ((getSnapshotId() == null) ? "" : " from snapshot: " + this._uuidMgr.getUuid(Snapshot.class, getSnapshotId()));
+ return "Creating volume: " + getVolumeName() + ((getSnapshotId() == null) ? "" : " from Snapshot: " + this._uuidMgr.getUuid(Snapshot.class, getSnapshotId()));
}
@Override
@@ -220,7 +220,7 @@ public class CreateVolumeCmd extends BaseAsyncCreateCustomIdCmd implements UserC
@Override
public void execute() {
- CallContext.current().setEventDetails("Volume Id: " + getEntityUuid() + ((getSnapshotId() == null) ? "" : " from snapshot: " + this._uuidMgr.getUuid(Snapshot.class, getSnapshotId())));
+ CallContext.current().setEventDetails("Volume Id: " + getEntityUuid() + ((getSnapshotId() == null) ? "" : " from Snapshot: " + this._uuidMgr.getUuid(Snapshot.class, getSnapshotId())));
Volume volume = _volumeService.createVolume(this);
if (volume != null) {
VolumeResponse response = _responseGenerator.createVolumeResponse(getResponseView(), volume);
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/DeleteVolumeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/DeleteVolumeCmd.java
index 6111488a802..e21103654c8 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/DeleteVolumeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/DeleteVolumeCmd.java
@@ -43,7 +43,7 @@ public class DeleteVolumeCmd extends BaseCmd {
@ACL(accessType = AccessType.OperateEntry)
@Parameter(name=ApiConstants.ID, type=CommandType.UUID, entityType=VolumeResponse.class,
- required=true, description="The ID of the disk volume")
+ required=true, description = "The ID of the disk volume")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/DestroyVolumeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/DestroyVolumeCmd.java
index 2eafb76e591..32ddec88086 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/DestroyVolumeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/DestroyVolumeCmd.java
@@ -50,7 +50,7 @@ public class DestroyVolumeCmd extends BaseAsyncCmd {
@ACL(accessType = AccessType.OperateEntry)
@Parameter(name=ApiConstants.ID, type=CommandType.UUID, entityType=VolumeResponse.class,
- required=true, description="The ID of the volume")
+ required=true, description = "The ID of the volume")
private Long id;
@Parameter(name = ApiConstants.EXPUNGE,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/DetachVolumeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/DetachVolumeCmd.java
index 2fddcace84d..9c8b8fcf6e6 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/DetachVolumeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/DetachVolumeCmd.java
@@ -38,7 +38,7 @@ import com.cloud.user.Account;
import com.cloud.uservm.UserVm;
import com.cloud.vm.VirtualMachine;
-@APICommand(name = "detachVolume", description = "Detaches a disk volume from a virtual machine.", responseObject = VolumeResponse.class, responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
+@APICommand(name = "detachVolume", description = "Detaches a disk volume from an Instance.", responseObject = VolumeResponse.class, responseView = ResponseView.Restricted, entityType = {VirtualMachine.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class DetachVolumeCmd extends BaseAsyncCmd implements UserCmd {
private static final String s_name = "detachvolumeresponse";
@@ -48,17 +48,17 @@ public class DetachVolumeCmd extends BaseAsyncCmd implements UserCmd {
/////////////////////////////////////////////////////
@Parameter(name=ApiConstants.ID, type=CommandType.UUID, entityType=VolumeResponse.class,
- description="the ID of the disk volume")
+ description= " The ID of the disk volume")
private Long id;
- @Parameter(name = ApiConstants.DEVICE_ID, type = CommandType.LONG, description = "the device ID on the virtual machine where volume is detached from")
+ @Parameter(name = ApiConstants.DEVICE_ID, type = CommandType.LONG, description = "The device ID on the Instance where volume is detached from")
private Long deviceId;
@ACL(accessType = AccessType.OperateEntry)
@Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID,
type = CommandType.UUID,
entityType = UserVmResponse.class,
- description = "the ID of the virtual machine where the volume is detached from")
+ description = "The ID of the Instance where the volume is detached from")
private Long virtualMachineId;
/////////////////////////////////////////////////////
@@ -130,7 +130,7 @@ public class DetachVolumeCmd extends BaseAsyncCmd implements UserCmd {
if (id != null) {
sb.append(": " + this._uuidMgr.getUuid(Volume.class, id));
} else if ((deviceId != null) && (virtualMachineId != null)) {
- sb.append(" with device id: " + deviceId + " from vm: " + ((getVirtualMachineId() != null) ? this._uuidMgr.getUuid(VirtualMachine.class, getVirtualMachineId()) : "" ));
+ sb.append(" with device id: " + deviceId + " from Instance: " + ((getVirtualMachineId() != null) ? this._uuidMgr.getUuid(VirtualMachine.class, getVirtualMachineId()) : "" ));
} else {
sb.append(" ");
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/ExtractVolumeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/ExtractVolumeCmd.java
index 6ddb5f1e567..2b225f4fd34 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/ExtractVolumeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/ExtractVolumeCmd.java
@@ -47,20 +47,20 @@ public class ExtractVolumeCmd extends BaseAsyncCmd {
@ACL(accessType = AccessType.OperateEntry)
@Parameter(name=ApiConstants.ID, type=CommandType.UUID, entityType=VolumeResponse.class,
- required=true, description="the ID of the volume")
+ required=true, description = "The ID of the volume")
private Long id;
- @Parameter(name = ApiConstants.URL, type = CommandType.STRING, required = false, length = 2048, description = "the url to which the volume would be extracted")
+ @Parameter(name = ApiConstants.URL, type = CommandType.STRING, required = false, length = 2048, description = "The URL to which the volume would be extracted")
private String url;
@Parameter(name = ApiConstants.ZONE_ID,
type = CommandType.UUID,
entityType = ZoneResponse.class,
required = true,
- description = "the ID of the zone where the volume is located")
+ description = "The ID of the zone where the volume is located")
private Long zoneId;
- @Parameter(name = ApiConstants.MODE, type = CommandType.STRING, required = true, description = "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD")
+ @Parameter(name = ApiConstants.MODE, type = CommandType.STRING, required = true, description = "The mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD")
private String mode;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/GetUploadParamsForVolumeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/GetUploadParamsForVolumeCmd.java
index 4ccd5f97993..0020fe4021e 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/GetUploadParamsForVolumeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/GetUploadParamsForVolumeCmd.java
@@ -40,7 +40,7 @@ public class GetUploadParamsForVolumeCmd extends AbstractGetUploadParamsCmd {
@Parameter(name = ApiConstants.IMAGE_STORE_UUID, type = CommandType.STRING, description = "Image store uuid")
private String imageStoreUuid;
- @Parameter(name = ApiConstants.DISK_OFFERING_ID, required = false, type = CommandType.UUID, entityType = DiskOfferingResponse.class, description = "the ID of the disk "
+ @Parameter(name = ApiConstants.DISK_OFFERING_ID, required = false, type = CommandType.UUID, entityType = DiskOfferingResponse.class, description = "The ID of the disk "
+ "offering. This must be a custom sized offering since during upload of volume/template size is unknown.")
private Long diskOfferingId;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/ListResourceDetailsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/ListResourceDetailsCmd.java
index 318836d8d87..93a2445ee8f 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/ListResourceDetailsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/ListResourceDetailsCmd.java
@@ -34,20 +34,20 @@ import com.cloud.server.ResourceTag;
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListResourceDetailsCmd extends BaseListProjectAndAccountResourcesCmd {
- @Parameter(name = ApiConstants.RESOURCE_TYPE, type = CommandType.STRING, description = "list by resource type", required = true)
+ @Parameter(name = ApiConstants.RESOURCE_TYPE, type = CommandType.STRING, description = "List by resource type", required = true)
private String resourceType;
- @Parameter(name = ApiConstants.RESOURCE_ID, type = CommandType.STRING, description = "list by resource id")
+ @Parameter(name = ApiConstants.RESOURCE_ID, type = CommandType.STRING, description = "List by resource ID")
private String resourceId;
- @Parameter(name = ApiConstants.KEY, type = CommandType.STRING, description = "list by key")
+ @Parameter(name = ApiConstants.KEY, type = CommandType.STRING, description = "List by key")
private String key;
- @Parameter(name = ApiConstants.VALUE, type = CommandType.STRING, description = "list by key, value. Needs to be passed only along with key" ,
+ @Parameter(name = ApiConstants.VALUE, type = CommandType.STRING, description = "List by key, value. Needs to be passed only along with key" ,
since = "4.4", authorized = { RoleType.Admin })
private String value;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "if set to true, only details marked with display=true, are returned."
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "If set to true, only details marked with display=true, are returned."
+ " False by default", since = "4.3", authorized = { RoleType.Admin })
private Boolean forDisplay;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/ListVolumesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/ListVolumesCmd.java
index a1024a98898..a4cd299dae9 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/ListVolumesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/ListVolumesCmd.java
@@ -50,55 +50,55 @@ public class ListVolumesCmd extends BaseListRetrieveOnlyResourceCountCmd impleme
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.HOST_ID, type = CommandType.UUID, entityType = HostResponse.class, description = "list volumes on specified host")
+ @Parameter(name = ApiConstants.HOST_ID, type = CommandType.UUID, entityType = HostResponse.class, description = "List volumes on specified host")
private Long hostId;
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VolumeResponse.class, description = "the ID of the disk volume")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VolumeResponse.class, description = "The ID of the disk volume")
private Long id;
- @Parameter(name = ApiConstants.IDS, type = CommandType.LIST, collectionType = CommandType.UUID, entityType = VolumeResponse.class, description = "the IDs of the volumes, mutually exclusive with id", since = "4.9")
+ @Parameter(name = ApiConstants.IDS, type = CommandType.LIST, collectionType = CommandType.UUID, entityType = VolumeResponse.class, description = "The IDs of the volumes, mutually exclusive with id", since = "4.9")
private List ids;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the disk volume")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the disk volume")
private String volumeName;
- @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "the pod id the disk volume belongs to")
+ @Parameter(name = ApiConstants.POD_ID, type = CommandType.UUID, entityType = PodResponse.class, description = "The pod ID the disk volume belongs to")
private Long podId;
- @Parameter(name = ApiConstants.CLUSTER_ID, type = CommandType.UUID, entityType = ClusterResponse.class, description = "the cluster id the disk volume belongs to", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.CLUSTER_ID, type = CommandType.UUID, entityType = ClusterResponse.class, description = "The cluster ID the disk volume belongs to", authorized = {RoleType.Admin})
private Long clusterId;
- @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, description = "the type of disk volume")
+ @Parameter(name = ApiConstants.TYPE, type = CommandType.STRING, description = "The type of disk volume")
private String type;
- @Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID, type = CommandType.UUID, entityType = UserVmResponse.class, description = "the ID of the virtual machine")
+ @Parameter(name = ApiConstants.VIRTUAL_MACHINE_ID, type = CommandType.UUID, entityType = UserVmResponse.class, description = "The ID of the Instance")
private Long virtualMachineId;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "the ID of the availability zone")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "The ID of the availability zone")
private Long zoneId;
- @Parameter(name = ApiConstants.STORAGE_ID, type = CommandType.STRING, entityType = StoragePoolResponse.class, description = "the ID of the storage pool, available to ROOT admin only", since = "4.3", authorized = {
+ @Parameter(name = ApiConstants.STORAGE_ID, type = CommandType.STRING, entityType = StoragePoolResponse.class, description = "The ID of the storage pool, available to ROOT admin only", since = "4.3", authorized = {
RoleType.Admin})
private String storageId;
@Parameter(name = ApiConstants.SERVICE_OFFERING_ID, type = CommandType.UUID,
entityType = ServiceOfferingResponse.class,
- description = "list volumes by disk offering of a service offering. If both service offering and " +
+ description = "List volumes by disk offering of a service offering. If both service offering and " +
"disk offering are passed, service offering is ignored", since = "4.19.1")
private Long serviceOfferingId;
- @Parameter(name = ApiConstants.DISK_OFFERING_ID, type = CommandType.UUID, entityType = DiskOfferingResponse.class, description = "list volumes by disk offering", since = "4.4")
+ @Parameter(name = ApiConstants.DISK_OFFERING_ID, type = CommandType.UUID, entityType = DiskOfferingResponse.class, description = "List volumes by disk offering", since = "4.4")
private Long diskOfferingId;
- @Parameter(name = ApiConstants.DISPLAY_VOLUME, type = CommandType.BOOLEAN, description = "list resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {
+ @Parameter(name = ApiConstants.DISPLAY_VOLUME, type = CommandType.BOOLEAN, description = "List resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {
RoleType.Admin})
private Boolean display;
- @Parameter(name = ApiConstants.LIST_SYSTEM_VMS, type = CommandType.BOOLEAN, description = "list system VMs; only ROOT admin is eligible to pass this parameter", since = "4.18",
+ @Parameter(name = ApiConstants.LIST_SYSTEM_VMS, type = CommandType.BOOLEAN, description = "List system VMs; only ROOT admin is eligible to pass this parameter", since = "4.18",
authorized = { RoleType.Admin })
private Boolean listSystemVms;
- @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.")
+ @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "State of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.")
private String state;
@Parameter(name = ApiConstants.IS_ENCRYPTED, type = CommandType.BOOLEAN, description = "list only volumes that are encrypted", since = "4.19.1",
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/MigrateVolumeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/MigrateVolumeCmd.java
index a0a50c5b9fc..ea6890ac3e8 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/MigrateVolumeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/MigrateVolumeCmd.java
@@ -43,13 +43,13 @@ public class MigrateVolumeCmd extends BaseAsyncCmd implements UserCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.VOLUME_ID, type = CommandType.UUID, entityType = VolumeResponse.class, required = true, description = "the ID of the volume")
+ @Parameter(name = ApiConstants.VOLUME_ID, type = CommandType.UUID, entityType = VolumeResponse.class, required = true, description = "The ID of the volume")
private Long volumeId;
- @Parameter(name = ApiConstants.STORAGE_ID, type = CommandType.UUID, entityType = StoragePoolResponse.class, required = true, description = "destination storage pool ID to migrate the volume to")
+ @Parameter(name = ApiConstants.STORAGE_ID, type = CommandType.UUID, entityType = StoragePoolResponse.class, required = true, description = "Destination storage pool ID to migrate the volume to")
private Long storageId;
- @Parameter(name = ApiConstants.LIVE_MIGRATE, type = CommandType.BOOLEAN, required = false, description = "if the volume should be live migrated when it is attached to a running vm")
+ @Parameter(name = ApiConstants.LIVE_MIGRATE, type = CommandType.BOOLEAN, required = false, description = "If the volume should be live migrated when it is attached to a running Instance")
private Boolean liveMigrate;
@Parameter(name = ApiConstants.NEW_DISK_OFFERING_ID, type = CommandType.UUID, entityType = DiskOfferingResponse.class, description = "The new disk offering ID that replaces the current one used by the volume. This new disk offering is used to better reflect the new storage where the volume is going to be migrated to.")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/ResizeVolumeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/ResizeVolumeCmd.java
index eb89115cf46..5b2b6709cf6 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/ResizeVolumeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/ResizeVolumeCmd.java
@@ -51,7 +51,7 @@ public class ResizeVolumeCmd extends BaseAsyncCmd implements UserCmd {
/////////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name = ApiConstants.ID, entityType = VolumeResponse.class, required = true, type = CommandType.UUID, description = "the ID of the disk volume")
+ @Parameter(name = ApiConstants.ID, entityType = VolumeResponse.class, required = true, type = CommandType.UUID, description = "The ID of the disk volume")
private Long id;
@Parameter(name = ApiConstants.MIN_IOPS, type = CommandType.LONG, required = false, description = "New minimum number of IOPS")
@@ -70,7 +70,7 @@ public class ResizeVolumeCmd extends BaseAsyncCmd implements UserCmd {
entityType = DiskOfferingResponse.class,
type = CommandType.UUID,
required = false,
- description = "new disk offering id")
+ description = "New disk offering ID")
private Long newDiskOfferingId;
@Parameter(name = ApiConstants.AUTO_MIGRATE, type = CommandType.BOOLEAN, required = false,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/UpdateVolumeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/UpdateVolumeCmd.java
index 22b819c8cba..0d3fc59a528 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/UpdateVolumeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/UpdateVolumeCmd.java
@@ -47,7 +47,7 @@ public class UpdateVolumeCmd extends BaseAsyncCustomIdCmd implements UserCmd {
/////////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name=ApiConstants.ID, type=CommandType.UUID, entityType=VolumeResponse.class, description="the ID of the disk volume")
+ @Parameter(name=ApiConstants.ID, type=CommandType.UUID, entityType=VolumeResponse.class, description = "The ID of the disk volume")
private Long id;
@Parameter(name = ApiConstants.PATH, type = CommandType.STRING, description = "The path of the volume", authorized = {RoleType.Admin})
@@ -71,10 +71,10 @@ public class UpdateVolumeCmd extends BaseAsyncCustomIdCmd implements UserCmd {
@Parameter(name = ApiConstants.DISPLAY_VOLUME,
type = CommandType.BOOLEAN,
- description = "an optional field, whether to the display the volume to the end user or not.", authorized = {RoleType.Admin})
+ description = "An optional field, whether to the display the volume to the end User or not.", authorized = {RoleType.Admin})
private Boolean displayVolume;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "new name of the volume", since = "4.16")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "New name of the volume", since = "4.16")
private String name;
@Parameter(name = ApiConstants.DELETE_PROTECTION,
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/UploadVolumeCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/UploadVolumeCmd.java
index 339c276d59e..3d23a631722 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/volume/UploadVolumeCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/volume/UploadVolumeCmd.java
@@ -53,36 +53,36 @@ public class UploadVolumeCmd extends BaseAsyncCmd implements UserCmd {
@Parameter(name = ApiConstants.FORMAT,
type = CommandType.STRING,
required = true,
- description = "the format for the volume. Possible values include QCOW2, OVA, and VHD.")
+ description = "The format for the volume. Possible values include QCOW2, OVA, and VHD.")
private String format;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "the name of the volume")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "The name of the volume")
private String volumeName;
@Parameter(name = ApiConstants.URL,
type = CommandType.STRING,
required = true,
length = 2048,
- description = "the URL of where the volume is hosted. Possible URL include http:// and https://")
+ description = "The URL of where the volume is hosted. Possible URL include http:// and https://")
private String url;
@Parameter(name = ApiConstants.ZONE_ID,
type = CommandType.UUID,
entityType = ZoneResponse.class,
required = true,
- description = "the ID of the zone the volume is to be hosted on")
+ description = "The ID of the zone the volume is to be hosted on")
private Long zoneId;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "an optional domainId. If the account parameter is used, domainId must also be used. If account is NOT provided then volume will be assigned to the caller account and domain.")
+ description = "An optional domainId. If the Account parameter is used, domainId must also be used. If Account is NOT provided then volume will be assigned to the caller Account and domain.")
private Long domainId;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "an optional accountName. Must be used with domainId.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "An optional accountName. Must be used with domainId.")
private String accountName;
- @Parameter(name = ApiConstants.CHECKSUM, type = CommandType.STRING, description = "the checksum value of this volume. " + ApiConstants.CHECKSUM_PARAMETER_PREFIX_DESCRIPTION)
+ @Parameter(name = ApiConstants.CHECKSUM, type = CommandType.STRING, description = "The checksum value of this volume. " + ApiConstants.CHECKSUM_PARAMETER_PREFIX_DESCRIPTION)
private String checksum;
@Parameter(name = ApiConstants.IMAGE_STORE_UUID, type = CommandType.STRING, description = "Image store uuid")
@@ -91,7 +91,7 @@ public class UploadVolumeCmd extends BaseAsyncCmd implements UserCmd {
@Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "Upload volume for the project")
private Long projectId;
- @Parameter(name = ApiConstants.DISK_OFFERING_ID, required = false, type = CommandType.UUID, entityType = DiskOfferingResponse.class, description = "the ID of the disk offering. This must be a custom sized offering since during uploadVolume volume size is unknown.")
+ @Parameter(name = ApiConstants.DISK_OFFERING_ID, required = false, type = CommandType.UUID, entityType = DiskOfferingResponse.class, description = "The ID of the disk offering. This must be a custom sized offering since during uploadVolume volume size is unknown.")
private Long diskOfferingId;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/CreatePrivateGatewayCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/CreatePrivateGatewayCmd.java
index dceaabf648d..7755abce6f7 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/CreatePrivateGatewayCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/CreatePrivateGatewayCmd.java
@@ -44,7 +44,7 @@ import com.cloud.network.vpc.PrivateGateway;
import com.cloud.network.vpc.Vpc;
import com.cloud.network.vpc.VpcGateway;
-@APICommand(name = "createPrivateGateway", description = "Creates a private gateway",
+@APICommand(name = "createPrivateGateway", description = "Creates a private Gateway",
responseObject = PrivateGatewayResponse.class,
responseView = ResponseView.Restricted,
entityType = {VpcGateway.class},
@@ -58,40 +58,40 @@ public class CreatePrivateGatewayCmd extends BaseAsyncCreateCmd implements UserC
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.GATEWAY, type = CommandType.STRING, required = true, description = "the gateway of the Private gateway")
+ @Parameter(name = ApiConstants.GATEWAY, type = CommandType.STRING, required = true, description = "The Gateway of the Private Gateway")
private String gateway;
- @Parameter(name = ApiConstants.NETMASK, type = CommandType.STRING, required = true, description = "the netmask of the Private gateway")
+ @Parameter(name = ApiConstants.NETMASK, type = CommandType.STRING, required = true, description = "The Netmask of the Private Gateway")
private String netmask;
- @Parameter(name = ApiConstants.IP_ADDRESS, type = CommandType.STRING, required = true, description = "the IP address of the Private gateaway")
+ @Parameter(name = ApiConstants.IP_ADDRESS, type = CommandType.STRING, required = true, description = "The IP address of the Private Gateway")
private String ipAddress;
@Parameter(name = ApiConstants.NETWORK_OFFERING_ID,
type = CommandType.UUID,
required = false,
entityType = NetworkOfferingResponse.class,
- description = "the uuid of the network offering to use for the private gateways network connection")
+ description = "The UUID of the Network offering to use for the private gateways Network connection")
private Long networkOfferingId;
- @Parameter(name = ApiConstants.VPC_ID, type = CommandType.UUID, entityType = VpcResponse.class, required = true, description = "the VPC network belongs to")
+ @Parameter(name = ApiConstants.VPC_ID, type = CommandType.UUID, entityType = VpcResponse.class, required = true, description = "The VPC Network belongs to")
private Long vpcId;
@Parameter(name = ApiConstants.SOURCE_NAT_SUPPORTED,
type = CommandType.BOOLEAN,
required = false,
- description = "source NAT supported value. Default value false. If 'true' source NAT is enabled on the private gateway"
+ description = "Source NAT supported value. Default value: false. When 'true', the source NAT is enabled on the private gateway"
+ " 'false': sourcenat is not supported")
private Boolean isSourceNat;
- @Parameter(name = ApiConstants.ACL_ID, type = CommandType.UUID, entityType = NetworkACLResponse.class, required = false, description = "the ID of the network ACL")
+ @Parameter(name = ApiConstants.ACL_ID, type = CommandType.UUID, entityType = NetworkACLResponse.class, required = false, description = "The ID of the Network ACL")
private Long aclId;
@Parameter(name = ApiConstants.ASSOCIATED_NETWORK_ID,
type = CommandType.UUID,
entityType = NetworkResponse.class,
since = "4.17.0",
- description = "The isolated network this private gateway is associated to.")
+ description = "The Isolated Network this private gateway is associated to.")
private Long associatedNetworkId;
/////////////////////////////////////////////////////
@@ -179,7 +179,7 @@ public class CreatePrivateGatewayCmd extends BaseAsyncCreateCmd implements UserC
public long getEntityOwnerId() {
Vpc vpc = _entityMgr.findById(Vpc.class, vpcId);
if (vpc == null) {
- throw new InvalidParameterValueException("Invalid id is specified for the vpc");
+ throw new InvalidParameterValueException("Invalid id is specified for the VPC");
}
return vpc.getAccountId();
}
@@ -203,7 +203,7 @@ public class CreatePrivateGatewayCmd extends BaseAsyncCreateCmd implements UserC
public Long getSyncObjId() {
Vpc vpc = _entityMgr.findById(Vpc.class, vpcId);
if (vpc == null) {
- throw new InvalidParameterValueException("Invalid id is specified for the vpc");
+ throw new InvalidParameterValueException("Invalid ID is specified for the VPC");
}
return vpc.getId();
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/CreateStaticRouteCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/CreateStaticRouteCmd.java
index b28c02cb800..819aae18794 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/CreateStaticRouteCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/CreateStaticRouteCmd.java
@@ -46,10 +46,10 @@ public class CreateStaticRouteCmd extends BaseAsyncCreateCmd {
type = CommandType.UUID,
entityType = PrivateGatewayResponse.class,
required = true,
- description = "the gateway id we are creating static route for")
+ description = "The gateway ID we are creating static route for")
private Long gatewayId;
- @Parameter(name = ApiConstants.CIDR, required = true, type = CommandType.STRING, description = "static route cidr")
+ @Parameter(name = ApiConstants.CIDR, required = true, type = CommandType.STRING, description = "Static route CIDR")
private String cidr;
/////////////////////////////////////////////////////
@@ -107,7 +107,7 @@ public class CreateStaticRouteCmd extends BaseAsyncCreateCmd {
} finally {
if (!success || route == null) {
_entityMgr.remove(StaticRoute.class, getEntityId());
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create static route");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create a static route");
}
}
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/CreateVPCCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/CreateVPCCmd.java
index 2f62d0d7210..8b45e1b501a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/CreateVPCCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/CreateVPCCmd.java
@@ -51,24 +51,24 @@ public class CreateVPCCmd extends BaseAsyncCreateCmd implements UserCmd {
// ////////////// API parameters /////////////////////
// ///////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "the account associated with the VPC. " +
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "The Account associated with the VPC. " +
"Must be used with the domainId parameter.")
private String accountName;
@Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class,
- description = "the domain ID associated with the VPC. " +
- "If used with the account parameter returns the VPC associated with the account for the specified domain.")
+ description = "The domain ID associated with the VPC. " +
+ "If used with the Account parameter returns the VPC associated with the Account for the specified domain.")
private Long domainId;
@Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class,
- description = "create VPC for the project")
+ description = "Create VPC for the project")
private Long projectId;
@Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class,
- required = true, description = "the ID of the availability zone")
+ required = true, description = "The ID of the availability zone")
private Long zoneId;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "the name of the VPC")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = true, description = "The name of the VPC")
private String vpcName;
@Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "The display text of the VPC, defaults to its 'name'.")
@@ -76,7 +76,7 @@ public class CreateVPCCmd extends BaseAsyncCreateCmd implements UserCmd {
private String displayText;
@Parameter(name = ApiConstants.CIDR, type = CommandType.STRING,
- description = "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR")
+ description = "The CIDR of the VPC. All VPC Guest Network's CIDRs should be within this CIDR")
private String cidr;
@Parameter(name = ApiConstants.CIDR_SIZE, type = CommandType.INTEGER,
@@ -85,40 +85,40 @@ public class CreateVPCCmd extends BaseAsyncCreateCmd implements UserCmd {
private Integer cidrSize;
@Parameter(name = ApiConstants.VPC_OFF_ID, type = CommandType.UUID, entityType = VpcOfferingResponse.class,
- required = true, description = "the ID of the VPC offering")
+ required = true, description = "The ID of the VPC offering")
private Long vpcOffering;
@Parameter(name = ApiConstants.NETWORK_DOMAIN, type = CommandType.STRING,
- description = "VPC network domain. All networks inside the VPC will belong to this domain")
+ description = "VPC Network domain. All Networks inside the VPC will belong to this domain")
private String networkDomain;
@Parameter(name = ApiConstants.START, type = CommandType.BOOLEAN,
- description = "If set to false, the VPC won't start (VPC VR will not get allocated) until its first network gets implemented. " +
+ description = "If set to false, the VPC won't start (VPC VR will not get allocated) until its first Network gets implemented. " +
"True by default.", since = "4.3")
private Boolean start;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the vpc to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the VPC to the end User or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
@Parameter(name = ApiConstants.PUBLIC_MTU, type = CommandType.INTEGER,
- description = "MTU to be configured on the network VR's public facing interfaces", since = "4.18.0")
+ description = "MTU to be configured on the Network VR's public facing interfaces", since = "4.18.0")
private Integer publicMtu;
- @Parameter(name = ApiConstants.DNS1, type = CommandType.STRING, description = "the first IPv4 DNS for the VPC", since = "4.18.0")
+ @Parameter(name = ApiConstants.DNS1, type = CommandType.STRING, description = "The first IPv4 DNS for the VPC", since = "4.18.0")
private String ip4Dns1;
- @Parameter(name = ApiConstants.DNS2, type = CommandType.STRING, description = "the second IPv4 DNS for the VPC", since = "4.18.0")
+ @Parameter(name = ApiConstants.DNS2, type = CommandType.STRING, description = "The second IPv4 DNS for the VPC", since = "4.18.0")
private String ip4Dns2;
- @Parameter(name = ApiConstants.IP6_DNS1, type = CommandType.STRING, description = "the first IPv6 DNS for the VPC", since = "4.18.0")
+ @Parameter(name = ApiConstants.IP6_DNS1, type = CommandType.STRING, description = "The first IPv6 DNS for the VPC", since = "4.18.0")
private String ip6Dns1;
- @Parameter(name = ApiConstants.IP6_DNS2, type = CommandType.STRING, description = "the second IPv6 DNS for the VPC", since = "4.18.0")
+ @Parameter(name = ApiConstants.IP6_DNS2, type = CommandType.STRING, description = "The second IPv6 DNS for the VPC", since = "4.18.0")
private String ip6Dns2;
- @Parameter(name = ApiConstants.SOURCE_NAT_IP, type = CommandType.STRING, description = "IPV4 address to be assigned to the public interface of the network router." +
- "This address will be used as source NAT address for the networks in ths VPC. " +
- "\nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,",
+ @Parameter(name = ApiConstants.SOURCE_NAT_IP, type = CommandType.STRING, description = "IPv4 address to be assigned to the public interface of the Network router." +
+ "This address will be used as source NAT address for the Networks in ths VPC. " +
+ "\nIf an address is given and it cannot be acquired, an error will be returned and the Network won´t be implemented,",
since = "4.19")
private String sourceNatIP;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/DeleteStaticRouteCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/DeleteStaticRouteCmd.java
index 01b6aae425b..532a4108076 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/DeleteStaticRouteCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/DeleteStaticRouteCmd.java
@@ -44,7 +44,7 @@ public class DeleteStaticRouteCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = StaticRouteResponse.class, required = true, description = "the ID of the static route")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = StaticRouteResponse.class, required = true, description = "The ID of the static route")
private Long id;
// unexposed parameter needed for events logging
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/DeleteVPCCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/DeleteVPCCmd.java
index c35d9084bcc..ccaac2b1e29 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/DeleteVPCCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/DeleteVPCCmd.java
@@ -43,7 +43,7 @@ public class DeleteVPCCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VpcResponse.class, required = true, description = "the ID of the VPC")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VpcResponse.class, required = true, description = "The ID of the VPC")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/ListPrivateGatewaysCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/ListPrivateGatewaysCmd.java
index 2304cef3c6d..aadef68d5ae 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/ListPrivateGatewaysCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/ListPrivateGatewaysCmd.java
@@ -43,19 +43,19 @@ public class ListPrivateGatewaysCmd extends BaseListProjectAndAccountResourcesCm
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = PrivateGatewayResponse.class, description = "list private gateway by id")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = PrivateGatewayResponse.class, description = "List private gateway by ID")
private Long id;
- @Parameter(name = ApiConstants.IP_ADDRESS, type = CommandType.STRING, description = "list gateways by ip address")
+ @Parameter(name = ApiConstants.IP_ADDRESS, type = CommandType.STRING, description = "List gateways by IP address")
private String ipAddress;
- @Parameter(name = ApiConstants.VLAN, type = CommandType.STRING, description = "list gateways by vlan")
+ @Parameter(name = ApiConstants.VLAN, type = CommandType.STRING, description = "List gateways by VLAN")
private String vlan;
- @Parameter(name = ApiConstants.VPC_ID, type = CommandType.UUID, entityType = VpcResponse.class, description = "list gateways by vpc")
+ @Parameter(name = ApiConstants.VPC_ID, type = CommandType.UUID, entityType = VpcResponse.class, description = "List gateways by VPC")
private Long vpcId;
- @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "list gateways by state")
+ @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "List gateways by state")
private String state;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/ListStaticRoutesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/ListStaticRoutesCmd.java
index 36574e2a777..babc38bc42f 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/ListStaticRoutesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/ListStaticRoutesCmd.java
@@ -38,16 +38,16 @@ public class ListStaticRoutesCmd extends BaseListTaggedResourcesCmd {
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = StaticRouteResponse.class, description = "list static route by id")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = StaticRouteResponse.class, description = "List static route by ID")
private Long id;
- @Parameter(name = ApiConstants.VPC_ID, type = CommandType.UUID, entityType = VpcResponse.class, description = "list static routes by vpc id")
+ @Parameter(name = ApiConstants.VPC_ID, type = CommandType.UUID, entityType = VpcResponse.class, description = "List static routes by VPC ID")
private Long vpcId;
- @Parameter(name = ApiConstants.GATEWAY_ID, type = CommandType.UUID, entityType = PrivateGatewayResponse.class, description = "list static routes by gateway id")
+ @Parameter(name = ApiConstants.GATEWAY_ID, type = CommandType.UUID, entityType = PrivateGatewayResponse.class, description = "List static routes by gateway ID")
private Long gatewayId;
- @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "list static routes by state")
+ @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "List static routes by state")
private String state;
public Long getId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/ListVPCOfferingsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/ListVPCOfferingsCmd.java
index f48e113286a..7d603a85993 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/ListVPCOfferingsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/ListVPCOfferingsCmd.java
@@ -38,38 +38,38 @@ public class ListVPCOfferingsCmd extends BaseListCmd {
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VpcOfferingResponse.class, description = "list VPC offerings by id")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VpcOfferingResponse.class, description = "List VPC offerings by ID")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "list VPC offerings by name")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "List VPC offerings by name")
private String vpcOffName;
- @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "list VPC offerings by display text")
+ @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "List VPC offerings by display text")
private String displayText;
- @Parameter(name = ApiConstants.IS_DEFAULT, type = CommandType.BOOLEAN, description = "true if need to list only default " + "VPC offerings. Default value is false")
+ @Parameter(name = ApiConstants.IS_DEFAULT, type = CommandType.BOOLEAN, description = "True if need to list only default " + "VPC offerings. Default value is false")
private Boolean isDefault;
@Parameter(name = ApiConstants.SUPPORTED_SERVICES,
type = CommandType.LIST,
collectionType = CommandType.STRING,
- description = "list VPC offerings supporting certain services")
+ description = "List VPC offerings supporting certain services")
private List supportedServices;
- @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "list VPC offerings by state")
+ @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "List VPC offerings by state")
private String state;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "list VPC offerings available for VPC creation in specific domain",
+ description = "List VPC offerings available for VPC creation in specific domain",
since = "4.18")
private Long domainId;
@Parameter(name = ApiConstants.ZONE_ID,
type = CommandType.UUID,
entityType = ZoneResponse.class,
- description = "id of zone VPC offering is associated with",
+ description = "ID of zone VPC offering is associated with",
since = "4.13")
private Long zoneId;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/ListVPCsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/ListVPCsCmd.java
index d128be1414d..c4597d9b986 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/ListVPCsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/ListVPCsCmd.java
@@ -46,39 +46,39 @@ public class ListVPCsCmd extends BaseListTaggedResourcesCmd implements UserCmd {
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VpcResponse.class, description = "list VPC by id")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VpcResponse.class, description = "List VPC by ID")
private Long id;
- @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "list by zone")
+ @Parameter(name = ApiConstants.ZONE_ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "List by zone")
private Long zoneId;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "list by name of the VPC")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "List by name of the VPC")
private String vpcName;
- @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "List by display text of " + "the VPC")
+ @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "List by display text of " + "The VPC")
private String displayText;
- @Parameter(name = ApiConstants.CIDR, type = CommandType.STRING, description = "list by cidr of the VPC. All VPC "
- + "guest networks' cidrs should be within this CIDR")
+ @Parameter(name = ApiConstants.CIDR, type = CommandType.STRING, description = "List by CIDR of the VPC. All VPC "
+ + "Guest Network's CIDRs should be within this CIDR")
private String cidr;
- @Parameter(name = ApiConstants.VPC_OFF_ID, type = CommandType.UUID, entityType = VpcOfferingResponse.class, description = "list by ID of the VPC offering")
+ @Parameter(name = ApiConstants.VPC_OFF_ID, type = CommandType.UUID, entityType = VpcOfferingResponse.class, description = "List by ID of the VPC offering")
private Long VpcOffId;
- @Parameter(name = ApiConstants.SUPPORTED_SERVICES, type = CommandType.LIST, collectionType = CommandType.STRING, description = "list VPC supporting certain services")
+ @Parameter(name = ApiConstants.SUPPORTED_SERVICES, type = CommandType.LIST, collectionType = CommandType.STRING, description = "List VPC supporting certain services")
private List supportedServices;
- @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "list VPCs by state")
+ @Parameter(name = ApiConstants.STATE, type = CommandType.STRING, description = "List VPCs by state")
private String state;
- @Parameter(name = ApiConstants.RESTART_REQUIRED, type = CommandType.BOOLEAN, description = "list VPCs by restartRequired option")
+ @Parameter(name = ApiConstants.RESTART_REQUIRED, type = CommandType.BOOLEAN, description = "List VPCs by restartRequired option")
private Boolean restartRequired;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "list resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "List resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
@Parameter(name = ApiConstants.SHOW_RESOURCE_ICON, type = CommandType.BOOLEAN,
- description = "flag to display the resource icon for VPCs")
+ description = "Flag to display the resource icon for VPCs")
private Boolean showIcon;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/RestartVPCCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/RestartVPCCmd.java
index 5ccd496eeb4..9dadf061753 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/RestartVPCCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/RestartVPCCmd.java
@@ -43,10 +43,10 @@ public class RestartVPCCmd extends BaseAsyncCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VpcResponse.class, required = true, description = "the id of the VPC")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VpcResponse.class, required = true, description = "The ID of the VPC")
private Long id;
- @Parameter(name = ApiConstants.CLEANUP, type = CommandType.BOOLEAN, required = false, description = "If cleanup old network elements")
+ @Parameter(name = ApiConstants.CLEANUP, type = CommandType.BOOLEAN, required = false, description = "Should we cleanup the old Network elements")
private Boolean cleanup = false;
@Parameter(name = ApiConstants.MAKEREDUNDANT, type = CommandType.BOOLEAN, required = false, description = "Turn a single VPC into a redundant one.")
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/UpdateVPCCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/UpdateVPCCmd.java
index 6fcfb5311f6..88e38649802 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/UpdateVPCCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpc/UpdateVPCCmd.java
@@ -47,25 +47,25 @@ public class UpdateVPCCmd extends BaseAsyncCustomIdCmd implements UserCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
@ACL(accessType = AccessType.OperateEntry)
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VpcResponse.class, required = true, description = "the id of the VPC")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VpcResponse.class, required = true, description = "The ID of the VPC")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the VPC")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the VPC")
private String vpcName;
- @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "the display text of the VPC")
+ @Parameter(name = ApiConstants.DISPLAY_TEXT, type = CommandType.STRING, description = "The display text of the VPC")
private String displayText;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the vpc to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "Optional field, should we display the VPC to the end User or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
@Parameter(name = ApiConstants.PUBLIC_MTU, type = CommandType.INTEGER,
- description = "MTU to be configured on the network VR's public facing interfaces", since = "4.18.0")
+ description = "MTU to be configured on the Network VR's public facing interfaces", since = "4.18.0")
private Integer publicMtu;
@Parameter(name = ApiConstants.SOURCE_NAT_IP,
type = CommandType.STRING,
- description = "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this VPC",
+ description = "IPV4 address to be assigned to the public interface of the Network router. This address must already be acquired for this VPC",
since = "4.19")
private String sourceNatIP;
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/AddVpnUserCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/AddVpnUserCmd.java
index 59ba7e94b04..6910ce5b371 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/AddVpnUserCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/AddVpnUserCmd.java
@@ -33,7 +33,7 @@ import com.cloud.event.EventTypes;
import com.cloud.network.VpnUser;
import com.cloud.user.Account;
-@APICommand(name = "addVpnUser", description = "Adds vpn users", responseObject = VpnUsersResponse.class, entityType = {VpnUser.class},
+@APICommand(name = "addVpnUser", description = "Adds VPN Users", responseObject = VpnUsersResponse.class, entityType = {VpnUser.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class AddVpnUserCmd extends BaseAsyncCreateCmd {
@@ -41,22 +41,22 @@ public class AddVpnUserCmd extends BaseAsyncCreateCmd {
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.USERNAME, type = CommandType.STRING, required = true, description = "username for the vpn user")
+ @Parameter(name = ApiConstants.USERNAME, type = CommandType.STRING, required = true, description = "Username for the VPN User")
private String userName;
- @Parameter(name = ApiConstants.PASSWORD, type = CommandType.STRING, required = true, description = "password for the username")
+ @Parameter(name = ApiConstants.PASSWORD, type = CommandType.STRING, required = true, description = "Password for the username")
private String password;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "an optional account for the vpn user. Must be used with domainId.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "An optional Account for the VPN User. Must be used with domainId.")
private String accountName;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "add vpn user to the specific project")
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "Add VPN User to the specific project")
private Long projectId;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.")
+ description = "An optional domainId for the VPN User. If the account parameter is used, domainId must also be used.")
private Long domainId;
/////////////////////////////////////////////////////
@@ -99,7 +99,7 @@ public class AddVpnUserCmd extends BaseAsyncCreateCmd {
@Override
public String getEventDescription() {
- return "Add Remote Access VPN user for account " + getEntityOwnerId() + " username= " + getUserName();
+ return "Add Remote Access VPN User for Account " + getEntityOwnerId() + " username= " + getUserName();
}
@Override
@@ -113,7 +113,7 @@ public class AddVpnUserCmd extends BaseAsyncCreateCmd {
Account account = _entityMgr.findById(Account.class, vpnUser.getAccountId());
try {
if (!_ravService.applyVpnUsers(vpnUser.getAccountId(), userName)) {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to add vpn user");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to add VPN User");
}
} catch (Exception ex) {
throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, ex.getMessage());
@@ -145,7 +145,7 @@ public class AddVpnUserCmd extends BaseAsyncCreateCmd {
VpnUser vpnUser = _ravService.addVpnUser(owner.getId(), userName, password);
if (vpnUser == null) {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to add vpn user");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to add VPN User");
}
setEntityId(vpnUser.getId());
setEntityUuid(vpnUser.getUuid());
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/CreateRemoteAccessVpnCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/CreateRemoteAccessVpnCmd.java
index 417ba2773c4..e52e3008202 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/CreateRemoteAccessVpnCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/CreateRemoteAccessVpnCmd.java
@@ -37,7 +37,7 @@ import com.cloud.exception.ResourceUnavailableException;
import com.cloud.network.IpAddress;
import com.cloud.network.RemoteAccessVpn;
-@APICommand(name = "createRemoteAccessVpn", description = "Creates a l2tp/ipsec remote access vpn", responseObject = RemoteAccessVpnResponse.class, entityType = {RemoteAccessVpn.class},
+@APICommand(name = "createRemoteAccessVpn", description = "Creates a l2tp/ipsec remote access VPN", responseObject = RemoteAccessVpnResponse.class, entityType = {RemoteAccessVpn.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class CreateRemoteAccessVpnCmd extends BaseAsyncCreateCmd {
@@ -49,32 +49,32 @@ public class CreateRemoteAccessVpnCmd extends BaseAsyncCreateCmd {
type = CommandType.UUID,
entityType = IPAddressResponse.class,
required = true,
- description = "public ip address id of the vpn server")
+ description = "Public IP address id of the VPN server")
private Long publicIpId;
@Parameter(name = "iprange",
type = CommandType.STRING,
required = false,
- description = "the range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn server")
+ description = "The range of IP addresses to allocate to VPN clients. The first IP in the range will be taken by the VPN server")
private String ipRange;
@Deprecated
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "an optional account for the VPN. Must be used with domainId.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "An optional Account for the VPN. Must be used with domainId.")
private String accountName;
@Deprecated
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "an optional domainId for the VPN. If the account parameter is used, domainId must also be used.")
+ description = "An optional domainId for the VPN. If the account parameter is used, domainId must also be used.")
private Long domainId;
@Parameter(name = ApiConstants.OPEN_FIREWALL,
type = CommandType.BOOLEAN,
- description = "if true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default")
+ description = "If true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default")
private Boolean openFirewall;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the vpn to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the VPN to the end User or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
/////////////////////////////////////////////////////
@@ -127,7 +127,7 @@ public class CreateRemoteAccessVpnCmd extends BaseAsyncCreateCmd {
@Override
public String getEventDescription() {
- return "Create Remote Access VPN for account " + getEntityOwnerId() + " using public ip id=" + publicIpId;
+ return "Create Remote Access VPN for Account " + getEntityOwnerId() + " using public ip id=" + publicIpId;
}
@Override
@@ -143,7 +143,7 @@ public class CreateRemoteAccessVpnCmd extends BaseAsyncCreateCmd {
setEntityId(vpn.getId());
setEntityUuid(vpn.getUuid());
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create remote access vpn");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create remote access VPN");
}
} catch (NetworkRuleConflictException e) {
logger.info("Network rule conflict: " + e.getMessage());
@@ -161,7 +161,7 @@ public class CreateRemoteAccessVpnCmd extends BaseAsyncCreateCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create remote access vpn");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create remote access VPN");
}
} catch (ResourceUnavailableException ex) {
logger.warn("Exception: ", ex);
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/CreateVpnConnectionCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/CreateVpnConnectionCmd.java
index 0b5c46d36eb..e7b3863e7e3 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/CreateVpnConnectionCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/CreateVpnConnectionCmd.java
@@ -37,7 +37,7 @@ import com.cloud.network.Site2SiteVpnGateway;
import com.cloud.network.vpc.Vpc;
-@APICommand(name = "createVpnConnection", description = "Create site to site vpn connection", responseObject = Site2SiteVpnConnectionResponse.class, entityType = {Site2SiteVpnConnection.class},
+@APICommand(name = "createVpnConnection", description = "Create site to site VPN connection", responseObject = Site2SiteVpnConnectionResponse.class, entityType = {Site2SiteVpnConnection.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class CreateVpnConnectionCmd extends BaseAsyncCreateCmd {
@@ -49,20 +49,20 @@ public class CreateVpnConnectionCmd extends BaseAsyncCreateCmd {
type = CommandType.UUID,
entityType = Site2SiteVpnGatewayResponse.class,
required = true,
- description = "id of the vpn gateway")
+ description = "ID of the VPN gateway")
private Long vpnGatewayId;
@Parameter(name = ApiConstants.S2S_CUSTOMER_GATEWAY_ID,
type = CommandType.UUID,
entityType = Site2SiteCustomerGatewayResponse.class,
required = true,
- description = "id of the customer gateway")
+ description = "ID of the customer gateway")
private Long customerGatewayId;
- @Parameter(name = ApiConstants.PASSIVE, type = CommandType.BOOLEAN, required = false, description = "connection is passive or not")
+ @Parameter(name = ApiConstants.PASSIVE, type = CommandType.BOOLEAN, required = false, description = "Connection is passive or not")
private Boolean passive;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the vpn to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the VPN to the end User or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
/////////////////////////////////////////////////////
@@ -114,7 +114,7 @@ public class CreateVpnConnectionCmd extends BaseAsyncCreateCmd {
@Override
public String getEventDescription() {
- return "Create site-to-site VPN connection for account " + getEntityOwnerId();
+ return "Create site-to-site VPN connection for Account " + getEntityOwnerId();
}
@Override
@@ -130,7 +130,7 @@ public class CreateVpnConnectionCmd extends BaseAsyncCreateCmd {
setEntityId(conn.getId());
setEntityUuid(conn.getUuid());
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create site to site vpn connection");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create site to site VPN connection");
}
} catch (NetworkRuleConflictException e) {
logger.info("Network rule conflict: " + e.getMessage());
@@ -148,7 +148,7 @@ public class CreateVpnConnectionCmd extends BaseAsyncCreateCmd {
response.setResponseName(getCommandName());
setResponseObject(response);
} else {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create site to site vpn connection");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to create site to site VPN connection");
}
} catch (ResourceUnavailableException ex) {
logger.warn("Exception: ", ex);
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/CreateVpnCustomerGatewayCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/CreateVpnCustomerGatewayCmd.java
index a2fa0d9829c..ef0e2354495 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/CreateVpnCustomerGatewayCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/CreateVpnCustomerGatewayCmd.java
@@ -33,7 +33,7 @@ import com.cloud.event.EventTypes;
import com.cloud.exception.ResourceAllocationException;
import com.cloud.network.Site2SiteCustomerGateway;
-@APICommand(name = "createVpnCustomerGateway", description = "Creates site to site vpn customer gateway", responseObject = Site2SiteCustomerGatewayResponse.class, entityType = {Site2SiteCustomerGateway.class},
+@APICommand(name = "createVpnCustomerGateway", description = "Creates site to site VPN customer gateway", responseObject = Site2SiteCustomerGatewayResponse.class, entityType = {Site2SiteCustomerGateway.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class CreateVpnCustomerGatewayCmd extends BaseAsyncCreateCmd {
@@ -41,13 +41,13 @@ public class CreateVpnCustomerGatewayCmd extends BaseAsyncCreateCmd {
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = false, description = "name of this customer gateway")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = false, description = "Name of this customer gateway")
private String name;
- @Parameter(name = ApiConstants.GATEWAY, type = CommandType.STRING, required = true, description = "public ip address id of the customer gateway")
+ @Parameter(name = ApiConstants.GATEWAY, type = CommandType.STRING, required = true, description = "Public IP address id of the customer gateway")
private String gatewayIp;
- @Parameter(name = ApiConstants.CIDR_LIST, type = CommandType.STRING, required = true, description = "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).")
+ @Parameter(name = ApiConstants.CIDR_LIST, type = CommandType.STRING, required = true, description = "Guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).")
private String peerCidrList;
@Parameter(name = ApiConstants.IPSEC_PSK, type = CommandType.STRING, required = true, description = "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.")
@@ -77,18 +77,18 @@ public class CreateVpnCustomerGatewayCmd extends BaseAsyncCreateCmd {
@Parameter(name = ApiConstants.FORCE_ENCAP, type = CommandType.BOOLEAN, required = false, description = "Force Encapsulation for NAT traversal")
private Boolean encap;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "the account associated with the gateway. Must be used with the domainId parameter.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "The Account associated with the gateway. Must be used with the domainId parameter.")
private String accountName;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "the domain ID associated with the gateway. If used with the account parameter returns the "
- + "gateway associated with the account for the specified domain.")
+ description = "The domain ID associated with the gateway. If used with the account parameter returns the "
+ + "gateway associated with the Account for the specified domain.")
private Long domainId;
@Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class,
- description = "create site-to-site VPN customer gateway for the project", since = "4.6")
+ description = "Create site-to-site VPN customer gateway for the project", since = "4.6")
private Long projectId;
@Parameter(name = ApiConstants.SPLIT_CONNECTIONS, type = CommandType.BOOLEAN, required = false, description = "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.",
@@ -176,7 +176,7 @@ public class CreateVpnCustomerGatewayCmd extends BaseAsyncCreateCmd {
@Override
public String getEventDescription() {
- return "Create site-to-site VPN customer gateway for account " + getEntityOwnerId();
+ return "Create site-to-site VPN customer gateway for Account " + getEntityOwnerId();
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/CreateVpnGatewayCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/CreateVpnGatewayCmd.java
index 6f31176c4ff..13a19613c1b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/CreateVpnGatewayCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/CreateVpnGatewayCmd.java
@@ -32,7 +32,7 @@ import org.apache.cloudstack.api.response.Site2SiteVpnGatewayResponse;
import org.apache.cloudstack.api.response.VpcResponse;
import org.apache.cloudstack.context.CallContext;
-@APICommand(name = "createVpnGateway", description = "Creates site to site vpn local gateway", responseObject = Site2SiteVpnGatewayResponse.class, entityType = {Site2SiteVpnGateway.class},
+@APICommand(name = "createVpnGateway", description = "Creates site to site VPN local gateway", responseObject = Site2SiteVpnGatewayResponse.class, entityType = {Site2SiteVpnGateway.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class CreateVpnGatewayCmd extends BaseAsyncCreateCmd {
@@ -44,10 +44,10 @@ public class CreateVpnGatewayCmd extends BaseAsyncCreateCmd {
type = CommandType.UUID,
entityType = VpcResponse.class,
required = true,
- description = "public ip address id of the vpn gateway")
+ description = "Public IP address id of the VPN gateway")
private Long vpcId;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the vpn to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the VPN to the end User or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
/////////////////////////////////////////////////////
@@ -84,7 +84,7 @@ public class CreateVpnGatewayCmd extends BaseAsyncCreateCmd {
@Override
public String getEventDescription() {
- return "Create site-to-site VPN gateway for account " + getEntityOwnerId();
+ return "Create site-to-site VPN gateway for Account " + getEntityOwnerId();
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/DeleteRemoteAccessVpnCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/DeleteRemoteAccessVpnCmd.java
index bf8d0157923..91e1cd1e56c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/DeleteRemoteAccessVpnCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/DeleteRemoteAccessVpnCmd.java
@@ -34,7 +34,7 @@ import com.cloud.exception.InvalidParameterValueException;
import com.cloud.exception.ResourceUnavailableException;
import com.cloud.network.RemoteAccessVpn;
-@APICommand(name = "deleteRemoteAccessVpn", description = "Destroys a l2tp/ipsec remote access vpn", responseObject = SuccessResponse.class, entityType = {RemoteAccessVpn.class},
+@APICommand(name = "deleteRemoteAccessVpn", description = "Destroys a l2tp/ipsec remote access VPN", responseObject = SuccessResponse.class, entityType = {RemoteAccessVpn.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class DeleteRemoteAccessVpnCmd extends BaseAsyncCmd {
@@ -47,7 +47,7 @@ public class DeleteRemoteAccessVpnCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = IPAddressResponse.class,
required = true,
- description = "public ip address id of the vpn server")
+ description = "Public IP address id of the VPN server")
private Long publicIpId;
// unexposed parameter needed for events logging
@@ -69,14 +69,14 @@ public class DeleteRemoteAccessVpnCmd extends BaseAsyncCmd {
if (vpnEntity != null)
return vpnEntity.getAccountId();
- throw new InvalidParameterValueException("The specified public ip is not allocated to any account");
+ throw new InvalidParameterValueException("The specified public ip is not allocated to any Account");
}
return ownerId;
}
@Override
public String getEventDescription() {
- return "Delete Remote Access VPN for account " + getEntityOwnerId() + " for ip id=" + publicIpId;
+ return "Delete Remote Access VPN for Account " + getEntityOwnerId() + " for ip id=" + publicIpId;
}
@Override
@@ -87,7 +87,7 @@ public class DeleteRemoteAccessVpnCmd extends BaseAsyncCmd {
@Override
public void execute() throws ResourceUnavailableException {
if (! _ravService.destroyRemoteAccessVpnForIp(publicIpId, CallContext.current().getCallingAccount(), false)) {
- throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to delete remote access vpn");
+ throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, "Failed to delete remote access VPN");
}
SuccessResponse response = new SuccessResponse(getCommandName());
this.setResponseObject(response);
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/DeleteVpnConnectionCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/DeleteVpnConnectionCmd.java
index 2528d93a042..f66fe237a99 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/DeleteVpnConnectionCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/DeleteVpnConnectionCmd.java
@@ -31,7 +31,7 @@ import com.cloud.exception.ResourceUnavailableException;
import com.cloud.network.Site2SiteVpnConnection;
import com.cloud.user.Account;
-@APICommand(name = "deleteVpnConnection", description = "Delete site to site vpn connection", responseObject = SuccessResponse.class, entityType = {Site2SiteVpnConnection.class},
+@APICommand(name = "deleteVpnConnection", description = "Delete site to site VPN connection", responseObject = SuccessResponse.class, entityType = {Site2SiteVpnConnection.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class DeleteVpnConnectionCmd extends BaseAsyncCmd {
@@ -39,7 +39,7 @@ public class DeleteVpnConnectionCmd extends BaseAsyncCmd {
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = Site2SiteVpnConnectionResponse.class, required = true, description = "id of vpn connection")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = Site2SiteVpnConnectionResponse.class, required = true, description = "ID of VPN connection")
private Long id;
/////////////////////////////////////////////////////
@@ -65,7 +65,7 @@ public class DeleteVpnConnectionCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "Delete site-to-site VPN connection for account " + getEntityOwnerId();
+ return "Delete site-to-site VPN connection for Account " + getEntityOwnerId();
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/DeleteVpnCustomerGatewayCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/DeleteVpnCustomerGatewayCmd.java
index 2b657fd3c08..0d43477205e 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/DeleteVpnCustomerGatewayCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/DeleteVpnCustomerGatewayCmd.java
@@ -33,7 +33,7 @@ import com.cloud.event.EventTypes;
import com.cloud.network.Site2SiteCustomerGateway;
import com.cloud.user.Account;
-@APICommand(name = "deleteVpnCustomerGateway", description = "Delete site to site vpn customer gateway", responseObject = SuccessResponse.class, entityType = {Site2SiteCustomerGateway.class},
+@APICommand(name = "deleteVpnCustomerGateway", description = "Delete site to site VPN customer gateway", responseObject = SuccessResponse.class, entityType = {Site2SiteCustomerGateway.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class DeleteVpnCustomerGatewayCmd extends BaseAsyncCmd {
@@ -46,7 +46,7 @@ public class DeleteVpnCustomerGatewayCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = Site2SiteCustomerGatewayResponse.class,
required = true,
- description = "id of customer gateway")
+ description = "ID of customer gateway")
private Long id;
/////////////////////////////////////////////////////
@@ -72,7 +72,7 @@ public class DeleteVpnCustomerGatewayCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "Delete site-to-site VPN customer gateway for account " + getEntityOwnerId();
+ return "Delete site-to-site VPN customer gateway for Account " + getEntityOwnerId();
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/DeleteVpnGatewayCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/DeleteVpnGatewayCmd.java
index 27ded12dc58..bfea59a3e6f 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/DeleteVpnGatewayCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/DeleteVpnGatewayCmd.java
@@ -30,7 +30,7 @@ import com.cloud.event.EventTypes;
import com.cloud.network.Site2SiteVpnGateway;
import com.cloud.user.Account;
-@APICommand(name = "deleteVpnGateway", description = "Delete site to site vpn gateway", responseObject = SuccessResponse.class, entityType = {Site2SiteVpnGateway.class},
+@APICommand(name = "deleteVpnGateway", description = "Delete site to site VPN gateway", responseObject = SuccessResponse.class, entityType = {Site2SiteVpnGateway.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class DeleteVpnGatewayCmd extends BaseAsyncCmd {
@@ -38,7 +38,7 @@ public class DeleteVpnGatewayCmd extends BaseAsyncCmd {
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = Site2SiteVpnGatewayResponse.class, required = true, description = "id of customer gateway")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = Site2SiteVpnGatewayResponse.class, required = true, description = "ID of customer gateway")
private Long id;
/////////////////////////////////////////////////////
@@ -64,7 +64,7 @@ public class DeleteVpnGatewayCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "Delete site-to-site VPN gateway for account " + getEntityOwnerId();
+ return "Delete site-to-site VPN gateway for Account " + getEntityOwnerId();
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/ListRemoteAccessVpnsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/ListRemoteAccessVpnsCmd.java
index 4efc70c8419..185d11bc29d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/ListRemoteAccessVpnsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/ListRemoteAccessVpnsCmd.java
@@ -33,7 +33,7 @@ import org.apache.cloudstack.api.response.RemoteAccessVpnResponse;
import com.cloud.network.RemoteAccessVpn;
import com.cloud.utils.Pair;
-@APICommand(name = "listRemoteAccessVpns", description = "Lists remote access vpns", responseObject = RemoteAccessVpnResponse.class, entityType = {RemoteAccessVpn.class},
+@APICommand(name = "listRemoteAccessVpns", description = "Lists remote access VPNs", responseObject = RemoteAccessVpnResponse.class, entityType = {RemoteAccessVpn.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListRemoteAccessVpnsCmd extends BaseListProjectAndAccountResourcesCmd {
@@ -41,24 +41,24 @@ public class ListRemoteAccessVpnsCmd extends BaseListProjectAndAccountResourcesC
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.PUBLIC_IP_ID, type = CommandType.UUID, entityType = IPAddressResponse.class, description = "public ip address id of the vpn server")
+ @Parameter(name = ApiConstants.PUBLIC_IP_ID, type = CommandType.UUID, entityType = IPAddressResponse.class, description = "Public ip address id of the VPN server")
private Long publicIpId;
@Parameter(name = ApiConstants.ID,
type = CommandType.UUID,
entityType = RemoteAccessVpnResponse.class,
- description = "Lists remote access vpn rule with the specified ID",
+ description = "Lists remote access VPN rule with the specified ID",
since = "4.3")
private Long id;
@Parameter(name = ApiConstants.NETWORK_ID,
type = CommandType.UUID,
entityType = NetworkResponse.class,
- description = "list remote access VPNs for certain network",
+ description = "List remote access VPNs for certain Network",
since = "4.3")
private Long networkId;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "list resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "List resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/ListVpnConnectionsCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/ListVpnConnectionsCmd.java
index aeeae44d004..9a37e2f786c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/ListVpnConnectionsCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/ListVpnConnectionsCmd.java
@@ -32,7 +32,7 @@ import org.apache.cloudstack.api.response.VpcResponse;
import com.cloud.network.Site2SiteVpnConnection;
import com.cloud.utils.Pair;
-@APICommand(name = "listVpnConnections", description = "Lists site to site vpn connection gateways", responseObject = Site2SiteVpnConnectionResponse.class, entityType = {Site2SiteVpnConnection.class},
+@APICommand(name = "listVpnConnections", description = "Lists site to site VPN connection gateways", responseObject = Site2SiteVpnConnectionResponse.class, entityType = {Site2SiteVpnConnection.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListVpnConnectionsCmd extends BaseListProjectAndAccountResourcesCmd {
@@ -40,13 +40,13 @@ public class ListVpnConnectionsCmd extends BaseListProjectAndAccountResourcesCmd
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = Site2SiteVpnConnectionResponse.class, description = "id of the vpn connection")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = Site2SiteVpnConnectionResponse.class, description = "ID of the VPN connection")
private Long id;
- @Parameter(name = ApiConstants.VPC_ID, type = CommandType.UUID, entityType = VpcResponse.class, description = "id of vpc")
+ @Parameter(name = ApiConstants.VPC_ID, type = CommandType.UUID, entityType = VpcResponse.class, description = "ID of VPC")
private Long vpcId;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "list resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "List resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/ListVpnCustomerGatewaysCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/ListVpnCustomerGatewaysCmd.java
index 258a8a753eb..51e76183971 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/ListVpnCustomerGatewaysCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/ListVpnCustomerGatewaysCmd.java
@@ -30,7 +30,7 @@ import org.apache.cloudstack.api.response.Site2SiteCustomerGatewayResponse;
import com.cloud.network.Site2SiteCustomerGateway;
import com.cloud.utils.Pair;
-@APICommand(name = "listVpnCustomerGateways", description = "Lists site to site vpn customer gateways", responseObject = Site2SiteCustomerGatewayResponse.class, entityType = {Site2SiteCustomerGateway.class},
+@APICommand(name = "listVpnCustomerGateways", description = "Lists site to site VPN customer gateways", responseObject = Site2SiteCustomerGatewayResponse.class, entityType = {Site2SiteCustomerGateway.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListVpnCustomerGatewaysCmd extends BaseListProjectAndAccountResourcesCmd {
@@ -39,7 +39,7 @@ public class ListVpnCustomerGatewaysCmd extends BaseListProjectAndAccountResourc
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = Site2SiteCustomerGatewayResponse.class, description = "id of the customer gateway")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = Site2SiteCustomerGatewayResponse.class, description = "ID of the customer gateway")
private Long id;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/ListVpnGatewaysCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/ListVpnGatewaysCmd.java
index d30fbf8d32b..3bdcf79677a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/ListVpnGatewaysCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/ListVpnGatewaysCmd.java
@@ -32,7 +32,7 @@ import org.apache.cloudstack.api.response.VpcResponse;
import com.cloud.network.Site2SiteVpnGateway;
import com.cloud.utils.Pair;
-@APICommand(name = "listVpnGateways", description = "Lists site 2 site vpn gateways", responseObject = Site2SiteVpnGatewayResponse.class, entityType = {Site2SiteVpnGateway.class},
+@APICommand(name = "listVpnGateways", description = "Lists site 2 site VPN gateways", responseObject = Site2SiteVpnGatewayResponse.class, entityType = {Site2SiteVpnGateway.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListVpnGatewaysCmd extends BaseListProjectAndAccountResourcesCmd {
@@ -41,13 +41,13 @@ public class ListVpnGatewaysCmd extends BaseListProjectAndAccountResourcesCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = Site2SiteVpnGatewayResponse.class, description = "id of the vpn gateway")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = Site2SiteVpnGatewayResponse.class, description = "ID of the VPN gateway")
private Long id;
- @Parameter(name = ApiConstants.VPC_ID, type = CommandType.UUID, entityType = VpcResponse.class, description = "id of vpc")
+ @Parameter(name = ApiConstants.VPC_ID, type = CommandType.UUID, entityType = VpcResponse.class, description = "ID of VPC ")
private Long vpcId;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "list resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "List resources by display flag; only ROOT admin is eligible to pass this parameter", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/ListVpnUsersCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/ListVpnUsersCmd.java
index 48591765ec3..b4a621e53f9 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/ListVpnUsersCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/ListVpnUsersCmd.java
@@ -30,7 +30,7 @@ import org.apache.cloudstack.api.response.VpnUsersResponse;
import com.cloud.network.VpnUser;
import com.cloud.utils.Pair;
-@APICommand(name = "listVpnUsers", description = "Lists vpn users", responseObject = VpnUsersResponse.class, entityType = {VpnUser.class},
+@APICommand(name = "listVpnUsers", description = "Lists VPN Users", responseObject = VpnUsersResponse.class, entityType = {VpnUser.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListVpnUsersCmd extends BaseListProjectAndAccountResourcesCmd {
@@ -38,10 +38,10 @@ public class ListVpnUsersCmd extends BaseListProjectAndAccountResourcesCmd {
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VpnUsersResponse.class, description = "The uuid of the Vpn user")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = VpnUsersResponse.class, description = "The UUID of the VPN User")
private Long id;
- @Parameter(name = ApiConstants.USERNAME, type = CommandType.STRING, description = "the username of the vpn user.")
+ @Parameter(name = ApiConstants.USERNAME, type = CommandType.STRING, description = "The username of the VPN User.")
private String userName;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/RemoveVpnUserCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/RemoveVpnUserCmd.java
index 0697987b04d..aff87105f9c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/RemoveVpnUserCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/RemoveVpnUserCmd.java
@@ -33,7 +33,7 @@ import com.cloud.exception.ResourceUnavailableException;
import com.cloud.network.VpnUser;
import com.cloud.user.Account;
-@APICommand(name = "removeVpnUser", description = "Removes vpn user", responseObject = SuccessResponse.class, entityType = {VpnUser.class},
+@APICommand(name = "removeVpnUser", description = "Removes VPN User", responseObject = SuccessResponse.class, entityType = {VpnUser.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class RemoveVpnUserCmd extends BaseAsyncCmd {
@@ -41,19 +41,19 @@ public class RemoveVpnUserCmd extends BaseAsyncCmd {
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.USERNAME, type = CommandType.STRING, required = true, description = "username for the vpn user")
+ @Parameter(name = ApiConstants.USERNAME, type = CommandType.STRING, required = true, description = "Username for the VPN User")
private String userName;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "an optional account for the vpn user. Must be used with domainId.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "An optional Account for the VPN User. Must be used with domainId.")
private String accountName;
- @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "remove vpn user from the project")
+ @Parameter(name = ApiConstants.PROJECT_ID, type = CommandType.UUID, entityType = ProjectResponse.class, description = "Remove VPN User from the project")
private Long projectId;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.")
+ description = "An optional domainId for the VPN User. If the Account parameter is used, domainId must also be used.")
private Long domainId;
/////////////////////////////////////////////////////
@@ -92,7 +92,7 @@ public class RemoveVpnUserCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "Remove Remote Access VPN user for account " + getEntityOwnerId() + " username= " + getUserName();
+ return "Remove Remote Access VPN User for Account " + getEntityOwnerId() + " username= " + getUserName();
}
@Override
@@ -106,7 +106,7 @@ public class RemoveVpnUserCmd extends BaseAsyncCmd {
long ownerId = owner.getId();
boolean result = _ravService.removeVpnUser(owner, userName, CallContext.current().getCallingAccount());
if (!result) {
- String errorMessage = String.format("Failed to remove VPN user=[%s]. VPN owner id=[%s].", userName, ownerId);
+ String errorMessage = String.format("Failed to remove VPN User=[%s]. VPN owner id=[%s].", userName, ownerId);
logger.error(errorMessage);
throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, errorMessage);
}
@@ -115,13 +115,13 @@ public class RemoveVpnUserCmd extends BaseAsyncCmd {
try {
appliedVpnUsers = _ravService.applyVpnUsers(ownerId, userName, true);
} catch (ResourceUnavailableException ex) {
- String errorMessage = String.format("Failed to refresh VPN user=[%s] due to resource unavailable. VPN owner id=[%s].", userName, ownerId);
+ String errorMessage = String.format("Failed to refresh VPN User=[%s] due to resource unavailable. VPN owner id=[%s].", userName, ownerId);
logger.error(errorMessage, ex);
throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, errorMessage, ex);
}
if (!appliedVpnUsers) {
- String errorMessage = String.format("Failed to refresh VPN user=[%s]. VPN owner id=[%s].", userName, ownerId);
+ String errorMessage = String.format("Failed to refresh VPN User=[%s]. VPN owner id=[%s].", userName, ownerId);
logger.debug(errorMessage);
throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, errorMessage);
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/ResetVpnConnectionCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/ResetVpnConnectionCmd.java
index 736295b4119..b6e29e66ff4 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/ResetVpnConnectionCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/ResetVpnConnectionCmd.java
@@ -32,7 +32,7 @@ import com.cloud.exception.ResourceUnavailableException;
import com.cloud.network.Site2SiteVpnConnection;
import com.cloud.user.Account;
-@APICommand(name = "resetVpnConnection", description = "Reset site to site vpn connection", responseObject = Site2SiteVpnConnectionResponse.class, entityType = {Site2SiteVpnConnection.class},
+@APICommand(name = "resetVpnConnection", description = "Reset site to site VPN connection", responseObject = Site2SiteVpnConnectionResponse.class, entityType = {Site2SiteVpnConnection.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ResetVpnConnectionCmd extends BaseAsyncCmd {
@@ -40,16 +40,16 @@ public class ResetVpnConnectionCmd extends BaseAsyncCmd {
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = Site2SiteVpnConnectionResponse.class, required = true, description = "id of vpn connection")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = Site2SiteVpnConnectionResponse.class, required = true, description = "ID of VPN connection")
private Long id;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "an optional account for connection. " + "Must be used with domainId.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "An optional Account for connection. " + "Must be used with domainId.")
private String accountName;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "an optional domainId for connection. If the account parameter is used, domainId must also be used.")
+ description = "An optional domainId for connection. If the Account parameter is used, domainId must also be used.")
private Long domainId;
/////////////////////////////////////////////////////
@@ -83,7 +83,7 @@ public class ResetVpnConnectionCmd extends BaseAsyncCmd {
@Override
public String getEventDescription() {
- return "Reset site-to-site VPN connection for account " + getEntityOwnerId();
+ return "Reset site-to-site VPN connection for Account " + getEntityOwnerId();
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/UpdateRemoteAccessVpnCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/UpdateRemoteAccessVpnCmd.java
index defde70b63a..edf2b9e630b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/UpdateRemoteAccessVpnCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/UpdateRemoteAccessVpnCmd.java
@@ -28,7 +28,7 @@ import com.cloud.event.EventTypes;
import com.cloud.exception.InvalidParameterValueException;
import com.cloud.network.RemoteAccessVpn;
-@APICommand(name = "updateRemoteAccessVpn", description = "Updates remote access vpn", responseObject = RemoteAccessVpnResponse.class, since = "4.4",
+@APICommand(name = "updateRemoteAccessVpn", description = "Updates remote access VPN", responseObject = RemoteAccessVpnResponse.class, since = "4.4",
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class UpdateRemoteAccessVpnCmd extends BaseAsyncCustomIdCmd {
@@ -37,14 +37,14 @@ public class UpdateRemoteAccessVpnCmd extends BaseAsyncCustomIdCmd {
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, required = true, entityType = RemoteAccessVpnResponse.class, description = "id of the remote access vpn")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, required = true, entityType = RemoteAccessVpnResponse.class, description = "ID of the remote access VPN")
private Long id;
// unexposed parameter needed for events logging
@Parameter(name = ApiConstants.ACCOUNT_ID, type = CommandType.UUID, entityType = AccountResponse.class, expose = false)
private Long ownerId;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the vpn to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the VPN to the end User or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
/////////////////////////////////////////////////////
@@ -73,7 +73,7 @@ public class UpdateRemoteAccessVpnCmd extends BaseAsyncCustomIdCmd {
@Override
public String getEventDescription() {
- return "Updating remote access vpn id=" + id;
+ return "Updating remote access VPN id=" + id;
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/UpdateVpnConnectionCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/UpdateVpnConnectionCmd.java
index 62dd6167b75..a4a0c927a57 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/UpdateVpnConnectionCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/UpdateVpnConnectionCmd.java
@@ -27,7 +27,7 @@ import com.cloud.event.EventTypes;
import com.cloud.network.Site2SiteVpnConnection;
import com.cloud.user.Account;
-@APICommand(name = "updateVpnConnection", description = "Updates site to site vpn connection", responseObject = Site2SiteVpnConnectionResponse.class, since = "4.4",
+@APICommand(name = "updateVpnConnection", description = "Updates site to site VPN connection", responseObject = Site2SiteVpnConnectionResponse.class, since = "4.4",
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class UpdateVpnConnectionCmd extends BaseAsyncCustomIdCmd {
@@ -35,10 +35,10 @@ public class UpdateVpnConnectionCmd extends BaseAsyncCustomIdCmd {
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = Site2SiteVpnConnectionResponse.class, required = true, description = "id of vpn connection")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = Site2SiteVpnConnectionResponse.class, required = true, description = "ID of VPN connection")
private Long id;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the vpn to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the VPN to the end User or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/UpdateVpnCustomerGatewayCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/UpdateVpnCustomerGatewayCmd.java
index 9f3ac2ec436..edd168f0837 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/UpdateVpnCustomerGatewayCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/UpdateVpnCustomerGatewayCmd.java
@@ -32,7 +32,7 @@ import org.apache.cloudstack.context.CallContext;
import com.cloud.event.EventTypes;
import com.cloud.network.Site2SiteCustomerGateway;
-@APICommand(name = "updateVpnCustomerGateway", description = "Update site to site vpn customer gateway", responseObject = Site2SiteCustomerGatewayResponse.class, entityType = {Site2SiteCustomerGateway.class},
+@APICommand(name = "updateVpnCustomerGateway", description = "Update site to site VPN customer gateway", responseObject = Site2SiteCustomerGatewayResponse.class, entityType = {Site2SiteCustomerGateway.class},
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class UpdateVpnCustomerGatewayCmd extends BaseAsyncCmd {
@@ -44,16 +44,16 @@ public class UpdateVpnCustomerGatewayCmd extends BaseAsyncCmd {
type = CommandType.UUID,
entityType = Site2SiteCustomerGatewayResponse.class,
required = true,
- description = "id of customer gateway")
+ description = "ID of customer gateway")
private Long id;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = false, description = "name of this customer gateway")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, required = false, description = "Name of this customer gateway")
private String name;
- @Parameter(name = ApiConstants.GATEWAY, type = CommandType.STRING, required = true, description = "public ip address id of the customer gateway")
+ @Parameter(name = ApiConstants.GATEWAY, type = CommandType.STRING, required = true, description = "Public IP address id of the customer gateway")
private String gatewayIp;
- @Parameter(name = ApiConstants.CIDR_LIST, type = CommandType.STRING, required = true, description = "guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,).")
+ @Parameter(name = ApiConstants.CIDR_LIST, type = CommandType.STRING, required = true, description = "Guest CIDR of the customer gateway. Multiple entries must be separated by a single comma character (,).")
private String guestCidrList;
@Parameter(name = ApiConstants.IPSEC_PSK, type = CommandType.STRING, required = true, description = "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.")
@@ -83,14 +83,14 @@ public class UpdateVpnCustomerGatewayCmd extends BaseAsyncCmd {
@Parameter(name = ApiConstants.FORCE_ENCAP, type = CommandType.BOOLEAN, required = false, description = "Force encapsulation for Nat Traversal")
private Boolean encap;
- @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "the account associated with the gateway. Must be used with the domainId parameter.")
+ @Parameter(name = ApiConstants.ACCOUNT, type = CommandType.STRING, description = "The Account associated with the gateway. Must be used with the domainId parameter.")
private String accountName;
@Parameter(name = ApiConstants.DOMAIN_ID,
type = CommandType.UUID,
entityType = DomainResponse.class,
- description = "the domain ID associated with the gateway. If used with the account parameter returns the "
- + "gateway associated with the account for the specified domain.")
+ description = "The domain ID associated with the gateway. If used with the account parameter returns the "
+ + "gateway associated with the Account for the specified domain.")
private Long domainId;
@Parameter(name = ApiConstants.SPLIT_CONNECTIONS, type = CommandType.BOOLEAN, required = false, description = "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.",
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/UpdateVpnGatewayCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/UpdateVpnGatewayCmd.java
index 9fe5ae0480f..29676bdf0cc 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/UpdateVpnGatewayCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/vpn/UpdateVpnGatewayCmd.java
@@ -27,7 +27,7 @@ import com.cloud.event.EventTypes;
import com.cloud.network.Site2SiteVpnGateway;
import com.cloud.user.Account;
-@APICommand(name = "updateVpnGateway", description = "Updates site to site vpn local gateway", responseObject = Site2SiteVpnGatewayResponse.class, since = "4.4",
+@APICommand(name = "updateVpnGateway", description = "Updates site to site VPN local gateway", responseObject = Site2SiteVpnGatewayResponse.class, since = "4.4",
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class UpdateVpnGatewayCmd extends BaseAsyncCustomIdCmd {
@@ -35,10 +35,10 @@ public class UpdateVpnGatewayCmd extends BaseAsyncCustomIdCmd {
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = Site2SiteVpnGatewayResponse.class, required = true, description = "id of customer gateway")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = Site2SiteVpnGatewayResponse.class, required = true, description = "ID of customer gateway")
private Long id;
- @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "an optional field, whether to the display the vpn to the end user or not", since = "4.4", authorized = {RoleType.Admin})
+ @Parameter(name = ApiConstants.FOR_DISPLAY, type = CommandType.BOOLEAN, description = "An optional field, whether to the display the VPN to the end User or not", since = "4.4", authorized = {RoleType.Admin})
private Boolean display;
/////////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/command/user/zone/ListZonesCmd.java b/api/src/main/java/org/apache/cloudstack/api/command/user/zone/ListZonesCmd.java
index d926257437e..2504118877e 100644
--- a/api/src/main/java/org/apache/cloudstack/api/command/user/zone/ListZonesCmd.java
+++ b/api/src/main/java/org/apache/cloudstack/api/command/user/zone/ListZonesCmd.java
@@ -34,12 +34,10 @@ import org.apache.cloudstack.api.response.ZoneResponse;
requestHasSensitiveInfo = false, responseHasSensitiveInfo = false)
public class ListZonesCmd extends BaseListCmd implements UserCmd {
- private static final String s_name = "listzonesresponse";
-
/////////////////////////////////////////////////////
//////////////// API parameters /////////////////////
/////////////////////////////////////////////////////
- @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "the ID of the zone")
+ @Parameter(name = ApiConstants.ID, type = CommandType.UUID, entityType = ZoneResponse.class, description = "The ID of the zone")
private Long id;
@Parameter(name = ApiConstants.IDS, type = CommandType.LIST, collectionType = CommandType.UUID, entityType = ZoneResponse.class, description = "the IDs of the zones, mutually exclusive with id", since = "4.19.0")
@@ -47,26 +45,26 @@ public class ListZonesCmd extends BaseListCmd implements UserCmd {
@Parameter(name = ApiConstants.AVAILABLE,
type = CommandType.BOOLEAN,
- description = "true if you want to retrieve all available Zones. False if you only want to return the Zones"
- + " from which you have at least one VM. Default is false.")
+ description = "True if you want to retrieve all available Zones. False if you only want to return the Zones"
+ + " from which you have at least one Instance. Default is false.")
private Boolean available;
- @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "the ID of the domain associated with the zone")
+ @Parameter(name = ApiConstants.DOMAIN_ID, type = CommandType.UUID, entityType = DomainResponse.class, description = "The ID of the domain associated with the zone")
private Long domainId;
- @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "the name of the zone")
+ @Parameter(name = ApiConstants.NAME, type = CommandType.STRING, description = "The name of the zone")
private String name;
- @Parameter(name = ApiConstants.NETWORK_TYPE, type = CommandType.STRING, description = "the network type of the zone that the virtual machine belongs to")
+ @Parameter(name = ApiConstants.NETWORK_TYPE, type = CommandType.STRING, description = "The Network type of the zone that the Instance belongs to")
private String networkType;
- @Parameter(name = ApiConstants.SHOW_CAPACITIES, type = CommandType.BOOLEAN, description = "flag to display the capacity of the zones")
+ @Parameter(name = ApiConstants.SHOW_CAPACITIES, type = CommandType.BOOLEAN, description = "Flag to display the capacity of the zones")
private Boolean showCapacities;
@Parameter(name = ApiConstants.TAGS, type = CommandType.MAP, description = "List zones by resource tags (key/value pairs)", since = "4.3")
private Map tags;
- @Parameter(name = ApiConstants.SHOW_RESOURCE_ICON, type = CommandType.BOOLEAN, description = "flag to display the resource image for the zones")
+ @Parameter(name = ApiConstants.SHOW_RESOURCE_ICON, type = CommandType.BOOLEAN, description = "Flag to display the resource image for the zones")
private Boolean showIcon;
/////////////////////////////////////////////////////
@@ -113,11 +111,6 @@ public class ListZonesCmd extends BaseListCmd implements UserCmd {
/////////////// API Implementation///////////////////
/////////////////////////////////////////////////////
- @Override
- public String getCommandName() {
- return s_name;
- }
-
@Override
public void execute() {
ListResponse response = _queryService.listDataCenters(this);
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/AccountResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/AccountResponse.java
index 6fc098295f6..22bc6c76fc3 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/AccountResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/AccountResponse.java
@@ -32,235 +32,235 @@ import com.google.gson.annotations.SerializedName;
@EntityReference(value = Account.class)
public class AccountResponse extends BaseResponse implements ResourceLimitAndCountResponse, SetResourceIconResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the id of the account")
+ @Param(description = "The ID of the Account")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the account")
+ @Param(description = "The name of the Account")
private String name;
@SerializedName(ApiConstants.ACCOUNT_TYPE)
- @Param(description = "account type (admin, domain-admin, user)")
+ @Param(description = "Account type (admin, domain-admin, user)")
private Integer accountType;
@SerializedName(ApiConstants.ROLE_ID)
- @Param(description = "the ID of the role")
+ @Param(description = "The ID of the role")
private String roleId;
@SerializedName(ApiConstants.ROLE_TYPE)
- @Param(description = "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)")
+ @Param(description = "The type of the role (Admin, ResourceAdmin, DomainAdmin, User)")
private String roleType;
@SerializedName(ApiConstants.ROLE_NAME)
- @Param(description = "the name of the role")
+ @Param(description = "The name of the role")
private String roleName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "id of the Domain the account belongs to")
+ @Param(description = "ID of the Domain the Account belongs to")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "name of the Domain the account belongs to")
+ @Param(description = "Name of the Domain the Account belongs to")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
- @Param(description = "path of the Domain the account belongs to", since = "4.13")
+ @Param(description = "Path of the Domain the Account belongs to", since = "4.13")
private String domainPath;
@SerializedName(ApiConstants.DEFAULT_ZONE_ID)
- @Param(description = "the default zone of the account")
+ @Param(description = "The default zone of the Account")
private String defaultZoneId;
@SerializedName(ApiConstants.RECEIVED_BYTES)
- @Param(description = "the total number of network traffic bytes received")
+ @Param(description = "The total number of Network traffic bytes received")
private Long bytesReceived;
@SerializedName(ApiConstants.SENT_BYTES)
- @Param(description = "the total number of network traffic bytes sent")
+ @Param(description = "The total number of Network traffic bytes sent")
private Long bytesSent;
@SerializedName(ApiConstants.VM_LIMIT)
- @Param(description = "the total number of virtual machines that can be deployed by this account")
+ @Param(description = "The total number of Instances that can be deployed by this Account")
private String vmLimit;
@SerializedName(ApiConstants.VM_TOTAL)
- @Param(description = "the total number of virtual machines deployed by this account")
+ @Param(description = "The total number of Instances deployed by this Account")
private Long vmTotal;
@SerializedName(ApiConstants.VM_AVAILABLE)
- @Param(description = "the total number of virtual machines available for this account to acquire")
+ @Param(description = "The total number of Instances available for this Account to acquire")
private String vmAvailable;
@SerializedName(ApiConstants.IP_LIMIT)
- @Param(description = "the total number of public ip addresses this account can acquire")
+ @Param(description = "The total number of public IP addresses this Account can acquire")
private String ipLimit;
@SerializedName(ApiConstants.IP_TOTAL)
- @Param(description = "the total number of public ip addresses allocated for this account")
+ @Param(description = "The total number of public IP addresses allocated for this Account")
private Long ipTotal;
@SerializedName(ApiConstants.IP_AVAILABLE)
- @Param(description = "the total number of public ip addresses available for this account to acquire")
+ @Param(description = "The total number of public IP addresses available for this Account to acquire")
private String ipAvailable;
@SerializedName("volumelimit")
- @Param(description = "the total volume which can be used by this account")
+ @Param(description = "The total volume which can be used by this Account")
private String volumeLimit;
@SerializedName("volumetotal")
- @Param(description = "the total volume being used by this account")
+ @Param(description = "The total volume being used by this Account")
private Long volumeTotal;
@SerializedName("volumeavailable")
- @Param(description = "the total volume available for this account")
+ @Param(description = "The total volume available for this Account")
private String volumeAvailable;
@SerializedName("snapshotlimit")
- @Param(description = "the total number of snapshots which can be stored by this account")
+ @Param(description = "The total number of Snapshots which can be stored by this Account")
private String snapshotLimit;
@SerializedName("snapshottotal")
- @Param(description = "the total number of snapshots stored by this account")
+ @Param(description = "The total number of Snapshots stored by this Account")
private Long snapshotTotal;
@SerializedName("snapshotavailable")
- @Param(description = "the total number of snapshots available for this account")
+ @Param(description = "The total number of Snapshots available for this Account")
private String snapshotAvailable;
@SerializedName("templatelimit")
- @Param(description = "the total number of templates which can be created by this account")
+ @Param(description = "The total number of Templates which can be created by this Account")
private String templateLimit;
@SerializedName("templatetotal")
- @Param(description = "the total number of templates which have been created by this account")
+ @Param(description = "The total number of Templates which have been created by this Account")
private Long templateTotal;
@SerializedName("templateavailable")
- @Param(description = "the total number of templates available to be created by this account")
+ @Param(description = "The total number of Templates available to be created by this Account")
private String templateAvailable;
@SerializedName("vmstopped")
- @Param(description = "the total number of virtual machines stopped for this account")
+ @Param(description = "The total number of Instances stopped for this Account")
private Integer vmStopped;
@SerializedName("vmrunning")
- @Param(description = "the total number of virtual machines running for this account")
+ @Param(description = "The total number of Instances running for this Account")
private Integer vmRunning;
@SerializedName("projectlimit")
- @Param(description = "the total number of projects the account can own", since = "3.0.1")
+ @Param(description = "The total number of projects the Account can own", since = "3.0.1")
private String projectLimit;
@SerializedName("projecttotal")
- @Param(description = "the total number of projects being administrated by this account", since = "3.0.1")
+ @Param(description = "The total number of projects being administrated by this Account", since = "3.0.1")
private Long projectTotal;
@SerializedName("projectavailable")
- @Param(description = "the total number of projects available for administration by this account", since = "3.0.1")
+ @Param(description = "The total number of projects available for administration by this Account", since = "3.0.1")
private String projectAvailable;
@SerializedName("networklimit")
- @Param(description = "the total number of networks the account can own", since = "3.0.1")
+ @Param(description = "The total number of Networks the Account can own", since = "3.0.1")
private String networkLimit;
@SerializedName("networktotal")
- @Param(description = "the total number of networks owned by account", since = "3.0.1")
+ @Param(description = "The total number of Networks owned by Account", since = "3.0.1")
private Long networkTotal;
@SerializedName("networkavailable")
- @Param(description = "the total number of networks available to be created for this account", since = "3.0.1")
+ @Param(description = "The total number of Networks available to be created for this Account", since = "3.0.1")
private String networkAvailable;
@SerializedName("vpclimit")
- @Param(description = "the total number of vpcs the account can own", since = "4.0.0")
+ @Param(description = "The total number of VPCs the Account can own", since = "4.0.0")
private String vpcLimit;
@SerializedName("vpctotal")
- @Param(description = "the total number of vpcs owned by account", since = "4.0.0")
+ @Param(description = "The total number of VPCs owned by account", since = "4.0.0")
private Long vpcTotal;
@SerializedName("vpcavailable")
- @Param(description = "the total number of vpcs available to be created for this account", since = "4.0.0")
+ @Param(description = "The total number of VPCs available to be created for this account", since = "4.0.0")
private String vpcAvailable;
@SerializedName("cpulimit")
- @Param(description = "the total number of cpu cores the account can own", since = "4.2.0")
+ @Param(description = "The total number of CPU cores the account can own", since = "4.2.0")
private String cpuLimit;
@SerializedName("cputotal")
- @Param(description = "the total number of cpu cores owned by account", since = "4.2.0")
+ @Param(description = "The total number of CPU cores owned by account", since = "4.2.0")
private Long cpuTotal;
@SerializedName("cpuavailable")
- @Param(description = "the total number of cpu cores available to be created for this account", since = "4.2.0")
+ @Param(description = "The total number of CPU cores available to be created for this account", since = "4.2.0")
private String cpuAvailable;
@SerializedName("memorylimit")
- @Param(description = "the total memory (in MB) the account can own", since = "4.2.0")
+ @Param(description = "The total memory (in MB) the account can own", since = "4.2.0")
private String memoryLimit;
@SerializedName("memorytotal")
- @Param(description = "the total memory (in MB) owned by account", since = "4.2.0")
+ @Param(description = "The total memory (in MB) owned by account", since = "4.2.0")
private Long memoryTotal;
@SerializedName("memoryavailable")
- @Param(description = "the total memory (in MB) available to be created for this account", since = "4.2.0")
+ @Param(description = "The total memory (in MB) available to be created for this account", since = "4.2.0")
private String memoryAvailable;
@SerializedName("primarystoragelimit")
- @Param(description = "the total primary storage space (in GiB) the account can own", since = "4.2.0")
+ @Param(description = "The total primary storage space (in GiB) the account can own", since = "4.2.0")
private String primaryStorageLimit;
@SerializedName("primarystoragetotal")
- @Param(description = "the total primary storage space (in GiB) owned by account", since = "4.2.0")
+ @Param(description = "The total primary storage space (in GiB) owned by account", since = "4.2.0")
private Long primaryStorageTotal;
@SerializedName("primarystorageavailable")
- @Param(description = "the total primary storage space (in GiB) available to be used for this account", since = "4.2.0")
+ @Param(description = "The total primary storage space (in GiB) available to be used for this account", since = "4.2.0")
private String primaryStorageAvailable;
@SerializedName("secondarystoragelimit")
- @Param(description = "the total secondary storage space (in GiB) the account can own", since = "4.2.0")
+ @Param(description = "The total secondary storage space (in GiB) the account can own", since = "4.2.0")
private String secondaryStorageLimit;
@SerializedName("secondarystoragetotal")
- @Param(description = "the total secondary storage space (in GiB) owned by account", since = "4.2.0")
+ @Param(description = "The total secondary storage space (in GiB) owned by account", since = "4.2.0")
private float secondaryStorageTotal;
@SerializedName("secondarystorageavailable")
- @Param(description = "the total secondary storage space (in GiB) available to be used for this account", since = "4.2.0")
+ @Param(description = "The total secondary storage space (in GiB) available to be used for this account", since = "4.2.0")
private String secondaryStorageAvailable;
@SerializedName(ApiConstants.STATE)
- @Param(description = "the state of the account")
+ @Param(description = "The state of the account")
private String state;
@SerializedName(ApiConstants.IS_CLEANUP_REQUIRED)
- @Param(description = "true if the account requires cleanup")
+ @Param(description = "True if the account requires cleanup")
private Boolean cleanupRequired;
@SerializedName(ApiConstants.CREATED)
- @Param(description="the date when this account was created")
+ @Param(description = "The date when this account was created")
private Date created;
@SerializedName("user")
- @Param(description = "the list of users associated with account", responseObject = UserResponse.class)
+ @Param(description = "The list of users associated with account", responseObject = UserResponse.class)
private List users;
@SerializedName(ApiConstants.NETWORK_DOMAIN)
- @Param(description = "the network domain")
+ @Param(description = "The Network domain")
private String networkDomain;
@SerializedName(ApiConstants.ACCOUNT_DETAILS)
- @Param(description = "details for the account")
+ @Param(description = "Details for the account")
private Map details;
@SerializedName(ApiConstants.IS_DEFAULT)
- @Param(description = "true if account is default, false otherwise", since = "4.2.0")
+ @Param(description = "True if account is default, false otherwise", since = "4.2.0")
private Boolean isDefault;
@SerializedName(ApiConstants.IAM_GROUPS)
- @Param(description = "the list of acl groups that account belongs to", since = "4.4")
+ @Param(description = "The list of ACL groups that account belongs to", since = "4.4")
private List groups;
@SerializedName(ApiConstants.RESOURCE_ICON)
@@ -464,7 +464,7 @@ public class AccountResponse extends BaseResponse implements ResourceLimitAndCou
@Override
public void setVpcLimit(String vpcLimit) {
- this.vpcLimit = networkLimit;
+ this.vpcLimit = vpcLimit;
}
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/AcquireIPAddressResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/AcquireIPAddressResponse.java
index 06351a40d9d..cb0b1405477 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/AcquireIPAddressResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/AcquireIPAddressResponse.java
@@ -32,47 +32,47 @@ import com.google.gson.annotations.SerializedName;
@SuppressWarnings("unused")
public class AcquireIPAddressResponse extends BaseResponse implements ControlledEntityResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "public IP address id")
+ @Param(description = "Public IP address id")
private String id;
@SerializedName(ApiConstants.IP_ADDRESS)
- @Param(description = "public IP address")
+ @Param(description = "Public IP address")
private String ipAddress;
@SerializedName("allocated")
- @Param(description = "date the public IP address was acquired")
+ @Param(description = "Date the public IP address was acquired")
private Date allocated;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "the ID of the zone the public IP address belongs to")
+ @Param(description = "The ID of the zone the public IP address belongs to")
private String zoneId;
@SerializedName(ApiConstants.ZONE_NAME)
- @Param(description = "the name of the zone the public IP address belongs to")
+ @Param(description = "The name of the zone the public IP address belongs to")
private String zoneName;
@SerializedName("issourcenat")
- @Param(description = "true if the IP address is a source nat address, false otherwise")
+ @Param(description = "True if the IP address is a source NAT address, false otherwise")
private Boolean sourceNat;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account the public IP address is associated with")
+ @Param(description = "The Account the public IP address is associated with")
private String accountName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the ipaddress")
+ @Param(description = "The project id of the IP address")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the address")
+ @Param(description = "The project name of the address")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain ID the public IP address is associated with")
+ @Param(description = "The domain ID the public IP address is associated with")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain the public IP address is associated with")
+ @Param(description = "The domain the public IP address is associated with")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
@@ -80,78 +80,78 @@ public class AcquireIPAddressResponse extends BaseResponse implements Controlle
private String domainPath;
@SerializedName(ApiConstants.FOR_VIRTUAL_NETWORK)
- @Param(description = "the virtual network for the IP address")
+ @Param(description = "The virtual Network for the IP address")
private Boolean forVirtualNetwork;
@SerializedName(ApiConstants.VLAN_ID)
- @Param(description = "the ID of the VLAN associated with the IP address." + " This parameter is visible to ROOT admins only")
+ @Param(description = "The ID of the VLAN associated with the IP address." + " This parameter is visible to ROOT admins only")
private String vlanId;
@SerializedName("vlanname")
- @Param(description = "the VLAN associated with the IP address")
+ @Param(description = "The VLAN associated with the IP address")
private String vlanName;
@SerializedName("isstaticnat")
- @Param(description = "true if this ip is for static nat, false otherwise")
+ @Param(description = "True if this IP is for static NAT, false otherwise")
private Boolean staticNat;
@SerializedName(ApiConstants.IS_SYSTEM)
- @Param(description = "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)")
+ @Param(description = "True if this IP is system IP (was allocated as a part of deployVm or createLbRule)")
private Boolean isSystem;
@SerializedName(ApiConstants.VIRTUAL_MACHINE_ID)
- @Param(description = "virtual machine id the ip address is assigned to (not null only for static nat Ip)")
+ @Param(description = "Instance id the IP address is assigned to (not null only for static NAT IP)")
private String virtualMachineId;
@SerializedName("vmipaddress")
- @Param(description = "virtual machine (dnat) ip address (not null only for static nat Ip)")
+ @Param(description = "Instance (DNAT) IP address (not null only for static NAT IP)")
private String virtualMachineIp;
@SerializedName("virtualmachinename")
- @Param(description = "virtual machine name the ip address is assigned to (not null only for static nat Ip)")
+ @Param(description = "Instance name the IP address is assigned to (not null only for static NAT IP)")
private String virtualMachineName;
@SerializedName("virtualmachinedisplayname")
- @Param(description = "virtual machine display name the ip address is assigned to (not null only for static nat Ip)")
+ @Param(description = "Instance display name the IP address is assigned to (not null only for static NAT IP)")
private String virtualMachineDisplayName;
@SerializedName(ApiConstants.ASSOCIATED_NETWORK_ID)
- @Param(description = "the ID of the Network associated with the IP address")
+ @Param(description = "The ID of the Network associated with the IP address")
private String associatedNetworkId;
@SerializedName(ApiConstants.ASSOCIATED_NETWORK_NAME)
- @Param(description = "the name of the Network associated with the IP address")
+ @Param(description = "The name of the Network associated with the IP address")
private String associatedNetworkName;
@SerializedName(ApiConstants.NETWORK_ID)
- @Param(description = "the ID of the Network where ip belongs to")
+ @Param(description = "The ID of the Network where IP belongs to")
private String networkId;
@SerializedName(ApiConstants.STATE)
- @Param(description = "State of the ip address. Can be: Allocating, Allocated and Releasing")
+ @Param(description = "State of the IP address. Can be: Allocating, Allocated and Releasing")
private String state;
@SerializedName(ApiConstants.PHYSICAL_NETWORK_ID)
- @Param(description = "the physical network this belongs to")
+ @Param(description = "The physical Network this belongs to")
private String physicalNetworkId;
@SerializedName(ApiConstants.PURPOSE)
- @Param(description = "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value")
+ @Param(description = "Purpose of the IP address. In Acton this value is not null for IPs with isSystem=true, and can have either StaticNat or LB value")
private String purpose;
@SerializedName(ApiConstants.VPC_ID)
- @Param(description = "VPC the ip belongs to")
+ @Param(description = "VPC the IP belongs to")
private String vpcId;
@SerializedName(ApiConstants.TAGS)
- @Param(description = "the list of resource tags associated with ip address", responseObject = ResourceTagResponse.class)
+ @Param(description = "The list of resource tags associated with IP address", responseObject = ResourceTagResponse.class)
private List tags;
@SerializedName(ApiConstants.IS_PORTABLE)
- @Param(description = "is public IP portable across the zones")
+ @Param(description = "Is public IP portable across the zones")
private Boolean isPortable;
@SerializedName(ApiConstants.FOR_DISPLAY)
- @Param(description = "is public ip for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
+ @Param(description = "Is public IP for display to the regular User", since = "4.4", authorized = {RoleType.Admin})
private Boolean forDisplay;
public void setIpAddress(String ipAddress) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/AcquirePodIpCmdResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/AcquirePodIpCmdResponse.java
index 2226efd063d..fb95c5b8130 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/AcquirePodIpCmdResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/AcquirePodIpCmdResponse.java
@@ -31,7 +31,7 @@ public class AcquirePodIpCmdResponse extends BaseResponse {
private String ipAddress;
@SerializedName(ApiConstants.POD_ID)
- @Param(description = "the ID of the pod the IP address belongs to")
+ @Param(description = "The ID of the pod the IP address belongs to")
private Long podId;
@SerializedName(ApiConstants.GATEWAY)
@@ -43,15 +43,15 @@ public class AcquirePodIpCmdResponse extends BaseResponse {
private String cidrAddress;
@SerializedName(ApiConstants.NIC_ID)
- @Param(description = "the ID of the nic")
+ @Param(description = "The ID of the NIC")
private Long nicId;
@SerializedName(ApiConstants.HOST_MAC)
- @Param(description = "MAC address of the pod the IP")
+ @Param(description = "MAC address of the pod the IP")
private Long macAddress;
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the pod the IP address")
+ @Param(description = "The ID of the pod the IP address")
private long id;
public void setIpAddress(String ipAddress) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/AlertResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/AlertResponse.java
index faa64b0c090..00c94a6fd0e 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/AlertResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/AlertResponse.java
@@ -31,7 +31,7 @@ import com.cloud.serializer.Param;
@SuppressWarnings("unused")
public class AlertResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the id of the alert")
+ @Param(description = "The ID of the alert")
private String id;
@SerializedName(ApiConstants.TYPE)
@@ -46,15 +46,15 @@ public class AlertResponse extends BaseResponse {
private Short alertType;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the alert", since = "4.3")
+ @Param(description = "The name of the alert", since = "4.3")
private String alertName;
@SerializedName(ApiConstants.DESCRIPTION)
- @Param(description = "description of the alert")
+ @Param(description = "Description of the alert")
private String description;
@SerializedName(ApiConstants.SENT)
- @Param(description = "the date and time the alert was sent")
+ @Param(description = "The date and time the alert was sent")
private Date lastSent;
public void setId(String id) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/AnnotationResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/AnnotationResponse.java
index 86d485ac751..62ffd6c6256 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/AnnotationResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/AnnotationResponse.java
@@ -32,31 +32,31 @@ import java.util.Date;
@EntityReference(value = Annotation.class)
public class AnnotationResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the (uu)id of the annotation")
+ @Param(description = "The UUID of the annotation")
private String uuid;
@SerializedName(ApiConstants.ENTITY_TYPE)
- @Param(description = "the type of the annotated entity")
+ @Param(description = "The type of the annotated entity")
private String entityType;
@SerializedName(ApiConstants.ENTITY_ID)
- @Param(description = "the (uu)id of the entity to which this annotation pertains")
+ @Param(description = "The UUID of the entity to which this annotation pertains")
private String entityUuid;
@SerializedName(ApiConstants.ENTITY_NAME)
- @Param(description = "the name of the entity to which this annotation pertains")
+ @Param(description = "The name of the entity to which this annotation pertains")
private String entityName;
@SerializedName(ApiConstants.ANNOTATION)
- @Param(description = "the contents of the annotation")
+ @Param(description = "The contents of the annotation")
private String annotation;
@SerializedName(ApiConstants.USER_ID)
- @Param(description = "The (uu)id of the user that entered the annotation")
+ @Param(description = "The UUID of the User that entered the annotation")
private String userUuid;
@SerializedName(ApiConstants.USERNAME)
- @Param(description = "The username of the user that entered the annotation")
+ @Param(description = "The username of the User that entered the annotation")
private String username;
@SerializedName(ApiConstants.ADMINS_ONLY)
@@ -64,11 +64,11 @@ public class AnnotationResponse extends BaseResponse {
private Boolean adminsOnly;
@SerializedName(ApiConstants.CREATED)
- @Param(description = "the creation timestamp for this annotation")
+ @Param(description = "The creation timestamp for this annotation")
private Date created;
@SerializedName(ApiConstants.REMOVED)
- @Param(description = "the removal timestamp for this annotation")
+ @Param(description = "The removal timestamp for this annotation")
private Date removed;
public String getUuid() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ApplicationLoadBalancerInstanceResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ApplicationLoadBalancerInstanceResponse.java
index bdbb954df03..2ebc25e7240 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ApplicationLoadBalancerInstanceResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ApplicationLoadBalancerInstanceResponse.java
@@ -32,19 +32,19 @@ import com.google.gson.annotations.SerializedName;
public class ApplicationLoadBalancerInstanceResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the instance ID")
+ @Param(description = "The Instance ID")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the instance")
+ @Param(description = "The name of the Instance")
private String name;
@SerializedName(ApiConstants.STATE)
- @Param(description = "the state of the instance")
+ @Param(description = "The state of the Instance")
private String state;
@SerializedName(ApiConstants.IP_ADDRESS)
- @Param(description = "the ip address of the instance")
+ @Param(description = "The IP address of the Instance")
private String ipAddress;
public void setId(String id) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ApplicationLoadBalancerResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ApplicationLoadBalancerResponse.java
index 0b6485bfc14..e900bebe05f 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ApplicationLoadBalancerResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ApplicationLoadBalancerResponse.java
@@ -29,51 +29,51 @@ import com.google.gson.annotations.SerializedName;
@SuppressWarnings("unused")
public class ApplicationLoadBalancerResponse extends BaseResponse implements ControlledEntityResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the Load Balancer ID")
+ @Param(description = "The Load Balancer ID")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the Load Balancer")
+ @Param(description = "The name of the Load Balancer")
private String name;
@SerializedName(ApiConstants.DESCRIPTION)
- @Param(description = "the description of the Load Balancer")
+ @Param(description = "The description of the Load Balancer")
private String description;
@SerializedName(ApiConstants.ALGORITHM)
- @Param(description = "the load balancer algorithm (source, roundrobin, leastconn)")
+ @Param(description = "The Load balancer algorithm (source, roundrobin, leastconn)")
private String algorithm;
@SerializedName(ApiConstants.NETWORK_ID)
- @Param(description = "Load Balancer network id")
+ @Param(description = "Load Balancer Network id")
private String networkId;
@SerializedName(ApiConstants.SOURCE_IP)
- @Param(description = "Load Balancer source ip")
+ @Param(description = "Load Balancer source IP")
private String sourceIp;
@SerializedName(ApiConstants.SOURCE_IP_NETWORK_ID)
- @Param(description = "Load Balancer source ip network id")
+ @Param(description = "Load Balancer source IP Network id")
private String sourceIpNetworkId;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account of the Load Balancer")
+ @Param(description = "The Account of the Load Balancer")
private String accountName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the Load Balancer")
+ @Param(description = "The project id of the Load Balancer")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the Load Balancer")
+ @Param(description = "The project name of the Load Balancer")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain ID of the Load Balancer")
+ @Param(description = "The domain ID of the Load Balancer")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain of the Load Balancer")
+ @Param(description = "The domain of the Load Balancer")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
@@ -81,19 +81,19 @@ public class ApplicationLoadBalancerResponse extends BaseResponse implements Con
private String domainPath;
@SerializedName("loadbalancerrule")
- @Param(description = "the list of rules associated with the Load Balancer", responseObject = ApplicationLoadBalancerRuleResponse.class)
+ @Param(description = "The list of rules associated with the Load Balancer", responseObject = ApplicationLoadBalancerRuleResponse.class)
private List lbRules;
@SerializedName("loadbalancerinstance")
- @Param(description = "the list of instances associated with the Load Balancer", responseObject = ApplicationLoadBalancerInstanceResponse.class)
+ @Param(description = "The list of Instances associated with the Load Balancer", responseObject = ApplicationLoadBalancerInstanceResponse.class)
private List lbInstances;
@SerializedName(ApiConstants.TAGS)
- @Param(description = "the list of resource tags associated with the Load Balancer", responseObject = ResourceTagResponse.class)
+ @Param(description = "The list of resource tags associated with the Load Balancer", responseObject = ResourceTagResponse.class)
private List tags;
@SerializedName(ApiConstants.FOR_DISPLAY)
- @Param(description = "is rule for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
+ @Param(description = "Is rule for display to the regular User", since = "4.4", authorized = {RoleType.Admin})
private Boolean forDisplay;
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ApplicationLoadBalancerRuleResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ApplicationLoadBalancerRuleResponse.java
index 8af64276c9e..d6d8c2f9556 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ApplicationLoadBalancerRuleResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ApplicationLoadBalancerRuleResponse.java
@@ -30,15 +30,15 @@ import com.cloud.serializer.Param;
@SuppressWarnings("unused")
public class ApplicationLoadBalancerRuleResponse extends BaseResponse {
@SerializedName(ApiConstants.SOURCE_PORT)
- @Param(description = "source port of the load balancer rule")
+ @Param(description = "Source port of the Load balancer rule")
private Integer sourcePort;
@SerializedName(ApiConstants.INSTANCE_PORT)
- @Param(description = "instance port of the load balancer rule")
+ @Param(description = "Instance port of the Load balancer rule")
private Integer instancePort;
@SerializedName(ApiConstants.STATE)
- @Param(description = "the state of the load balancer rule")
+ @Param(description = "The state of the Load balancer rule")
private String state;
public void setSourcePort(Integer sourcePort) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/AsyncJobResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/AsyncJobResponse.java
index 3eeaaef2afa..c769177b68f 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/AsyncJobResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/AsyncJobResponse.java
@@ -32,67 +32,67 @@ import com.cloud.serializer.Param;
public class AsyncJobResponse extends BaseResponse {
@SerializedName("accountid")
- @Param(description = "the account id that executed the async command")
+ @Param(description = "The Account ID that executed the async command")
private String accountId;
@SerializedName("account")
- @Param(description = "the account that executed the async command")
+ @Param(description = "The Account that executed the async command")
private String account;
@SerializedName("domainid")
- @Param(description = "the domain id that executed the async command")
+ @Param(description = "The domain ID that executed the async command")
private String domainid;
@SerializedName("domainpath")
- @Param(description = "the domain that executed the async command")
+ @Param(description = "The domain that executed the async command")
private String domainPath;
@SerializedName(ApiConstants.USER_ID)
- @Param(description = "the user that executed the async command")
+ @Param(description = "The User that executed the async command")
private String userId;
@SerializedName("cmd")
- @Param(description = "the async command executed")
+ @Param(description = "The async command executed")
private String cmd;
@SerializedName("jobstatus")
- @Param(description = "the current job status-should be 0 for PENDING")
+ @Param(description = "The current job status-should be 0 for PENDING")
private Integer jobStatus;
@SerializedName("jobprocstatus")
- @Param(description = "the progress information of the PENDING job")
+ @Param(description = "The progress information of the PENDING job")
private Integer jobProcStatus;
@SerializedName("jobresultcode")
- @Param(description = "the result code for the job")
+ @Param(description = "The result code for the job")
private Integer jobResultCode;
@SerializedName("jobresulttype")
- @Param(description = "the result type")
+ @Param(description = "The result type")
private String jobResultType;
@SerializedName("jobresult")
- @Param(description = "the result reason")
+ @Param(description = "The result reason")
private ResponseObject jobResult;
@SerializedName("jobinstancetype")
- @Param(description = "the instance/entity object related to the job")
+ @Param(description = "The Instance/entity object related to the job")
private String jobInstanceType;
@SerializedName("jobinstanceid")
- @Param(description = "the unique ID of the instance/entity object related to the job")
+ @Param(description = "The unique ID of the Instance/entity object related to the job")
private String jobInstanceId;
@SerializedName("managementserverid")
- @Param(description = "the msid of the management server on which the job is running", since = "4.19")
+ @Param(description = "The msid of the management server on which the job is running", since = "4.19")
private Long msid;
@SerializedName(ApiConstants.CREATED)
- @Param(description = " the created date of the job")
+ @Param(description = "The created date of the job")
private Date created;
@SerializedName(ApiConstants.COMPLETED)
- @Param(description = " the completed date of the job")
+ @Param(description = "The completed date of the job")
private Date removed;
public void setAccountId(String accountId) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/AutoScalePolicyResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/AutoScalePolicyResponse.java
index e3f9902dec6..d2155fb2358 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/AutoScalePolicyResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/AutoScalePolicyResponse.java
@@ -31,47 +31,47 @@ import com.cloud.serializer.Param;
public class AutoScalePolicyResponse extends BaseResponse implements ControlledEntityResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the autoscale policy ID")
+ @Param(description = "The autoscale policy ID")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "name of the autoscale policy")
+ @Param(description = "Name of the autoscale policy")
private String name;
@SerializedName(ApiConstants.ACTION)
- @Param(description = "the action to be executed if all the conditions evaluate to true for the specified duration.")
+ @Param(description = "The action to be executed if all the conditions evaluate to true for the specified duration.")
private String action;
@SerializedName(ApiConstants.DURATION)
- @Param(description = "the duration for which the conditions have to be true before action is taken")
+ @Param(description = "The duration for which the conditions have to be true before action is taken")
private Integer duration;
@SerializedName(ApiConstants.QUIETTIME)
- @Param(description = "the cool down period for which the policy should not be evaluated after the action has been taken")
+ @Param(description = "The cool down period for which the policy should not be evaluated after the action has been taken")
private Integer quietTime;
@SerializedName("conditions")
- @Param(description = "the list of IDs of the conditions that are being evaluated on every interval")
+ @Param(description = "The list of IDs of the conditions that are being evaluated on every interval")
private List conditions;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account owning the autoscale policy")
+ @Param(description = "The Account owning the autoscale policy")
private String accountName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id autoscale policy")
+ @Param(description = "The project id autoscale policy")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the autoscale policy")
+ @Param(description = "The project name of the autoscale policy")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain ID of the autoscale policy")
+ @Param(description = "The domain ID of the autoscale policy")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain name of the autoscale policy")
+ @Param(description = "The domain name of the autoscale policy")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/AutoScaleVmGroupResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/AutoScaleVmGroupResponse.java
index b1389acdecb..921e3f6166a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/AutoScaleVmGroupResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/AutoScaleVmGroupResponse.java
@@ -32,95 +32,95 @@ import com.google.gson.annotations.SerializedName;
public class AutoScaleVmGroupResponse extends BaseResponseWithAnnotations implements ControlledEntityResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the autoscale vm group ID")
+ @Param(description = "The autoscale Instance group ID")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the autoscale vm group ")
+ @Param(description = "The name of the autoscale Instance group ")
private String name;
@SerializedName(ApiConstants.LBID)
- @Param(description = "the load balancer rule ID")
+ @Param(description = "The Load balancer rule ID")
private String loadBalancerId;
@SerializedName(ApiConstants.ASSOCIATED_NETWORK_NAME)
- @Param(description = "the name of the guest network the lb rule belongs to")
+ @Param(description = "The name of the guest Network the LB rule belongs to")
private String networkName;
@SerializedName(ApiConstants.ASSOCIATED_NETWORK_ID)
- @Param(description = "the id of the guest network the lb rule belongs to")
+ @Param(description = "The id of the guest Network the LB rule belongs to")
private String networkId;
@SerializedName(ApiConstants.LB_PROVIDER)
- @Param(description = "the lb provider of the guest network the lb rule belongs to")
+ @Param(description = "The LB provider of the guest Network the LB rule belongs to")
private String lbProvider;
@SerializedName(ApiConstants.PUBLIC_IP_ID)
- @Param(description = "the public ip address id")
+ @Param(description = "The public IP address ID")
private String publicIpId;
@SerializedName(ApiConstants.PUBLIC_IP)
- @Param(description = "the public ip address")
+ @Param(description = "The public IP address")
private String publicIp;
@SerializedName(ApiConstants.PUBLIC_PORT)
- @Param(description = "the public port")
+ @Param(description = "The public port")
private String publicPort;
@SerializedName(ApiConstants.PRIVATE_PORT)
- @Param(description = "the private port")
+ @Param(description = "The private port")
private String privatePort;
@SerializedName(ApiConstants.VMPROFILE_ID)
- @Param(description = "the autoscale profile that contains information about the vms in the vm group.")
+ @Param(description = "The autoscale profile that contains information about the Instances in the Instance group.")
private String profileId;
@SerializedName(ApiConstants.MIN_MEMBERS)
- @Param(description = "the minimum number of members in the vmgroup, the number of instances in the vm group will be equal to or more than this number.")
+ @Param(description = "The minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.")
private int minMembers;
@SerializedName(ApiConstants.MAX_MEMBERS)
- @Param(description = "the maximum number of members in the vmgroup, The number of instances in the vm group will be equal to or less than this number.")
+ @Param(description = "The maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.")
private int maxMembers;
@SerializedName(ApiConstants.AVAILABLE_VIRTUAL_MACHINE_COUNT)
- @Param(description = "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", since = "4.18.0")
+ @Param(description = "The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group", since = "4.18.0")
private int availableVirtualMachineCount;
@SerializedName(ApiConstants.INTERVAL)
- @Param(description = "the frequency at which the conditions have to be evaluated")
+ @Param(description = "The frequency at which the conditions have to be evaluated")
private int interval;
@SerializedName(ApiConstants.STATE)
- @Param(description = "the current state of the AutoScale Vm Group")
+ @Param(description = "The current state of the AutoScale Instance Group")
private String state;
@SerializedName(ApiConstants.SCALEUP_POLICIES)
- @Param(description = "list of scaleup autoscale policies")
+ @Param(description = "List of scaleup autoscale policies")
private List scaleUpPolicies;
@SerializedName(ApiConstants.SCALEDOWN_POLICIES)
- @Param(description = "list of scaledown autoscale policies")
+ @Param(description = "List of scaledown autoscale policies")
private List scaleDownPolicies;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account owning the vm group")
+ @Param(description = "The Account owning the Instance group")
private String accountName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the vm group")
+ @Param(description = "The project id of the Instance group")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the vm group")
+ @Param(description = "The project name of the Instance group")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain ID of the vm group")
+ @Param(description = "The domain ID of the Instance group")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain name of the vm group")
+ @Param(description = "The domain name of the Instance group")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
@@ -128,11 +128,11 @@ public class AutoScaleVmGroupResponse extends BaseResponseWithAnnotations implem
private String domainPath;
@SerializedName(ApiConstants.FOR_DISPLAY)
- @Param(description = "is group for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
+ @Param(description = "Is group for display to the regular User", since = "4.4", authorized = {RoleType.Admin})
private Boolean forDisplay;
@SerializedName(ApiConstants.CREATED)
- @Param(description = "the date when this vm group was created")
+ @Param(description = "The date when this Instance group was created")
private Date created;
public AutoScaleVmGroupResponse() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/AutoScaleVmProfileResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/AutoScaleVmProfileResponse.java
index 22e4eb2288b..2eda8210fcf 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/AutoScaleVmProfileResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/AutoScaleVmProfileResponse.java
@@ -36,29 +36,29 @@ import com.google.gson.annotations.SerializedName;
public class AutoScaleVmProfileResponse extends BaseResponse implements ControlledEntityResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the autoscale vm profile ID")
+ @Param(description = "The autoscale Instance profile ID")
private String id;
/* Parameters related to deploy virtual machine */
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "the availability zone to be used while deploying a virtual machine")
+ @Param(description = "The availability zone to be used while deploying an Instance")
private String zoneId;
@SerializedName(ApiConstants.SERVICE_OFFERING_ID)
- @Param(description = "the service offering to be used while deploying a virtual machine")
+ @Param(description = "The service offering to be used while deploying an Instance")
private String serviceOfferingId;
@SerializedName(ApiConstants.TEMPLATE_ID)
- @Param(description = "the template to be used while deploying a virtual machine")
+ @Param(description = "The Template to be used while deploying an Instance")
private String templateId;
@SerializedName(ApiConstants.OTHER_DEPLOY_PARAMS)
- @Param(description = "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine")
+ @Param(description = "Parameters other than zoneId/serviceOfferringId/templateId to be used while deploying an Instance")
private Map otherDeployParams;
/* Parameters related to destroying a virtual machine */
@SerializedName(ApiConstants.AUTOSCALE_EXPUNGE_VM_GRACE_PERIOD)
- @Param(description = "the time allowed for existing connections to get closed before a vm is destroyed")
+ @Param(description = "The time allowed for existing connections to get closed before an Instance is destroyed")
private Integer expungeVmGracePeriod;
/* Parameters related to a running virtual machine - monitoring aspects */
@@ -69,7 +69,7 @@ public class AutoScaleVmProfileResponse extends BaseResponse implements Controll
private Map counterParams;
@SerializedName(ApiConstants.USER_DATA)
- @Param(description = "Base64 encoded VM user data")
+ @Param(description = "Base64 encoded Instance user data")
private String userData;
@SerializedName(ApiConstants.USER_DATA_ID) @Param(description="the id of userdata used for the VM", since = "4.18.1")
@@ -85,33 +85,33 @@ public class AutoScaleVmProfileResponse extends BaseResponse implements Controll
private String userDataDetails;
@SerializedName(ApiConstants.AUTOSCALE_USER_ID)
- @Param(description = "the ID of the user used to launch and destroy the VMs")
+ @Param(description = "The ID of the User used to launch and destroy the Instances")
private String autoscaleUserId;
@Parameter(name = ApiConstants.CS_URL,
type = CommandType.STRING,
- description = "the API URL including port of the CloudStack Management Server example: http://server.cloud.com:8080/client/api?")
+ description = "The API URL including port of the CloudStack Management Server example: http://server.cloud.com:8080/client/api?")
// leaving cloud.com reference above as it serves only as an example
private String csUrl;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account owning the instance group")
+ @Param(description = "The Account owning the Instance group")
private String accountName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id vm profile")
+ @Param(description = "The project id Instance profile")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the vm profile")
+ @Param(description = "The project name of the Instance profile")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain ID of the vm profile")
+ @Param(description = "The domain ID of the Instance profile")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain name of the vm profile")
+ @Param(description = "The domain name of the Instance profile")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
@@ -119,7 +119,7 @@ public class AutoScaleVmProfileResponse extends BaseResponse implements Controll
private String domainPath;
@SerializedName(ApiConstants.FOR_DISPLAY)
- @Param(description = "is profile for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
+ @Param(description = "Is profile for display to the regular User", since = "4.4", authorized = {RoleType.Admin})
private Boolean forDisplay;
public AutoScaleVmProfileResponse() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/BackupOfferingResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/BackupOfferingResponse.java
index 480ebcfb13d..3d4f7f706a0 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/BackupOfferingResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/BackupOfferingResponse.java
@@ -34,31 +34,31 @@ public class BackupOfferingResponse extends BaseResponse {
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "name for the backup offering")
+ @Param(description = "Name for the backup offering")
private String name;
@SerializedName(ApiConstants.DESCRIPTION)
- @Param(description = "description for the backup offering")
+ @Param(description = "Description for the backup offering")
private String description;
@SerializedName(ApiConstants.EXTERNAL_ID)
- @Param(description = "external ID on the provider side")
+ @Param(description = "External ID on the provider side")
private String externalId;
@SerializedName(ApiConstants.ALLOW_USER_DRIVEN_BACKUPS)
- @Param(description = "whether offering allows user driven ad-hoc/scheduled backups")
+ @Param(description = "Whether the offering allows User driven ad-hoc/scheduled backups")
private Boolean userDrivenBackups;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "zone ID")
+ @Param(description = "Zone ID")
private String zoneId;
@SerializedName(ApiConstants.ZONE_NAME)
- @Param(description = "zone name")
+ @Param(description = "Zone name")
private String zoneName;
@SerializedName(ApiConstants.CREATED)
- @Param(description = "the date this backup offering was created")
+ @Param(description = "The date this backup offering was created")
private Date created;
public void setId(String id) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/BackupProviderResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/BackupProviderResponse.java
index 5227d850887..af74c509b10 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/BackupProviderResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/BackupProviderResponse.java
@@ -28,11 +28,11 @@ import com.google.gson.annotations.SerializedName;
@EntityReference(BackupProvider.class)
public class BackupProviderResponse extends BaseResponse {
@SerializedName(ApiConstants.NAME)
- @Param(description = "the CA service provider name")
+ @Param(description = "The CA service provider name")
private String name;
@SerializedName(ApiConstants.DESCRIPTION)
- @Param(description = "the description of the CA service provider")
+ @Param(description = "The description of the CA service provider")
private String description;
public String getName() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/BackupResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/BackupResponse.java
index 63419680fea..44b67ed996b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/BackupResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/BackupResponse.java
@@ -31,75 +31,75 @@ import java.util.Date;
public class BackupResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "ID of the VM backup")
+ @Param(description = "ID of the Instance backup")
private String id;
@SerializedName(ApiConstants.VIRTUAL_MACHINE_ID)
- @Param(description = "ID of the VM")
+ @Param(description = "ID of the Instance")
private String vmId;
@SerializedName(ApiConstants.VIRTUAL_MACHINE_NAME)
- @Param(description = "name of the VM")
+ @Param(description = "Name of the Instance")
private String vmName;
@SerializedName(ApiConstants.EXTERNAL_ID)
- @Param(description = "external backup id")
+ @Param(description = "External backup id")
private String externalId;
@SerializedName(ApiConstants.TYPE)
- @Param(description = "backup type")
+ @Param(description = "Backup type")
private String type;
@SerializedName(ApiConstants.CREATED)
- @Param(description = "backup date")
+ @Param(description = "Backup date")
private Date date;
@SerializedName(ApiConstants.SIZE)
- @Param(description = "backup size in bytes")
+ @Param(description = "Backup size in bytes")
private Long size;
@SerializedName(ApiConstants.VIRTUAL_SIZE)
- @Param(description = "backup protected (virtual) size in bytes")
+ @Param(description = "Backup protected (virtual) size in bytes")
private Long protectedSize;
@SerializedName(ApiConstants.STATUS)
- @Param(description = "backup status")
+ @Param(description = "Backup status")
private Backup.Status status;
@SerializedName(ApiConstants.VOLUMES)
- @Param(description = "backed up volumes")
+ @Param(description = "Backed up volumes")
private String volumes;
@SerializedName(ApiConstants.BACKUP_OFFERING_ID)
- @Param(description = "backup offering id")
+ @Param(description = "Backup offering id")
private String backupOfferingId;
@SerializedName(ApiConstants.BACKUP_OFFERING_NAME)
- @Param(description = "backup offering name")
+ @Param(description = "Backup offering name")
private String backupOfferingName;
@SerializedName(ApiConstants.ACCOUNT_ID)
- @Param(description = "account id")
+ @Param(description = "Account id")
private String accountId;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "account name")
+ @Param(description = "Account name")
private String account;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "domain id")
+ @Param(description = "Domain ID")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "domain name")
+ @Param(description = "Domain name")
private String domain;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "zone id")
+ @Param(description = "Zone ID")
private String zoneId;
@SerializedName(ApiConstants.ZONE)
- @Param(description = "zone name")
+ @Param(description = "Zone name")
private String zone;
public String getId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/BackupRestorePointResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/BackupRestorePointResponse.java
index 22bb099b1b0..e338fe6b35f 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/BackupRestorePointResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/BackupRestorePointResponse.java
@@ -31,15 +31,15 @@ import java.util.Date;
public class BackupRestorePointResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "external id of the restore point")
+ @Param(description = "External ID of the restore point")
private String id;
@SerializedName(ApiConstants.CREATED)
- @Param(description = "created time")
+ @Param(description = "Created time")
private Date created;
@SerializedName(ApiConstants.TYPE)
- @Param(description = "restore point type")
+ @Param(description = "Restore point type")
private String type;
public String getId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/BackupScheduleResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/BackupScheduleResponse.java
index ba44f1e024f..b9987a8e25b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/BackupScheduleResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/BackupScheduleResponse.java
@@ -30,23 +30,23 @@ import com.google.gson.annotations.SerializedName;
public class BackupScheduleResponse extends BaseResponse {
@SerializedName(ApiConstants.VIRTUAL_MACHINE_NAME)
- @Param(description = "name of the VM")
+ @Param(description = "Name of the Instance")
private String vmName;
@SerializedName(ApiConstants.VIRTUAL_MACHINE_ID)
- @Param(description = "ID of the VM")
+ @Param(description = "ID of the Instance")
private String vmId;
@SerializedName("schedule")
- @Param(description = "time the backup is scheduled to be taken.")
+ @Param(description = "Time the backup is scheduled to be taken.")
private String schedule;
@SerializedName("intervaltype")
- @Param(description = "the interval type of the backup schedule")
+ @Param(description = "The interval type of the backup schedule")
private DateUtil.IntervalType intervalType;
@SerializedName("timezone")
- @Param(description = "the time zone of the backup schedule")
+ @Param(description = "The time zone of the backup schedule")
private String timezone;
public String getVmName() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/BaseRolePermissionResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/BaseRolePermissionResponse.java
index c39939a20a6..ee563085704 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/BaseRolePermissionResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/BaseRolePermissionResponse.java
@@ -27,15 +27,15 @@ import com.google.gson.annotations.SerializedName;
public class BaseRolePermissionResponse extends BaseResponse {
@SerializedName(ApiConstants.RULE)
- @Param(description = "the api name or wildcard rule")
+ @Param(description = "The api name or wildcard rule")
private String rule;
@SerializedName(ApiConstants.PERMISSION)
- @Param(description = "the permission type of the api name or wildcard rule, allow/deny")
+ @Param(description = "The permission type of the api name or wildcard rule, allow/deny")
private String rulePermission;
@SerializedName(ApiConstants.DESCRIPTION)
- @Param(description = "the description of the role permission")
+ @Param(description = "The description of the role permission")
private String ruleDescription;
public String getRule() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/BaseRoleResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/BaseRoleResponse.java
index b1bba905bc6..68484149f01 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/BaseRoleResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/BaseRoleResponse.java
@@ -25,19 +25,19 @@ import com.google.gson.annotations.SerializedName;
public class BaseRoleResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the role")
+ @Param(description = "The ID of the role")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the role")
+ @Param(description = "The name of the role")
private String roleName;
@SerializedName(ApiConstants.DESCRIPTION)
- @Param(description = "the description of the role")
+ @Param(description = "The description of the role")
private String roleDescription;
@SerializedName(ApiConstants.IS_PUBLIC)
- @Param(description = "Indicates whether the role will be visible to all users (public) or only to root admins (private)." +
+ @Param(description = "Indicates whether the role will be visible to all Users (public) or only to root admins (private)." +
" If this parameter is not specified during the creation of the role its value will be defaulted to true (public).")
private boolean publicRole = true;
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/CAProviderResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/CAProviderResponse.java
index 94d5882e18a..84d4da5e103 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/CAProviderResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/CAProviderResponse.java
@@ -27,11 +27,11 @@ import org.apache.cloudstack.framework.ca.CAProvider;
@EntityReference(value = CAProvider.class)
public class CAProviderResponse extends BaseResponse {
@SerializedName(ApiConstants.NAME)
- @Param(description = "the CA service provider name")
+ @Param(description = "The CA service provider name")
private String name;
@SerializedName(ApiConstants.DESCRIPTION)
- @Param(description = "the description of the CA service provider")
+ @Param(description = "The description of the CA service provider")
private String description;
public String getName() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/CapabilitiesResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/CapabilitiesResponse.java
index 3861ac455ed..6b8a2828c70 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/CapabilitiesResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/CapabilitiesResponse.java
@@ -25,51 +25,51 @@ import com.google.gson.annotations.SerializedName;
@SuppressWarnings("unused")
public class CapabilitiesResponse extends BaseResponse {
@SerializedName("securitygroupsenabled")
- @Param(description = "true if security groups support is enabled, false otherwise")
+ @Param(description = "True if security groups support is enabled, false otherwise")
private boolean securityGroupsEnabled;
@SerializedName("dynamicrolesenabled")
- @Param(description = "true if dynamic role-based api checker is enabled, false otherwise")
+ @Param(description = "True if dynamic role-based api checker is enabled, false otherwise")
private boolean dynamicRolesEnabled;
@SerializedName("cloudstackversion")
- @Param(description = "version of the cloud stack")
+ @Param(description = "Version of the CloudStack")
private String cloudStackVersion;
@SerializedName("userpublictemplateenabled")
- @Param(description = "true if user and domain admins can set templates to be shared, false otherwise")
+ @Param(description = "True if user and domain admins can set Templates to be shared, false otherwise")
private boolean userPublicTemplateEnabled;
@SerializedName("supportELB")
- @Param(description = "true if region supports elastic load balancer on basic zones")
+ @Param(description = "True if region supports elastic Load balancer on basic zones")
private String supportELB;
@SerializedName(ApiConstants.PROJECT_INVITE_REQUIRED)
- @Param(description = "If invitation confirmation is required when add account to project")
+ @Param(description = "If invitation confirmation is required when add Account to project")
private Boolean projectInviteRequired;
@SerializedName(ApiConstants.ALLOW_USER_CREATE_PROJECTS)
- @Param(description = "true if regular user is allowed to create projects")
+ @Param(description = "True if regular User is allowed to create projects")
private Boolean allowUsersCreateProjects;
@SerializedName(ApiConstants.CUSTOM_DISK_OFF_MIN_SIZE)
- @Param(description = "minimum size that can be specified when " + "create disk from disk offering with custom size")
+ @Param(description = "Minimum size that can be specified when " + "create disk from disk offering with custom size")
private Long diskOffMinSize;
@SerializedName(ApiConstants.CUSTOM_DISK_OFF_MAX_SIZE)
- @Param(description = "maximum size that can be specified when " + "create disk from disk offering with custom size")
+ @Param(description = "Maximum size that can be specified when " + "create disk from disk offering with custom size")
private Long diskOffMaxSize;
@SerializedName("regionsecondaryenabled")
- @Param(description = "true if region wide secondary is enabled, false otherwise")
+ @Param(description = "True if region wide secondary is enabled, false otherwise")
private boolean regionSecondaryEnabled;
@SerializedName("apilimitinterval")
- @Param(description = "time interval (in seconds) to reset api count")
+ @Param(description = "Time interval (in seconds) to reset api count")
private Integer apiLimitInterval;
@SerializedName("kvmsnapshotenabled")
- @Param(description = "true if snapshot is supported for KVM host, false otherwise")
+ @Param(description = "True if Snapshot is supported for KVM host, false otherwise")
private boolean kvmSnapshotEnabled;
@SerializedName("apilimitmax")
@@ -77,19 +77,19 @@ public class CapabilitiesResponse extends BaseResponse {
private Integer apiLimitMax;
@SerializedName("allowuserviewdestroyedvm")
- @Param(description = "true if the user is allowed to view destroyed virtualmachines, false otherwise", since = "4.6.0")
+ @Param(description = "True if the User is allowed to view the destroyed Instances, false otherwise", since = "4.6.0")
private boolean allowUserViewDestroyedVM;
@SerializedName("allowuserexpungerecovervm")
- @Param(description = "true if the user can recover and expunge virtualmachines, false otherwise", since = "4.6.0")
+ @Param(description = "True if the User can recover and expunge Instances, false otherwise", since = "4.6.0")
private boolean allowUserExpungeRecoverVM;
@SerializedName("allowuserexpungerecovervolume")
- @Param(description = "true if the user can recover and expunge volumes, false otherwise", since = "4.14.0")
+ @Param(description = "True if the User can recover and expunge volumes, false otherwise", since = "4.14.0")
private boolean allowUserExpungeRecoverVolume;
@SerializedName("allowuserviewalldomainaccounts")
- @Param(description = "true if users can see all accounts within the same domain, false otherwise")
+ @Param(description = "True if Users can see all Accounts within the same domain, false otherwise")
private boolean allowUserViewAllDomainAccounts;
@SerializedName(ApiConstants.ALLOW_USER_FORCE_STOP_VM)
@@ -97,11 +97,11 @@ public class CapabilitiesResponse extends BaseResponse {
private boolean allowUserForceStopVM;
@SerializedName("kubernetesserviceenabled")
- @Param(description = "true if Kubernetes Service plugin is enabled, false otherwise")
+ @Param(description = "True if Kubernetes Service plugin is enabled, false otherwise")
private boolean kubernetesServiceEnabled;
@SerializedName("kubernetesclusterexperimentalfeaturesenabled")
- @Param(description = "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise")
+ @Param(description = "True if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise")
private boolean kubernetesClusterExperimentalFeaturesEnabled;
@SerializedName("customhypervisordisplayname")
@@ -109,23 +109,23 @@ public class CapabilitiesResponse extends BaseResponse {
private String customHypervisorDisplayName;
@SerializedName("defaultuipagesize")
- @Param(description = "default page size in the UI for various views, value set in the configurations", since = "4.15.2")
+ @Param(description = "Default page size in the UI for various views, value set in the configurations", since = "4.15.2")
private Long defaultUiPageSize;
@SerializedName(ApiConstants.INSTANCES_STATS_RETENTION_TIME)
- @Param(description = "the retention time for Instances stats", since = "4.18.0")
+ @Param(description = "The retention time for Instances stats", since = "4.18.0")
private Integer instancesStatsRetentionTime;
@SerializedName(ApiConstants.INSTANCES_STATS_USER_ONLY)
- @Param(description = "true if stats are collected only for user instances, false if system instance stats are also collected", since = "4.18.0")
+ @Param(description = "True if stats are collected only for User Instances, false if System VM stats are also collected", since = "4.18.0")
private Boolean instancesStatsUserOnly;
@SerializedName(ApiConstants.INSTANCES_DISKS_STATS_RETENTION_ENABLED)
- @Param(description = "true if stats are retained for instance disks otherwise false", since = "4.18.0")
+ @Param(description = "True if stats are retained for Instance disks otherwise false", since = "4.18.0")
private Boolean instancesDisksStatsRetentionEnabled;
@SerializedName(ApiConstants.INSTANCES_DISKS_STATS_RETENTION_TIME)
- @Param(description = "the retention time for Instances disks stats", since = "4.18.0")
+ @Param(description = "The retention time for Instances disks stats", since = "4.18.0")
private Integer instancesDisksStatsRetentionTime;
@SerializedName(ApiConstants.SHAREDFSVM_MIN_CPU_COUNT)
@@ -136,6 +136,14 @@ public class CapabilitiesResponse extends BaseResponse {
@Param(description = "the min Ram size for the service offering used by the shared filesystem instance", since = "4.20.0")
private Integer sharedFsVmMinRamSize;
+ @SerializedName(ApiConstants.DYNAMIC_SCALING_ENABLED)
+ @Param(description = "true if dynamically scaling for instances is enabled", since = "4.21.0")
+ private Boolean dynamicScalingEnabled;
+
+ @SerializedName(ApiConstants.ADDITONAL_CONFIG_ENABLED)
+ @Param(description = "true if additional configurations or extraconfig can be passed to Instances", since = "4.20.2")
+ private Boolean additionalConfigEnabled;
+
public void setSecurityGroupsEnabled(boolean securityGroupsEnabled) {
this.securityGroupsEnabled = securityGroupsEnabled;
}
@@ -247,4 +255,12 @@ public class CapabilitiesResponse extends BaseResponse {
public void setSharedFsVmMinRamSize(Integer sharedFsVmMinRamSize) {
this.sharedFsVmMinRamSize = sharedFsVmMinRamSize;
}
+
+ public void setDynamicScalingEnabled(Boolean dynamicScalingEnabled) {
+ this.dynamicScalingEnabled = dynamicScalingEnabled;
+ }
+
+ public void setAdditionalConfigEnabled(Boolean additionalConfigEnabled) {
+ this.additionalConfigEnabled = additionalConfigEnabled;
+ }
}
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/CapabilityResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/CapabilityResponse.java
index 6862a5541eb..67a5b33b6a9 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/CapabilityResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/CapabilityResponse.java
@@ -26,15 +26,15 @@ import com.cloud.serializer.Param;
public class CapabilityResponse extends BaseResponse {
@SerializedName(ApiConstants.NAME)
- @Param(description = "the capability name")
+ @Param(description = "The capability name")
private String name;
@SerializedName(ApiConstants.VALUE)
- @Param(description = "the capability value")
+ @Param(description = "The capability value")
private String value;
@SerializedName(ApiConstants.CAN_CHOOSE_SERVICE_CAPABILITY)
- @Param(description = "can this service capability value can be choosable while creatine network offerings")
+ @Param(description = "Can this service capability value can be choosable while creatine Network offerings")
private boolean canChoose;
public String getName() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/CapacityResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/CapacityResponse.java
index 2d0e2158651..e01a7323fee 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/CapacityResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/CapacityResponse.java
@@ -24,51 +24,51 @@ import com.google.gson.annotations.SerializedName;
public class CapacityResponse extends BaseResponse {
@SerializedName(ApiConstants.TYPE)
- @Param(description = "the capacity type")
+ @Param(description = "The capacity type")
private Short capacityType;
@SerializedName(ApiConstants.NAME)
- @Param(description="the capacity name")
+ @Param(description = "The capacity name")
private String capacityName;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "the Zone ID")
+ @Param(description = "The Zone ID")
private String zoneId;
@SerializedName(ApiConstants.ZONE_NAME)
- @Param(description = "the Zone name")
+ @Param(description = "The Zone name")
private String zoneName;
@SerializedName(ApiConstants.POD_ID)
- @Param(description = "the Pod ID")
+ @Param(description = "The Pod ID")
private String podId;
@SerializedName("podname")
- @Param(description = "the Pod name")
+ @Param(description = "The Pod name")
private String podName;
@SerializedName(ApiConstants.CLUSTER_ID)
- @Param(description = "the Cluster ID")
+ @Param(description = "The Cluster ID")
private String clusterId;
@SerializedName("clustername")
- @Param(description = "the Cluster name")
+ @Param(description = "The Cluster name")
private String clusterName;
@SerializedName("capacityallocated")
- @Param(description="the capacity currently in allocated")
+ @Param(description = "The capacity currently in allocated")
private Long capacityAllocated;
@SerializedName("capacityused")
- @Param(description = "the capacity currently in use")
+ @Param(description = "The capacity currently in use")
private Long capacityUsed;
@SerializedName("capacitytotal")
- @Param(description = "the total capacity available")
+ @Param(description = "The total capacity available")
private Long capacityTotal;
@SerializedName("percentused")
- @Param(description = "the percentage of capacity currently in use")
+ @Param(description = "The percentage of capacity currently in use")
private String percentUsed;
@SerializedName(ApiConstants.TAG)
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ChildTemplateResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ChildTemplateResponse.java
index 8f5b5de2919..d757b59f028 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ChildTemplateResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ChildTemplateResponse.java
@@ -28,19 +28,19 @@ import com.google.gson.annotations.SerializedName;
@SuppressWarnings("unused")
public class ChildTemplateResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the template ID")
+ @Param(description = "The Template ID")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the template name")
+ @Param(description = "The Template name")
private String name;
@SerializedName(ApiConstants.SIZE)
- @Param(description = "the size of the template")
+ @Param(description = "The size of the Template")
private Integer size;
@SerializedName(ApiConstants.TEMPLATE_TYPE)
- @Param(description = "the type of the template")
+ @Param(description = "The type of the Template")
private String templateType;
public String getId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/CloudIdentifierResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/CloudIdentifierResponse.java
index 94520ef2f8f..e87bdf00c31 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/CloudIdentifierResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/CloudIdentifierResponse.java
@@ -26,15 +26,15 @@ import com.cloud.serializer.Param;
public class CloudIdentifierResponse extends BaseResponse {
@SerializedName(ApiConstants.USER_ID)
- @Param(description = "the user ID for the cloud identifier")
+ @Param(description = "The User ID for the cloud identifier")
private String userId;
@SerializedName("cloudidentifier")
- @Param(description = "the cloud identifier")
+ @Param(description = "The cloud identifier")
private String cloudIdentifier;
@SerializedName("signature")
- @Param(description = "the signed response for the cloud identifier")
+ @Param(description = "The signed response for the cloud identifier")
private String signature;
public String getUserId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ClusterResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ClusterResponse.java
index 1c69849239f..a2e8fba8e8c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ClusterResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ClusterResponse.java
@@ -32,51 +32,51 @@ import com.google.gson.annotations.SerializedName;
@EntityReference(value = Cluster.class)
public class ClusterResponse extends BaseResponseWithAnnotations {
@SerializedName(ApiConstants.ID)
- @Param(description = "the cluster ID")
+ @Param(description = "The cluster ID")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the cluster name")
+ @Param(description = "The cluster name")
private String name;
@SerializedName(ApiConstants.POD_ID)
- @Param(description = "the Pod ID of the cluster")
+ @Param(description = "The Pod ID of the cluster")
private String podId;
@SerializedName("podname")
- @Param(description = "the Pod name of the cluster")
+ @Param(description = "The Pod name of the cluster")
private String podName;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "the Zone ID of the cluster")
+ @Param(description = "The Zone ID of the cluster")
private String zoneId;
@SerializedName(ApiConstants.ZONE_NAME)
- @Param(description = "the Zone name of the cluster")
+ @Param(description = "The Zone name of the cluster")
private String zoneName;
@SerializedName("hypervisortype")
- @Param(description = "the hypervisor type of the cluster")
+ @Param(description = "The hypervisor type of the cluster")
private String hypervisorType;
@SerializedName("clustertype")
- @Param(description = "the type of the cluster")
+ @Param(description = "The type of the cluster")
private String clusterType;
@SerializedName("allocationstate")
- @Param(description = "the allocation state of the cluster")
+ @Param(description = "The allocation state of the cluster")
private String allocationState;
@SerializedName("managedstate")
- @Param(description = "whether this cluster is managed by cloudstack")
+ @Param(description = "Whether this cluster is managed by Cloudstack")
private String managedState;
@SerializedName("capacity")
- @Param(description = "the capacity of the Cluster", responseObject = CapacityResponse.class)
+ @Param(description = "The capacity of the Cluster", responseObject = CapacityResponse.class)
private List capacities;
@SerializedName("cpuovercommitratio")
- @Param(description = "The cpu overcommit ratio of the cluster")
+ @Param(description = "The CPU overcommit ratio of the cluster")
private String cpuovercommitratio;
@SerializedName("memoryovercommitratio")
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ConditionResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ConditionResponse.java
index 1038177cb86..d27a1cdf672 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ConditionResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ConditionResponse.java
@@ -30,7 +30,7 @@ import com.cloud.serializer.Param;
@SuppressWarnings("unused")
public class ConditionResponse extends BaseResponse implements ControlledEntityResponse {
@SerializedName("id")
- @Param(description = "the id of the Condition")
+ @Param(description = "The ID of the Condition")
private String id;
@SerializedName(value = ApiConstants.THRESHOLD)
@@ -42,11 +42,11 @@ public class ConditionResponse extends BaseResponse implements ControlledEntityR
private String relationalOperator;
@SerializedName("counterid")
- @Param(description = "the Id of the Counter.")
+ @Param(description = "The ID of the Counter.")
private String counterId;
@SerializedName("countername")
- @Param(description = "the Name of the Counter.")
+ @Param(description = "The Name of the Counter.")
private String counterName;
@SerializedName("counter")
@@ -54,11 +54,11 @@ public class ConditionResponse extends BaseResponse implements ControlledEntityR
private CounterResponse counterResponse;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain id of the Condition owner")
+ @Param(description = "The domain ID of the Condition owner")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain name of the owner.")
+ @Param(description = "The domain name of the owner.")
private String domain;
@SerializedName(ApiConstants.DOMAIN_PATH)
@@ -66,19 +66,19 @@ public class ConditionResponse extends BaseResponse implements ControlledEntityR
private String domainPath;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "zone id of counter")
+ @Param(description = "Zone ID of counter")
private String zoneId;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the Condition.")
+ @Param(description = "The project ID of the Condition.")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the Condition")
+ @Param(description = "The project name of the Condition")
private String projectName;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the owner of the Condition.")
+ @Param(description = "The owner of the Condition.")
private String accountName;
// /////////////////////////////////////////////////
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ConfigurationGroupResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ConfigurationGroupResponse.java
index 053ee5fdc35..32926a71d8a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ConfigurationGroupResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ConfigurationGroupResponse.java
@@ -27,19 +27,19 @@ import com.cloud.serializer.Param;
public class ConfigurationGroupResponse extends BaseResponse {
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the configuration group")
+ @Param(description = "The name of the configuration group")
private String groupName;
@SerializedName(ApiConstants.SUBGROUP)
- @Param(description = "the subgroups of the configuration group", responseObject = ConfigurationSubGroupResponse.class)
+ @Param(description = "The subgroups of the configuration group", responseObject = ConfigurationSubGroupResponse.class)
private List subGroups;
@SerializedName(ApiConstants.DESCRIPTION)
- @Param(description = "the description of the configuration group")
+ @Param(description = "The description of the configuration group")
private String description;
@SerializedName(ApiConstants.PRECEDENCE)
- @Param(description = "the precedence of the configuration group")
+ @Param(description = "The precedence of the configuration group")
private Long precedence;
public String getGroupName() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ConfigurationResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ConfigurationResponse.java
index 1818e914a97..416f0102d85 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ConfigurationResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ConfigurationResponse.java
@@ -25,63 +25,63 @@ import com.cloud.serializer.Param;
public class ConfigurationResponse extends BaseResponse {
@SerializedName(ApiConstants.CATEGORY)
- @Param(description = "the category of the configuration")
+ @Param(description = "The category of the configuration")
private String category;
@SerializedName(ApiConstants.GROUP)
- @Param(description = "the group of the configuration", since = "4.18.0")
+ @Param(description = "The group of the configuration", since = "4.18.0")
private String group;
@SerializedName(ApiConstants.SUBGROUP)
- @Param(description = "the subgroup of the configuration", since = "4.18.0")
+ @Param(description = "The subgroup of the configuration", since = "4.18.0")
private String subGroup;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the configuration")
+ @Param(description = "The name of the configuration")
private String name;
@SerializedName(ApiConstants.VALUE)
- @Param(description = "the value of the configuration")
+ @Param(description = "The value of the configuration")
private String value;
@SerializedName(ApiConstants.DEFAULT_VALUE)
- @Param(description = "the default value of the configuration", since = "4.18.0")
+ @Param(description = "The default value of the configuration", since = "4.18.0")
private String defaultValue;
@SerializedName(ApiConstants.SCOPE)
- @Param(description = "scope(zone/cluster/pool/account) of the parameter that needs to be updated")
+ @Param(description = "Scope (zone/cluster/pool/account) of the parameter that needs to be updated")
private String scope;
@SerializedName(ApiConstants.ID)
- @Param(description = "the value of the configuration")
+ @Param(description = "The value of the configuration")
private Long id;
@SerializedName(ApiConstants.DESCRIPTION)
- @Param(description = "the description of the configuration")
+ @Param(description = "The description of the configuration")
private String description;
@SerializedName(ApiConstants.IS_DYNAMIC)
- @Param(description = "true if the configuration is dynamic")
+ @Param(description = "True if the configuration is dynamic")
private boolean isDynamic;
@SerializedName(ApiConstants.COMPONENT)
- @Param(description = "the component of the configuration", since = "4.18.0")
+ @Param(description = "The component of the configuration", since = "4.18.0")
private String component;
@SerializedName(ApiConstants.PARENT)
- @Param(description = "the name of the parent configuration", since = "4.18.0")
+ @Param(description = "The name of the parent configuration", since = "4.18.0")
private String parent;
@SerializedName(ApiConstants.DISPLAY_TEXT)
- @Param(description = "the display text of the configuration", since = "4.18.0")
+ @Param(description = "The display text of the configuration", since = "4.18.0")
private String displayText;
@SerializedName(ApiConstants.TYPE)
- @Param(description = "the type of the configuration value", since = "4.18.0")
+ @Param(description = "The type of the configuration value", since = "4.18.0")
private String type;
@SerializedName(ApiConstants.OPTIONS)
- @Param(description = "the possible options of the configuration value", since = "4.18.0")
+ @Param(description = "The possible options of the configuration value", since = "4.18.0")
private String options;
public String getCategory() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ConfigurationSubGroupResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ConfigurationSubGroupResponse.java
index fda8e18b361..81f1bbd4576 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ConfigurationSubGroupResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ConfigurationSubGroupResponse.java
@@ -25,11 +25,11 @@ import com.cloud.serializer.Param;
public class ConfigurationSubGroupResponse extends BaseResponse {
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the configuration subgroup")
+ @Param(description = "The name of the configuration subgroup")
private String subGroupName;
@SerializedName(ApiConstants.PRECEDENCE)
- @Param(description = "the precedence of the configuration subgroup")
+ @Param(description = "The precedence of the configuration subgroup")
private Long precedence;
public String getSubGroupName() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ConsoleEndpointWebsocketResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ConsoleEndpointWebsocketResponse.java
index d98b52d0863..0cc6a53019a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ConsoleEndpointWebsocketResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ConsoleEndpointWebsocketResponse.java
@@ -27,23 +27,23 @@ public class ConsoleEndpointWebsocketResponse extends BaseResponse {
}
@SerializedName(ApiConstants.TOKEN)
- @Param(description = "the console websocket token")
+ @Param(description = "The console websocket token")
private String token;
@SerializedName("host")
- @Param(description = "the console websocket host")
+ @Param(description = "The console websocket host")
private String host;
@SerializedName(ApiConstants.PORT)
- @Param(description = "the console websocket port")
+ @Param(description = "The console websocket port")
private String port;
@SerializedName(ApiConstants.PATH)
- @Param(description = "the console websocket path")
+ @Param(description = "The console websocket path")
private String path;
@SerializedName("extra")
- @Param(description = "the console websocket extra field for validation (if enabled)")
+ @Param(description = "The console websocket extra field for validation (if enabled)")
private String extra;
public String getToken() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/CounterResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/CounterResponse.java
index f013690b64c..d4b4bed7e2b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/CounterResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/CounterResponse.java
@@ -30,7 +30,7 @@ import com.cloud.serializer.Param;
@EntityReference(value = Counter.class)
public class CounterResponse extends BaseResponse {
@SerializedName("id")
- @Param(description = "the id of the Counter")
+ @Param(description = "The ID of the Counter")
private String id;
@SerializedName(value = ApiConstants.NAME)
@@ -46,7 +46,7 @@ public class CounterResponse extends BaseResponse {
private String value;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "zone id of counter")
+ @Param(description = "Zone ID of counter")
private String zoneId;
@SerializedName(value = ApiConstants.PROVIDER)
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/CreateConsoleEndpointResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/CreateConsoleEndpointResponse.java
index c60917bbe7a..90c9743b66f 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/CreateConsoleEndpointResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/CreateConsoleEndpointResponse.java
@@ -27,19 +27,19 @@ public class CreateConsoleEndpointResponse extends BaseResponse {
}
@SerializedName(ApiConstants.RESULT)
- @Param(description = "true if the console endpoint is generated properly")
+ @Param(description = "True if the console endpoint is generated properly")
private Boolean result;
@SerializedName(ApiConstants.DETAILS)
- @Param(description = "details in case of an error")
+ @Param(description = "Details in case of an error")
private String details;
@SerializedName(ApiConstants.URL)
- @Param(description = "the console url")
+ @Param(description = "The console url")
private String url;
@SerializedName("websocket")
- @Param(description = "the console websocket options")
+ @Param(description = "The console websocket options")
private ConsoleEndpointWebsocketResponse websocketResponse;
public Boolean getResult() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/CustomCertificateResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/CustomCertificateResponse.java
index 44b73276918..ca6e454db1e 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/CustomCertificateResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/CustomCertificateResponse.java
@@ -25,7 +25,7 @@ import com.cloud.serializer.Param;
public class CustomCertificateResponse extends BaseResponse {
@SerializedName("message")
- @Param(description = "message of the certificate upload operation")
+ @Param(description = "Message of the certificate upload operation")
private String message;
public String getResultMessage() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/DataCenterGuestIpv6PrefixResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/DataCenterGuestIpv6PrefixResponse.java
index fd0803f1c58..db4314f5568 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/DataCenterGuestIpv6PrefixResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/DataCenterGuestIpv6PrefixResponse.java
@@ -30,31 +30,31 @@ import com.google.gson.annotations.SerializedName;
@EntityReference(value = DataCenterGuestIpv6Prefix.class)
public class DataCenterGuestIpv6PrefixResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "id of the guest IPv6 prefix")
+ @Param(description = "ID of the guest IPv6 prefix")
private String id;
@SerializedName(ApiConstants.PREFIX)
- @Param(description = "guest IPv6 prefix")
+ @Param(description = "Guest IPv6 prefix")
private String prefix;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "id of zone to which the IPv6 prefix belongs to." )
+ @Param(description = "ID of zone to which the IPv6 prefix belongs to." )
private String zoneId;
@SerializedName(ApiConstants.USED_SUBNETS)
- @Param(description = "count of the used IPv6 subnets for the prefix." )
+ @Param(description = "Count of the used IPv6 subnets for the prefix." )
private Integer usedSubnets;
@SerializedName(ApiConstants.AVAILABLE_SUBNETS)
- @Param(description = "count of the available IPv6 subnets for the prefix." )
+ @Param(description = "Count of the available IPv6 subnets for the prefix." )
private Integer availableSubnets;
@SerializedName(ApiConstants.TOTAL_SUBNETS)
- @Param(description = "count of the total IPv6 subnets for the prefix." )
+ @Param(description = "Count of the total IPv6 subnets for the prefix." )
private Integer totalSubnets;
@SerializedName(ApiConstants.CREATED)
- @Param(description = " date when this IPv6 prefix was created." )
+ @Param(description = "Date when this IPv6 prefix was created." )
private Date created;
public void setId(String id) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/DirectDownloadCertificateHostStatusResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/DirectDownloadCertificateHostStatusResponse.java
index cc9f2fc366a..80c787a0e2a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/DirectDownloadCertificateHostStatusResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/DirectDownloadCertificateHostStatusResponse.java
@@ -24,19 +24,19 @@ import org.apache.cloudstack.api.BaseResponse;
public class DirectDownloadCertificateHostStatusResponse extends BaseResponse {
@SerializedName(ApiConstants.HOST_ID)
- @Param(description = "the ID of the host")
+ @Param(description = "The ID of the host")
private String hostId;
@SerializedName(ApiConstants.HOST_NAME)
- @Param(description = "the name of the host")
+ @Param(description = "The name of the host")
private String hostName;
@SerializedName(ApiConstants.STATUS)
- @Param(description = "indicates if the certificate has been revoked from the host, failed or skipped")
+ @Param(description = "Indicates if the certificate has been revoked from the host, failed or skipped")
private String status;
@SerializedName(ApiConstants.DETAILS)
- @Param(description = "indicates the details in case of failure or host skipped")
+ @Param(description = "Indicates the details in case of failure or host skipped")
private String details;
public String getHostId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/DirectDownloadCertificateResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/DirectDownloadCertificateResponse.java
index f04cba812ba..480d70d8f88 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/DirectDownloadCertificateResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/DirectDownloadCertificateResponse.java
@@ -29,47 +29,47 @@ import java.util.List;
public class DirectDownloadCertificateResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the direct download certificate id")
+ @Param(description = "The direct download certificate ID")
private String id;
@SerializedName(ApiConstants.ALIAS)
- @Param(description = "the direct download certificate alias")
+ @Param(description = "The direct download certificate alias")
private String alias;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "the zone id where the certificate is uploaded")
+ @Param(description = "The zone ID where the certificate is uploaded")
private String zoneId;
@SerializedName(ApiConstants.ZONE_NAME)
- @Param(description = "the zone name where the certificate is uploaded")
+ @Param(description = "The zone name where the certificate is uploaded")
private String zoneName;
@SerializedName(ApiConstants.VERSION)
- @Param(description = "the direct download certificate version")
+ @Param(description = "The direct download certificate version")
private String version;
@SerializedName(ApiConstants.CERTIFICATE_SUBJECT)
- @Param(description = "the direct download certificate subject")
+ @Param(description = "The direct download certificate subject")
private String subject;
@SerializedName(ApiConstants.CERTIFICATE_ISSUER)
- @Param(description = "the direct download certificate issuer")
+ @Param(description = "The direct download certificate issuer")
private String issuer;
@SerializedName(ApiConstants.CERTIFICATE_VALIDITY)
- @Param(description = "the direct download certificate issuer")
+ @Param(description = "The direct download certificate issuer")
private String validity;
@SerializedName(ApiConstants.CERTIFICATE_SERIALNUM)
- @Param(description = "the direct download certificate serial num")
+ @Param(description = "The direct download certificate serial num")
private String serialNum;
@SerializedName(ApiConstants.HYPERVISOR)
- @Param(description = "the hypervisor of the hosts where the certificate is uploaded")
+ @Param(description = "The hypervisor of the hosts where the certificate is uploaded")
private String hypervisor;
@SerializedName(ApiConstants.HOSTS_MAP)
- @Param(description = "the hosts where the certificate is uploaded to", responseObject = HostResponse.class)
+ @Param(description = "The hosts where the certificate is uploaded to", responseObject = HostResponse.class)
private List hostsMap;
public String getId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/DiskOfferingResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/DiskOfferingResponse.java
index 0fed9827ef1..528890ea5fa 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/DiskOfferingResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/DiskOfferingResponse.java
@@ -30,27 +30,27 @@ import com.google.gson.annotations.SerializedName;
@EntityReference(value = DiskOffering.class)
public class DiskOfferingResponse extends BaseResponseWithAnnotations {
@SerializedName(ApiConstants.ID)
- @Param(description = "unique ID of the disk offering")
+ @Param(description = "Unique ID of the disk offering")
private String id;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.")
+ @Param(description = "The domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.")
+ @Param(description = "The domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.")
private String domain;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", since = "4.13.0")
+ @Param(description = "The zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", since = "4.13.0")
private String zoneId;
@SerializedName(ApiConstants.ZONE)
- @Param(description = "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", since = "4.13.0")
+ @Param(description = "The zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", since = "4.13.0")
private String zone;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the disk offering")
+ @Param(description = "The name of the disk offering")
private String name;
@SerializedName(ApiConstants.STATE)
@@ -58,106 +58,106 @@ public class DiskOfferingResponse extends BaseResponseWithAnnotations {
private String state;
@SerializedName(ApiConstants.DISPLAY_TEXT)
- @Param(description = "an alternate display text of the disk offering.")
+ @Param(description = "An alternate display text of the disk offering.")
private String displayText;
@SerializedName(ApiConstants.DISK_SIZE)
- @Param(description = "the size of the disk offering in GB")
+ @Param(description = "The size of the disk offering in GB")
private Long diskSize;
@SerializedName(ApiConstants.CREATED)
- @Param(description = "the date this disk offering was created")
+ @Param(description = "The date this disk offering was created")
private Date created;
@SerializedName("iscustomized")
- @Param(description = "true if disk offering uses custom size, false otherwise")
+ @Param(description = "True if disk offering uses custom size, false otherwise")
private Boolean customized;
@SerializedName("iscustomizediops")
- @Param(description = "true if disk offering uses custom iops, false otherwise")
+ @Param(description = "True if disk offering uses custom IOPS, false otherwise")
private Boolean customizedIops;
@SerializedName(ApiConstants.MIN_IOPS)
- @Param(description = "the min iops of the disk offering")
+ @Param(description = "The min IOPS of the disk offering")
private Long minIops;
@SerializedName(ApiConstants.MAX_IOPS)
- @Param(description = "the max iops of the disk offering")
+ @Param(description = "The max IOPS of the disk offering")
private Long maxIops;
@SerializedName(ApiConstants.HYPERVISOR_SNAPSHOT_RESERVE)
- @Param(description = "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", since = "4.4")
+ @Param(description = "Hypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", since = "4.4")
private Integer hypervisorSnapshotReserve;
@SerializedName(ApiConstants.TAGS)
- @Param(description = "the tags for the disk offering")
+ @Param(description = "The tags for the disk offering")
private String tags;
@SerializedName("storagetype")
- @Param(description = "the storage type for this disk offering")
+ @Param(description = "The storage type for this disk offering")
private String storageType;
- @SerializedName("provisioningtype") @Param(description="provisioning type used to create volumes. Valid values are thin, sparse, fat.", since = "4.4.0")
+ @SerializedName("provisioningtype") @Param(description = "Provisioning type used to create volumes. Valid values are thin, sparse, fat.", since = "4.4.0")
private String provisioningType;
@SerializedName("diskBytesReadRate")
- @Param(description = "bytes read rate of the disk offering")
+ @Param(description = "Bytes read rate of the disk offering")
private Long bytesReadRate;
@SerializedName("diskBytesReadRateMax")
- @Param(description = "burst bytes read rate of the disk offering")
+ @Param(description = "Burst bytes read rate of the disk offering")
private Long bytesReadRateMax;
@SerializedName("diskBytesReadRateMaxLength")
- @Param(description = "length (in seconds) of the burst")
+ @Param(description = "Length (in seconds) of the burst")
private Long bytesReadRateMaxLength;
@SerializedName("diskBytesWriteRate")
- @Param(description = "bytes write rate of the disk offering")
+ @Param(description = "Bytes write rate of the disk offering")
private Long bytesWriteRate;
@SerializedName("diskBytesWriteRateMax")
- @Param(description = "burst bytes write rate of the disk offering")
+ @Param(description = "Burst bytes write rate of the disk offering")
private Long bytesWriteRateMax;
@SerializedName("diskBytesWriteRateMaxLength")
- @Param(description = "length (in seconds) of the burst")
+ @Param(description = "Length (in seconds) of the burst")
private Long bytesWriteRateMaxLength;
@SerializedName("diskIopsReadRate")
- @Param(description = "io requests read rate of the disk offering")
+ @Param(description = "I/O requests read rate of the disk offering")
private Long iopsReadRate;
@SerializedName("diskIopsReadRateMax")
- @Param(description = "burst io requests read rate of the disk offering")
+ @Param(description = "Burst io requests read rate of the disk offering")
private Long iopsReadRateMax;
@SerializedName("diskIopsReadRateMaxLength")
- @Param(description = "length (in second) of the burst")
+ @Param(description = "Length (in second) of the burst")
private Long iopsReadRateMaxLength;
@SerializedName("diskIopsWriteRate")
- @Param(description = "io requests write rate of the disk offering")
+ @Param(description = "I/O requests write rate of the disk offering")
private Long iopsWriteRate;
@SerializedName("diskIopsWriteRateMax")
- @Param(description = "burst io requests write rate of the disk offering")
+ @Param(description = "Burst io requests write rate of the disk offering")
private Long iopsWriteRateMax;
@SerializedName("diskIopsWriteRateMaxLength")
- @Param(description = "length (in seconds) of the burst")
+ @Param(description = "Length (in seconds) of the burst")
private Long iopsWriteRateMaxLength;
@SerializedName("cacheMode")
- @Param(description = "the cache mode to use for this disk offering. none, writeback or writethrough", since = "4.4")
+ @Param(description = "The cache mode to use for this disk offering. none, writeback or writethrough", since = "4.4")
private String cacheMode;
@SerializedName("displayoffering")
- @Param(description = "whether to display the offering to the end user or not.")
+ @Param(description = "Whether to display the offering to the end user or not.")
private Boolean displayOffering;
@SerializedName("vspherestoragepolicy")
- @Param(description = "the vsphere storage policy tagged to the disk offering in case of VMware", since = "4.15")
+ @Param(description = "The vsphere storage policy tagged to the disk offering in case of VMware", since = "4.15")
private String vsphereStoragePolicy;
@@ -170,7 +170,7 @@ public class DiskOfferingResponse extends BaseResponseWithAnnotations {
private Boolean encrypt;
@SerializedName(ApiConstants.DETAILS)
- @Param(description = "additional key/value details tied with this disk offering", since = "4.17")
+ @Param(description = "Additional key/value details tied with this disk offering", since = "4.17")
private Map details;
@SerializedName(ApiConstants.SUITABLE_FOR_VM)
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/DomainResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/DomainResponse.java
index 7c6ad3a91c3..c848c67af46 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/DomainResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/DomainResponse.java
@@ -32,149 +32,149 @@ import java.util.Map;
@EntityReference(value = Domain.class)
public class DomainResponse extends BaseResponseWithAnnotations implements ResourceLimitAndCountResponse, SetResourceIconResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the domain")
+ @Param(description = "The ID of the domain")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the domain")
+ @Param(description = "The name of the domain")
private String domainName;
@SerializedName(ApiConstants.LEVEL)
- @Param(description = "the level of the domain")
+ @Param(description = "The level of the domain")
private Integer level;
@SerializedName("parentdomainid")
- @Param(description = "the domain ID of the parent domain")
+ @Param(description = "The domain ID of the parent domain")
private String parentDomainId;
@SerializedName("parentdomainname")
- @Param(description = "the domain name of the parent domain")
+ @Param(description = "The domain name of the parent domain")
private String parentDomainName;
@SerializedName("haschild")
- @Param(description = "whether the domain has one or more sub-domains")
+ @Param(description = "Whether the domain has one or more sub-domains")
private boolean hasChild;
@SerializedName(ApiConstants.NETWORK_DOMAIN)
- @Param(description = "the network domain")
+ @Param(description = "The Network domain")
private String networkDomain;
@SerializedName(ApiConstants.PATH)
- @Param(description = "the path of the domain")
+ @Param(description = "The path of the domain")
private String path;
- @SerializedName(ApiConstants.STATE) @Param(description="the state of the domain")
+ @SerializedName(ApiConstants.STATE) @Param(description = "The state of the domain")
private String state;
- @SerializedName(ApiConstants.CREATED) @Param(description="the date when this domain was created")
+ @SerializedName(ApiConstants.CREATED) @Param(description = "The date when this domain was created")
private Date created;
- @SerializedName(ApiConstants.VM_LIMIT) @Param(description="the total number of virtual machines that can be deployed by this domain")
+ @SerializedName(ApiConstants.VM_LIMIT) @Param(description = "The total number of Instances that can be deployed by this domain")
private String vmLimit;
- @SerializedName(ApiConstants.VM_TOTAL) @Param(description="the total number of virtual machines deployed by this domain")
+ @SerializedName(ApiConstants.VM_TOTAL) @Param(description = "The total number of Instances deployed by this domain")
private Long vmTotal;
- @SerializedName(ApiConstants.VM_AVAILABLE) @Param(description="the total number of virtual machines available for this domain to acquire")
+ @SerializedName(ApiConstants.VM_AVAILABLE) @Param(description = "The total number of Instances available for this domain to acquire")
private String vmAvailable;
- @SerializedName(ApiConstants.IP_LIMIT) @Param(description="the total number of public ip addresses this domain can acquire")
+ @SerializedName(ApiConstants.IP_LIMIT) @Param(description = "The total number of public IP addresses this domain can acquire")
private String ipLimit;
- @SerializedName(ApiConstants.IP_TOTAL) @Param(description="the total number of public ip addresses allocated for this domain")
+ @SerializedName(ApiConstants.IP_TOTAL) @Param(description = "The total number of public IP addresses allocated for this domain")
private Long ipTotal;
- @SerializedName(ApiConstants.IP_AVAILABLE) @Param(description="the total number of public ip addresses available for this domain to acquire")
+ @SerializedName(ApiConstants.IP_AVAILABLE) @Param(description = "The total number of public IP addresses available for this domain to acquire")
private String ipAvailable;
- @SerializedName("volumelimit") @Param(description="the total volume which can be used by this domain")
+ @SerializedName("volumelimit") @Param(description = "The total volume which can be used by this domain")
private String volumeLimit;
- @SerializedName("volumetotal") @Param(description="the total volume being used by this domain")
+ @SerializedName("volumetotal") @Param(description = "The total volume being used by this domain")
private Long volumeTotal;
- @SerializedName("volumeavailable") @Param(description="the total volume available for this domain")
+ @SerializedName("volumeavailable") @Param(description = "The total volume available for this domain")
private String volumeAvailable;
- @SerializedName("snapshotlimit") @Param(description="the total number of snapshots which can be stored by this domain")
+ @SerializedName("snapshotlimit") @Param(description = "The total number of Snapshots which can be stored by this domain")
private String snapshotLimit;
- @SerializedName("snapshottotal") @Param(description="the total number of snapshots stored by this domain")
+ @SerializedName("snapshottotal") @Param(description = "The total number of Snapshots stored by this domain")
private Long snapshotTotal;
- @SerializedName("snapshotavailable") @Param(description="the total number of snapshots available for this domain")
+ @SerializedName("snapshotavailable") @Param(description = "The total number of Snapshots available for this domain")
private String snapshotAvailable;
- @SerializedName("templatelimit") @Param(description="the total number of templates which can be created by this domain")
+ @SerializedName("templatelimit") @Param(description = "The total number of Templates which can be created by this domain")
private String templateLimit;
- @SerializedName("templatetotal") @Param(description="the total number of templates which have been created by this domain")
+ @SerializedName("templatetotal") @Param(description = "The total number of Templates which have been created by this domain")
private Long templateTotal;
- @SerializedName("templateavailable") @Param(description="the total number of templates available to be created by this domain")
+ @SerializedName("templateavailable") @Param(description = "The total number of Templates available to be created by this domain")
private String templateAvailable;
- @SerializedName("projectlimit") @Param(description="the total number of projects the domain can own", since="3.0.1")
+ @SerializedName("projectlimit") @Param(description = "The total number of projects the domain can own", since="3.0.1")
private String projectLimit;
- @SerializedName("projecttotal") @Param(description="the total number of projects being administrated by this domain", since="3.0.1")
+ @SerializedName("projecttotal") @Param(description = "The total number of projects being administrated by this domain", since="3.0.1")
private Long projectTotal;
- @SerializedName("projectavailable") @Param(description="the total number of projects available for administration by this domain", since="3.0.1")
+ @SerializedName("projectavailable") @Param(description = "The total number of projects available for administration by this domain", since="3.0.1")
private String projectAvailable;
- @SerializedName("networklimit") @Param(description="the total number of networks the domain can own", since="3.0.1")
+ @SerializedName("networklimit") @Param(description = "The total number of Networks the domain can own", since="3.0.1")
private String networkLimit;
- @SerializedName("networktotal") @Param(description="the total number of networks owned by domain", since="3.0.1")
+ @SerializedName("networktotal") @Param(description = "The total number of Networks owned by domain", since="3.0.1")
private Long networkTotal;
- @SerializedName("networkavailable") @Param(description="the total number of networks available to be created for this domain", since="3.0.1")
+ @SerializedName("networkavailable") @Param(description = "The total number of Networks available to be created for this domain", since="3.0.1")
private String networkAvailable;
- @SerializedName("vpclimit") @Param(description="the total number of vpcs the domain can own", since="4.0.0")
+ @SerializedName("vpclimit") @Param(description = "The total number of VPCs the domain can own", since="4.0.0")
private String vpcLimit;
- @SerializedName("vpctotal") @Param(description="the total number of vpcs owned by domain", since="4.0.0")
+ @SerializedName("vpctotal") @Param(description = "The total number of VPCs owned by domain", since="4.0.0")
private Long vpcTotal;
- @SerializedName("vpcavailable") @Param(description="the total number of vpcs available to be created for this domain", since="4.0.0")
+ @SerializedName("vpcavailable") @Param(description = "The total number of VPCs available to be created for this domain", since="4.0.0")
private String vpcAvailable;
- @SerializedName("cpulimit") @Param(description="the total number of cpu cores the domain can own", since="4.2.0")
+ @SerializedName("cpulimit") @Param(description = "The total number of CPU cores the domain can own", since="4.2.0")
private String cpuLimit;
- @SerializedName("cputotal") @Param(description="the total number of cpu cores owned by domain", since="4.2.0")
+ @SerializedName("cputotal") @Param(description = "The total number of CPU cores owned by domain", since="4.2.0")
private Long cpuTotal;
- @SerializedName("cpuavailable") @Param(description="the total number of cpu cores available to be created for this domain", since="4.2.0")
+ @SerializedName("cpuavailable") @Param(description = "The total number of CPU cores available to be created for this domain", since="4.2.0")
private String cpuAvailable;
- @SerializedName("memorylimit") @Param(description="the total memory (in MB) the domain can own", since="4.2.0")
+ @SerializedName("memorylimit") @Param(description = "The total memory (in MB) the domain can own", since="4.2.0")
private String memoryLimit;
- @SerializedName("memorytotal") @Param(description="the total memory (in MB) owned by domain", since="4.2.0")
+ @SerializedName("memorytotal") @Param(description = "The total memory (in MB) owned by domain", since="4.2.0")
private Long memoryTotal;
- @SerializedName("memoryavailable") @Param(description="the total memory (in MB) available to be created for this domain", since="4.2.0")
+ @SerializedName("memoryavailable") @Param(description = "The total memory (in MB) available to be created for this domain", since="4.2.0")
private String memoryAvailable;
- @SerializedName("primarystoragelimit") @Param(description="the total primary storage space (in GiB) the domain can own", since="4.2.0")
+ @SerializedName("primarystoragelimit") @Param(description = "The total primary storage space (in GiB) the domain can own", since="4.2.0")
private String primaryStorageLimit;
- @SerializedName("primarystoragetotal") @Param(description="the total primary storage space (in GiB) owned by domain", since="4.2.0")
+ @SerializedName("primarystoragetotal") @Param(description = "The total primary storage space (in GiB) owned by domain", since="4.2.0")
private Long primaryStorageTotal;
- @SerializedName("primarystorageavailable") @Param(description="the total primary storage space (in GiB) available to be used for this domain", since="4.2.0")
+ @SerializedName("primarystorageavailable") @Param(description = "The total primary storage space (in GiB) available to be used for this domain", since="4.2.0")
private String primaryStorageAvailable;
- @SerializedName("secondarystoragelimit") @Param(description="the total secondary storage space (in GiB) the domain can own", since="4.2.0")
+ @SerializedName("secondarystoragelimit") @Param(description = "The total secondary storage space (in GiB) the domain can own", since="4.2.0")
private String secondaryStorageLimit;
- @SerializedName("secondarystoragetotal") @Param(description="the total secondary storage space (in GiB) owned by domain", since="4.2.0")
+ @SerializedName("secondarystoragetotal") @Param(description = "The total secondary storage space (in GiB) owned by domain", since="4.2.0")
private float secondaryStorageTotal;
- @SerializedName("secondarystorageavailable") @Param(description="the total secondary storage space (in GiB) available to be used for this domain", since="4.2.0")
+ @SerializedName("secondarystorageavailable") @Param(description = "The total secondary storage space (in GiB) available to be used for this domain", since="4.2.0")
private String secondaryStorageAvailable;
@SerializedName(ApiConstants.RESOURCE_ICON)
@@ -182,7 +182,7 @@ public class DomainResponse extends BaseResponseWithAnnotations implements Resou
ResourceIconResponse icon;
@SerializedName(ApiConstants.DOMAIN_DETAILS)
- @Param(description = "details for the domain")
+ @Param(description = "Details for the domain")
private Map details;
@SerializedName(ApiConstants.TAGGED_RESOURCES)
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/DomainRouterResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/DomainRouterResponse.java
index 4b5e886a16e..6c94991e8f0 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/DomainRouterResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/DomainRouterResponse.java
@@ -34,155 +34,155 @@ import com.google.gson.annotations.SerializedName;
@SuppressWarnings("unused")
public class DomainRouterResponse extends BaseResponseWithAnnotations implements ControlledViewEntityResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the id of the router")
+ @Param(description = "The ID of the router")
private String id;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "the Zone ID for the router")
+ @Param(description = "The Zone ID for the router")
private String zoneId;
@SerializedName(ApiConstants.ZONE_NAME)
- @Param(description = "the Zone name for the router")
+ @Param(description = "The Zone name for the router")
private String zoneName;
@SerializedName(ApiConstants.DNS1)
- @Param(description = "the first DNS for the router")
+ @Param(description = "The first DNS for the router")
private String dns1;
@SerializedName(ApiConstants.DNS2)
- @Param(description = "the second DNS for the router")
+ @Param(description = "The second DNS for the router")
private String dns2;
@SerializedName(ApiConstants.IP6_DNS1)
- @Param(description = "the first IPv6 DNS for the router")
+ @Param(description = "The first IPv6 DNS for the router")
private String ip6Dns1;
@SerializedName(ApiConstants.IP6_DNS2)
- @Param(description = "the second IPv6 DNS for the router")
+ @Param(description = "The second IPv6 DNS for the router")
private String ip6Dns2;
@SerializedName("networkdomain")
- @Param(description = "the network domain for the router")
+ @Param(description = "The Network domain for the router")
private String networkDomain;
@SerializedName(ApiConstants.GATEWAY)
- @Param(description = "the gateway for the router")
+ @Param(description = "The gateway for the router")
private String gateway;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the router")
+ @Param(description = "The name of the router")
private String name;
@SerializedName(ApiConstants.POD_ID)
- @Param(description = "the Pod ID for the router")
+ @Param(description = "The Pod ID for the router")
private String podId;
@SerializedName(ApiConstants.POD_NAME)
- @Param(description = "the Pod name for the router", since = "4.13.2")
+ @Param(description = "The Pod name for the router", since = "4.13.2")
private String podName;
@SerializedName(ApiConstants.HOST_ID)
- @Param(description = "the host ID for the router")
+ @Param(description = "The host ID for the router")
private String hostId;
@SerializedName("hostname")
- @Param(description = "the hostname for the router")
+ @Param(description = "The hostname for the router")
private String hostName;
@SerializedName(ApiConstants.HOST_CONTROL_STATE)
- @Param(description = "the control state of the host for the router")
+ @Param(description = "The control state of the host for the router")
private String hostControlState;
@SerializedName("hypervisor")
- @Param(description = "the hypervisor on which the template runs")
+ @Param(description = "The hypervisor on which the Template runs")
private String hypervisor;
@SerializedName(ApiConstants.LINK_LOCAL_IP)
- @Param(description = "the link local IP address for the router")
+ @Param(description = "The Control IP address for the router")
private String linkLocalIp;
@SerializedName(ApiConstants.LINK_LOCAL_MAC_ADDRESS)
- @Param(description = "the link local MAC address for the router")
+ @Param(description = "The link local MAC address for the router")
private String linkLocalMacAddress;
@SerializedName(ApiConstants.LINK_LOCAL_MAC_NETMASK)
- @Param(description = "the link local netmask for the router")
+ @Param(description = "The link local netmask for the router")
private String linkLocalNetmask;
@SerializedName(ApiConstants.LINK_LOCAL_NETWORK_ID)
- @Param(description = "the ID of the corresponding link local network")
+ @Param(description = "The ID of the corresponding link local Network")
private String linkLocalNetworkId;
@SerializedName(ApiConstants.PUBLIC_IP)
- @Param(description = "the public IP address for the router")
+ @Param(description = "The public IP address for the router")
private String publicIp;
@SerializedName("publicmacaddress")
- @Param(description = "the public MAC address for the router")
+ @Param(description = "The public MAC address for the router")
private String publicMacAddress;
@SerializedName("publicnetmask")
- @Param(description = "the public netmask for the router")
+ @Param(description = "The public netmask for the router")
private String publicNetmask;
@SerializedName("publicnetworkid")
- @Param(description = "the ID of the corresponding public network")
+ @Param(description = "The ID of the corresponding public Network")
private String publicNetworkId;
@SerializedName("guestipaddress")
- @Param(description = "the guest IP address for the router")
+ @Param(description = "The guest IP address for the router")
private String guestIpAddress;
@SerializedName("guestmacaddress")
- @Param(description = "the guest MAC address for the router")
+ @Param(description = "The guest MAC address for the router")
private String guestMacAddress;
@SerializedName("guestnetmask")
- @Param(description = "the guest netmask for the router")
+ @Param(description = "The guest netmask for the router")
private String guestNetmask;
@SerializedName("guestnetworkid")
- @Param(description = "the ID of the corresponding guest network")
+ @Param(description = "The ID of the corresponding guest Network")
private String guestNetworkId;
@SerializedName("guestnetworkname")
- @Param(description = "the name of the corresponding guest network")
+ @Param(description = "The name of the corresponding guest Network")
private String guestNetworkName;
@SerializedName(ApiConstants.TEMPLATE_ID)
- @Param(description = "the template ID for the router")
+ @Param(description = "The Template ID for the router")
private String templateId;
@SerializedName(ApiConstants.TEMPLATE_NAME)
- @Param(description = "the template name for the router", since = "4.13.2")
+ @Param(description = "The Template name for the router", since = "4.13.2")
private String templateName;
@SerializedName(ApiConstants.CREATED)
- @Param(description = "the date and time the router was created")
+ @Param(description = "The date and time the router was created")
private Date created;
@SerializedName(ApiConstants.STATE)
- @Param(description = "the state of the router")
+ @Param(description = "The state of the router")
private State state;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account associated with the router")
+ @Param(description = "The Account associated with the router")
private String accountName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the ipaddress")
+ @Param(description = "The project id of the IP address")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the address")
+ @Param(description = "The project name of the address")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain ID associated with the router")
+ @Param(description = "The domain ID associated with the router")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain associated with the router")
+ @Param(description = "The domain associated with the router")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
@@ -190,27 +190,27 @@ public class DomainRouterResponse extends BaseResponseWithAnnotations implements
private String domainPath;
@SerializedName(ApiConstants.SERVICE_OFFERING_ID)
- @Param(description = "the ID of the service offering of the virtual machine")
+ @Param(description = "The ID of the service offering of the Instance")
private String serviceOfferingId;
@SerializedName("serviceofferingname")
- @Param(description = "the name of the service offering of the virtual machine")
+ @Param(description = "The name of the service offering of the Instance")
private String serviceOfferingName;
@SerializedName("isredundantrouter")
- @Param(description = "if this router is an redundant virtual router")
+ @Param(description = "If this router is an redundant virtual router")
private boolean isRedundantRouter;
@SerializedName("redundantstate")
- @Param(description = "the state of redundant virtual router")
+ @Param(description = "The state of redundant virtual router")
private String redundantState;
@SerializedName("version")
- @Param(description = "the version of template")
+ @Param(description = "The version of Template")
private String version;
@SerializedName("scriptsversion")
- @Param(description = "the version of scripts")
+ @Param(description = "The version of scripts")
private String scriptsVersion;
@SerializedName(ApiConstants.VPC_ID)
@@ -218,23 +218,23 @@ public class DomainRouterResponse extends BaseResponseWithAnnotations implements
private String vpcId;
@SerializedName("vpcname")
- @Param(description = "the name of VPC the router belongs to")
+ @Param(description = "The name of VPC the router belongs to")
private String vpcName;
@SerializedName(ApiConstants.ROLE)
- @Param(description = "role of the domain router")
+ @Param(description = "Role of the domain router")
private String role;
@SerializedName("nic")
- @Param(description = "the list of nics associated with the router", responseObject = NicResponse.class, since = "4.0")
+ @Param(description = "The list of NICs associated with the router", responseObject = NicResponse.class, since = "4.0")
private Set nics;
@SerializedName("requiresupgrade")
- @Param(description = "true if the router template requires upgrader")
+ @Param(description = "True if the router Template requires upgrade")
private boolean requiresUpgrade;
@SerializedName(ApiConstants.HEALTHCHECK_FAILED)
- @Param(description = "true if any health checks had failed")
+ @Param(description = "True if any health checks had failed")
private boolean healthChecksFailed;
@SerializedName("healthcheckresults")
@@ -242,7 +242,7 @@ public class DomainRouterResponse extends BaseResponseWithAnnotations implements
List healthCheckResults;
@SerializedName("softwareversion")
- @Param(description = "the version of the code / software in the router")
+ @Param(description = "The version of the code / software in the router")
private String softwareVersion;
@SerializedName(ApiConstants.ARCH)
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/EventResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/EventResponse.java
index 751d00922f1..889b3c41c6b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/EventResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/EventResponse.java
@@ -30,43 +30,43 @@ import com.google.gson.annotations.SerializedName;
@SuppressWarnings("unused")
public class EventResponse extends BaseResponse implements ControlledViewEntityResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the event")
+ @Param(description = "The ID of the event")
private String id;
@SerializedName(ApiConstants.USERNAME)
- @Param(description = "the name of the user who performed the action (can be different from the account if an admin is performing an action for a user, e.g. starting/stopping a user's virtual machine)")
+ @Param(description = "The name of the User who performed the action (can be different from the Account if an admin is performing an action for a User, e.g. starting/stopping a User's Instance)")
private String username;
@SerializedName(ApiConstants.TYPE)
- @Param(description = "the type of the event (see event types)")
+ @Param(description = "The type of the event (see event types)")
private String eventType;
@SerializedName(ApiConstants.LEVEL)
- @Param(description = "the event level (INFO, WARN, ERROR)")
+ @Param(description = "The event level (INFO, WARN, ERROR)")
private String level;
@SerializedName(ApiConstants.DESCRIPTION)
- @Param(description = "a brief description of the event")
+ @Param(description = "A brief description of the event")
private String description;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account name for the account that owns the object being acted on in the event (e.g. the owner of the virtual machine, ip address, or security group)")
+ @Param(description = "The Account name for the Account that owns the object being acted on in the event (e.g. the owner of the Instance, IP address, or security group)")
private String accountName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the ipaddress")
+ @Param(description = "The project ID of the IP address")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the address")
+ @Param(description = "The project name of the address")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the id of the account's domain")
+ @Param(description = "The ID of the Account's domain")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the name of the account's domain")
+ @Param(description = "The name of the Account's domain")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
@@ -74,31 +74,31 @@ public class EventResponse extends BaseResponse implements ControlledViewEntityR
private String domainPath;
@SerializedName(ApiConstants.RESOURCE_ID)
- @Param(description = "the id of the resource", since = "4.17.0")
+ @Param(description = "The ID of the resource", since = "4.17.0")
private String resourceId;
@SerializedName(ApiConstants.RESOURCE_TYPE)
- @Param(description = "the type of the resource", since = "4.17.0")
+ @Param(description = "The type of the resource", since = "4.17.0")
private String resourceType;
@SerializedName(ApiConstants.RESOURCE_NAME)
- @Param(description = "the name of the resource", since = "4.17.0")
+ @Param(description = "The name of the resource", since = "4.17.0")
private String resourceName;
@SerializedName(ApiConstants.CREATED)
- @Param(description = "the date the event was created")
+ @Param(description = "The date the event was created")
private Date created;
@SerializedName(ApiConstants.STATE)
- @Param(description = "the state of the event")
+ @Param(description = "The state of the event")
private Event.State state;
@SerializedName(ApiConstants.PARENT_ID)
- @Param(description = "whether the event is parented")
+ @Param(description = "Whether the event is parented")
private String parentId;
@SerializedName(ApiConstants.ARCHIVED)
- @Param(description = "whether the event has been archived or not")
+ @Param(description = "Whether the event has been archived or not")
private Boolean archived;
public void setId(String id) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ExceptionResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ExceptionResponse.java
index 65d4ac33371..d475dee0620 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ExceptionResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ExceptionResponse.java
@@ -29,19 +29,19 @@ import com.cloud.utils.exception.ExceptionProxyObject;
public class ExceptionResponse extends BaseResponse {
@SerializedName("uuidList")
- @Param(description = "List of uuids associated with this error")
+ @Param(description = "List of UUIDs associated with this error")
private List idList;
@SerializedName("errorcode")
- @Param(description = "numeric code associated with this error")
+ @Param(description = "Numeric code associated with this error")
private Integer errorCode;
@SerializedName("cserrorcode")
- @Param(description = "cloudstack exception error code associated with this error")
+ @Param(description = "Cloudstack exception error code associated with this error")
private Integer csErrorCode;
@SerializedName("errortext")
- @Param(description = "the text associated with this error")
+ @Param(description = "The text associated with this error")
private String errorText = "Command failed due to Internal Server Error";
public ExceptionResponse() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ExternalFirewallResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ExternalFirewallResponse.java
index b92288ddb3f..36e2eabadc5 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ExternalFirewallResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ExternalFirewallResponse.java
@@ -25,47 +25,47 @@ import com.cloud.serializer.Param;
public class ExternalFirewallResponse extends NetworkDeviceResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the external firewall")
+ @Param(description = "The ID of the external firewall")
private String id;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "the zone ID of the external firewall")
+ @Param(description = "The zone ID of the external firewall")
private String zoneId;
@SerializedName(ApiConstants.IP_ADDRESS)
- @Param(description = "the management IP address of the external firewall")
+ @Param(description = "The management IP address of the external firewall")
private String ipAddress;
@SerializedName(ApiConstants.USERNAME)
- @Param(description = "the username that's used to log in to the external firewall")
+ @Param(description = "The username that's used to log in to the external firewall")
private String username;
@SerializedName(ApiConstants.PUBLIC_INTERFACE)
- @Param(description = "the public interface of the external firewall")
+ @Param(description = "The public interface of the external firewall")
private String publicInterface;
@SerializedName(ApiConstants.USAGE_INTERFACE)
- @Param(description = "the usage interface of the external firewall")
+ @Param(description = "The usage interface of the external firewall")
private String usageInterface;
@SerializedName(ApiConstants.PRIVATE_INTERFACE)
- @Param(description = "the private interface of the external firewall")
+ @Param(description = "The private interface of the external firewall")
private String privateInterface;
@SerializedName(ApiConstants.PUBLIC_ZONE)
- @Param(description = "the public security zone of the external firewall")
+ @Param(description = "The public security zone of the external firewall")
private String publicZone;
@SerializedName(ApiConstants.PRIVATE_ZONE)
- @Param(description = "the private security zone of the external firewall")
+ @Param(description = "The private security zone of the external firewall")
private String privateZone;
@SerializedName(ApiConstants.NUM_RETRIES)
- @Param(description = "the number of times to retry requests to the external firewall")
+ @Param(description = "The number of times to retry requests to the external firewall")
private String numRetries;
@SerializedName(ApiConstants.TIMEOUT)
- @Param(description = "the timeout (in seconds) for requests to the external firewall")
+ @Param(description = "The timeout (in seconds) for requests to the external firewall")
private String timeout;
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ExternalLoadBalancerResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ExternalLoadBalancerResponse.java
index fe50b977428..ae25a2cb627 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ExternalLoadBalancerResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ExternalLoadBalancerResponse.java
@@ -25,31 +25,31 @@ import com.cloud.serializer.Param;
public class ExternalLoadBalancerResponse extends NetworkDeviceResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the external load balancer")
+ @Param(description = "The ID of the external Load balancer")
private String id;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "the zone ID of the external load balancer")
+ @Param(description = "The zone ID of the external Load balancer")
private String zoneId;
@SerializedName(ApiConstants.IP_ADDRESS)
- @Param(description = "the management IP address of the external load balancer")
+ @Param(description = "The management IP address of the external Load balancer")
private String ipAddress;
@SerializedName(ApiConstants.USERNAME)
- @Param(description = "the username that's used to log in to the external load balancer")
+ @Param(description = "The username that's used to log in to the external Load balancer")
private String username;
@SerializedName(ApiConstants.PUBLIC_INTERFACE)
- @Param(description = "the public interface of the external load balancer")
+ @Param(description = "The public interface of the external Load balancer")
private String publicInterface;
@SerializedName(ApiConstants.PRIVATE_INTERFACE)
- @Param(description = "the private interface of the external load balancer")
+ @Param(description = "The private interface of the external Load balancer")
private String privateInterface;
@SerializedName(ApiConstants.NUM_RETRIES)
- @Param(description = "the number of times to retry requests to the external load balancer")
+ @Param(description = "The number of times to retry requests to the external Load balancer")
private String numRetries;
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ExtractResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ExtractResponse.java
index 3d22dfe092c..fc5fd6c7a55 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ExtractResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ExtractResponse.java
@@ -27,27 +27,27 @@ import com.cloud.serializer.Param;
public class ExtractResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the id of extracted object")
+ @Param(description = "The ID of extracted object")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the extracted object")
+ @Param(description = "The name of the extracted object")
private String name;
@SerializedName("extractId")
- @Param(description = "the upload id of extracted object")
+ @Param(description = "The upload ID of extracted object")
private String uploadId;
@SerializedName("uploadpercentage")
- @Param(description = "the percentage of the entity uploaded to the specified location")
+ @Param(description = "The percentage of the entity uploaded to the specified location")
private Integer uploadPercent;
@SerializedName("status")
- @Param(description = "the status of the extraction")
+ @Param(description = "The status of the extraction")
private String status;
@SerializedName("accountid")
- @Param(description = "the account id to which the extracted object belongs")
+ @Param(description = "The Account ID to which the extracted object belongs")
private String accountId;
@SerializedName("resultstring")
@@ -55,31 +55,31 @@ public class ExtractResponse extends BaseResponse {
private String resultString;
@SerializedName(ApiConstants.CREATED)
- @Param(description = "the time and date the object was created")
+ @Param(description = "The time and date the object was created")
private Date createdDate;
@SerializedName(ApiConstants.STATE)
- @Param(description = "the state of the extracted object")
+ @Param(description = "The state of the extracted object")
private String state;
@SerializedName("storagetype")
- @Param(description = "type of the storage")
+ @Param(description = "Type of the storage")
private String storageType;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "zone ID the object was extracted from")
+ @Param(description = "Zone ID the object was extracted from")
private String zoneId;
@SerializedName(ApiConstants.ZONE_NAME)
- @Param(description = "zone name the object was extracted from")
+ @Param(description = "Zone name the object was extracted from")
private String zoneName;
@SerializedName("extractMode")
- @Param(description = "the mode of extraction - upload or download")
+ @Param(description = "The mode of extraction - upload or download")
private String mode;
@SerializedName(ApiConstants.URL)
- @Param(description = "if mode = upload then url of the uploaded entity. if mode = download the url from which the entity can be downloaded")
+ @Param(description = "If mode = upload then URL of the uploaded entity. if mode = download the URL from which the entity can be downloaded")
private String url;
public ExtractResponse() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/FirewallResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/FirewallResponse.java
index a9ecdd8e339..5986c16dc8c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/FirewallResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/FirewallResponse.java
@@ -28,63 +28,63 @@ import com.google.gson.annotations.SerializedName;
@SuppressWarnings("unused")
public class FirewallResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the firewall rule")
+ @Param(description = "The ID of the firewall rule")
private String id;
@SerializedName(ApiConstants.PROTOCOL)
- @Param(description = "the protocol of the firewall rule")
+ @Param(description = "The protocol of the firewall rule")
private String protocol;
@SerializedName(ApiConstants.START_PORT)
- @Param(description = "the starting port of firewall rule's port range")
+ @Param(description = "The starting port of firewall rule's port range")
private Integer startPort;
@SerializedName(ApiConstants.END_PORT)
- @Param(description = "the ending port of firewall rule's port range")
+ @Param(description = "The ending port of firewall rule's port range")
private Integer endPort;
@SerializedName(ApiConstants.IP_ADDRESS_ID)
- @Param(description = "the public ip address id for the firewall rule")
+ @Param(description = "The public IP address ID for the firewall rule")
private String publicIpAddressId;
@SerializedName(ApiConstants.NETWORK_ID)
- @Param(description = "the network id of the firewall rule")
+ @Param(description = "The Network ID of the firewall rule")
private String networkId;
@SerializedName(ApiConstants.IP_ADDRESS)
- @Param(description = "the public ip address for the firewall rule")
+ @Param(description = "The public IP address for the firewall rule")
private String publicIpAddress;
@SerializedName(ApiConstants.STATE)
- @Param(description = "the state of the rule")
+ @Param(description = "The state of the rule")
private String state;
@SerializedName(ApiConstants.CIDR_LIST)
- @Param(description = "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).")
+ @Param(description = "The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).")
private String cidrList;
@SerializedName(ApiConstants.ICMP_TYPE)
- @Param(description = "type of the icmp message being sent")
+ @Param(description = "Type of the ICMP message being sent")
private Integer icmpType;
@SerializedName(ApiConstants.ICMP_CODE)
- @Param(description = "error code for this icmp message")
+ @Param(description = "Error code for this ICMP message")
private Integer icmpCode;
@SerializedName(ApiConstants.TAGS)
- @Param(description = "the list of resource tags associated with the rule", responseObject = ResourceTagResponse.class)
+ @Param(description = "The list of resource tags associated with the rule", responseObject = ResourceTagResponse.class)
private List tags;
@SerializedName(ApiConstants.FOR_DISPLAY)
- @Param(description = "is rule for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
+ @Param(description = "Is rule for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
private Boolean forDisplay;
@SerializedName(ApiConstants.DEST_CIDR_LIST)
- @Param(description = "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).")
+ @Param(description = "The CIDR list to forward traffic to. Multiple entries are separated by a single comma character (,).")
private String destCidr;
@SerializedName(ApiConstants.TRAFFIC_TYPE)
- @Param(description = "the traffic type for the firewall rule", since = "4.17.0")
+ @Param(description = "The traffic type for the firewall rule", since = "4.17.0")
private String trafficType;
public void setId(String id) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/FirewallRuleResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/FirewallRuleResponse.java
index 1d3b665634f..48097e51d99 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/FirewallRuleResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/FirewallRuleResponse.java
@@ -31,71 +31,71 @@ import com.google.gson.annotations.SerializedName;
@SuppressWarnings("unused")
public class FirewallRuleResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the port forwarding rule")
+ @Param(description = "The ID of the port forwarding rule")
private String id;
@SerializedName(ApiConstants.PRIVATE_START_PORT)
- @Param(description = "the starting port of port forwarding rule's private port range")
+ @Param(description = "The starting port of port forwarding rule's private port range")
private String privateStartPort;
@SerializedName(ApiConstants.PRIVATE_END_PORT)
- @Param(description = "the ending port of port forwarding rule's private port range")
+ @Param(description = "The ending port of port forwarding rule's private port range")
private String privateEndPort;
@SerializedName(ApiConstants.PROTOCOL)
- @Param(description = "the protocol of the port forwarding rule")
+ @Param(description = "The protocol of the port forwarding rule")
private String protocol;
@SerializedName(ApiConstants.PUBLIC_START_PORT)
- @Param(description = "the starting port of port forwarding rule's public port range")
+ @Param(description = "The starting port of port forwarding rule's public port range")
private String publicStartPort;
@SerializedName(ApiConstants.PUBLIC_END_PORT)
- @Param(description = "the ending port of port forwarding rule's private port range")
+ @Param(description = "The ending port of port forwarding rule's private port range")
private String publicEndPort;
@SerializedName(ApiConstants.VIRTUAL_MACHINE_ID)
- @Param(description = "the VM ID for the port forwarding rule")
+ @Param(description = "The Instance ID for the port forwarding rule")
private String virtualMachineId;
@SerializedName("virtualmachinename")
- @Param(description = "the VM name for the port forwarding rule")
+ @Param(description = "The Instance name for the port forwarding rule")
private String virtualMachineName;
@SerializedName("virtualmachinedisplayname")
- @Param(description = "the VM display name for the port forwarding rule")
+ @Param(description = "The Instance display name for the port forwarding rule")
private String virtualMachineDisplayName;
@SerializedName(ApiConstants.IP_ADDRESS_ID)
- @Param(description = "the public ip address id for the port forwarding rule")
+ @Param(description = "The public IP address id for the port forwarding rule")
private String publicIpAddressId;
@SerializedName(ApiConstants.IP_ADDRESS)
- @Param(description = "the public ip address for the port forwarding rule")
+ @Param(description = "The public IP address for the port forwarding rule")
private String publicIpAddress;
@SerializedName(ApiConstants.STATE)
- @Param(description = "the state of the rule")
+ @Param(description = "The state of the rule")
private String state;
@SerializedName(ApiConstants.CIDR_LIST)
- @Param(description = "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).")
+ @Param(description = "The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).")
private String cidrList;
@SerializedName(ApiConstants.TAGS)
- @Param(description = "the list of resource tags associated with the rule", responseObject = ResourceTagResponse.class)
+ @Param(description = "The list of resource tags associated with the rule", responseObject = ResourceTagResponse.class)
private List tags;
@SerializedName(ApiConstants.VM_GUEST_IP)
- @Param(description = "the vm ip address for the port forwarding rule")
+ @Param(description = "The Instance IP address for the port forwarding rule")
private String destNatVmIp;
@SerializedName(ApiConstants.NETWORK_ID)
- @Param(description = "the id of the guest network the port forwarding rule belongs to")
+ @Param(description = "The ID of the guest Network the port forwarding rule belongs to")
private String networkId;
@SerializedName(ApiConstants.FOR_DISPLAY)
- @Param(description = "is firewall for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
+ @Param(description = "Is firewall for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
private Boolean forDisplay;
public String getDestNatVmIp() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/GetUploadParamsResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/GetUploadParamsResponse.java
index b9be06ecc8f..1cf76929964 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/GetUploadParamsResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/GetUploadParamsResponse.java
@@ -30,7 +30,7 @@ import com.google.gson.annotations.SerializedName;
public class GetUploadParamsResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the template/volume ID")
+ @Param(description = "The Template/volume ID")
private UUID id;
@SerializedName(ApiConstants.POST_URL)
@@ -38,15 +38,15 @@ public class GetUploadParamsResponse extends BaseResponse {
private URL postURL;
@SerializedName(ApiConstants.METADATA)
- @Param(description = "encrypted data to be sent in the POST request.")
+ @Param(description = "Encrypted data to be sent in the POST request.")
private String metadata;
@SerializedName(ApiConstants.EXPIRES)
- @Param(description = "the timestamp after which the signature expires")
+ @Param(description = "The timestamp after which the signature expires")
private String expires;
@SerializedName(ApiConstants.SIGNATURE)
- @Param(description = "signature to be sent in the POST request.")
+ @Param(description = "Signature to be sent in the POST request.")
private String signature;
public GetUploadParamsResponse(UUID id, URL postURL, String metadata, String expires, String signature) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/GetVMPasswordResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/GetVMPasswordResponse.java
index 49603212edc..9c9e4177495 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/GetVMPasswordResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/GetVMPasswordResponse.java
@@ -25,7 +25,7 @@ import com.cloud.serializer.Param;
public class GetVMPasswordResponse extends BaseResponse {
@SerializedName("encryptedpassword")
- @Param(description = "The base64 encoded encrypted password of the VM", isSensitive = true)
+ @Param(description = "The base64 encoded encrypted password of the Instance", isSensitive = true)
private String encryptedPassword;
public GetVMPasswordResponse() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/GlobalLoadBalancerResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/GlobalLoadBalancerResponse.java
index d41e4d2ab34..b16706bb872 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/GlobalLoadBalancerResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/GlobalLoadBalancerResponse.java
@@ -31,27 +31,27 @@ import com.cloud.serializer.Param;
public class GlobalLoadBalancerResponse extends BaseResponse implements ControlledEntityResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "global load balancer rule ID")
+ @Param(description = "Global Load balancer rule ID")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "name of the global load balancer rule")
+ @Param(description = "Name of the global Load balancer rule")
private String name;
@SerializedName(ApiConstants.DESCRIPTION)
- @Param(description = "the description of the global load balancer rule")
+ @Param(description = "The description of the global Load balancer rule")
private String description;
@SerializedName(ApiConstants.GSLB_SERVICE_DOMAIN_NAME)
- @Param(description = "DNS domain name given for the global load balancer")
+ @Param(description = "DNS domain name given for the global Load balancer")
private String gslbDomainName;
@SerializedName(ApiConstants.GSLB_LB_METHOD)
- @Param(description = "Load balancing method used for the global load balancer")
+ @Param(description = "Load balancing method used for the global Load balancer")
private String algorithm;
@SerializedName(ApiConstants.GSLB_STICKY_SESSION_METHOD)
- @Param(description = "session persistence method used for the global load balancer")
+ @Param(description = "Session persistence method used for the global Load balancer")
private String stickyMethod;
@SerializedName(ApiConstants.GSLB_SERVICE_TYPE)
@@ -59,27 +59,27 @@ public class GlobalLoadBalancerResponse extends BaseResponse implements Controll
private String serviceType;
@SerializedName(ApiConstants.REGION_ID)
- @Param(description = "Region Id in which global load balancer is created")
+ @Param(description = "Region ID in which global Load balancer is created")
private Integer regionId;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account of the load balancer rule")
+ @Param(description = "The Account of the Load balancer rule")
private String accountName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the load balancer")
+ @Param(description = "The project ID of the Load balancer")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the load balancer")
+ @Param(description = "The project name of the Load balancer")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain ID of the load balancer rule")
+ @Param(description = "The domain ID of the Load balancer rule")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain of the load balancer rule")
+ @Param(description = "The domain of the Load balancer rule")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
@@ -87,7 +87,7 @@ public class GlobalLoadBalancerResponse extends BaseResponse implements Controll
private String domainPath;
@SerializedName(ApiConstants.LOAD_BALANCER_RULE)
- @Param(description = "List of load balancer rules that are part of GSLB rule", responseObject = LoadBalancerResponse.class)
+ @Param(description = "List of Load balancer rules that are part of GSLB rule", responseObject = LoadBalancerResponse.class)
private List siteLoadBalancers;
public void setRegionIdId(Integer regionId) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/GpuResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/GpuResponse.java
index b655749126e..8738c622eaf 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/GpuResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/GpuResponse.java
@@ -32,7 +32,7 @@ public class GpuResponse extends BaseResponse {
private String gpuGroupName;
@SerializedName(ApiConstants.VGPU)
- @Param(description = "the list of enabled vGPUs", responseObject = VgpuResponse.class)
+ @Param(description = "The list of enabled vGPUs", responseObject = VgpuResponse.class)
private List vgpu;
public void setGpuGroupName(String gpuGroupName) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/GuestOSCategoryResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/GuestOSCategoryResponse.java
index 7872bf22085..c3ef28d2d5d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/GuestOSCategoryResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/GuestOSCategoryResponse.java
@@ -28,11 +28,11 @@ import com.cloud.storage.GuestOsCategory;
@EntityReference(value = GuestOsCategory.class)
public class GuestOSCategoryResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the OS category")
+ @Param(description = "The ID of the OS category")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the OS category")
+ @Param(description = "The name of the OS category")
private String name;
public String getId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/GuestOSResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/GuestOSResponse.java
index f870a2f0d94..6f8e7937d0b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/GuestOSResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/GuestOSResponse.java
@@ -28,19 +28,19 @@ import com.cloud.storage.GuestOS;
@EntityReference(value = GuestOS.class)
public class GuestOSResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the OS type")
+ @Param(description = "The ID of the OS type")
private String id;
@SerializedName(ApiConstants.OS_CATEGORY_ID)
- @Param(description = "the ID of the OS category")
+ @Param(description = "The ID of the OS category")
private String osCategoryId;
@SerializedName(ApiConstants.OS_CATEGORY_NAME)
- @Param(description = "the name of the OS category")
+ @Param(description = "The name of the OS category")
private String osCategoryName;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the OS type")
+ @Param(description = "The name of the OS type")
private String name;
/**
@@ -48,15 +48,15 @@ public class GuestOSResponse extends BaseResponse {
*/
@Deprecated(since = "4.19")
@SerializedName(ApiConstants.DESCRIPTION)
- @Param(description = "the name/description of the OS type")
+ @Param(description = "The name/description of the OS type")
private String description;
@SerializedName(ApiConstants.IS_USER_DEFINED)
- @Param(description = "is the guest OS user defined")
+ @Param(description = "Is the guest OS user defined")
private Boolean isUserDefined;
@SerializedName(ApiConstants.FOR_DISPLAY)
- @Param(description = "is the guest OS visible for the users")
+ @Param(description = "Is the guest OS visible for the users")
private Boolean forDisplay;
public String getId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/GuestOsMappingResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/GuestOsMappingResponse.java
index 583768d47be..3681f182e95 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/GuestOsMappingResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/GuestOsMappingResponse.java
@@ -29,31 +29,31 @@ import com.cloud.storage.GuestOSHypervisor;
@EntityReference(value = GuestOSHypervisor.class)
public class GuestOsMappingResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the Guest OS mapping")
+ @Param(description = "The ID of the Guest OS mapping")
private String id;
@SerializedName(ApiConstants.HYPERVISOR)
- @Param(description = "the hypervisor")
+ @Param(description = "The hypervisor")
private String hypervisor;
@SerializedName(ApiConstants.HYPERVISOR_VERSION)
- @Param(description = "version of the hypervisor for mapping")
+ @Param(description = "Version of the hypervisor for mapping")
private String hypervisorVersion;
@SerializedName(ApiConstants.OS_TYPE_ID)
- @Param(description = "the ID of the Guest OS type")
+ @Param(description = "The ID of the Guest OS type")
private String osTypeId;
@SerializedName(ApiConstants.OS_DISPLAY_NAME)
- @Param(description = "standard display name for the Guest OS")
+ @Param(description = "Standard display name for the Guest OS")
private String osStdName;
@SerializedName(ApiConstants.OS_NAME_FOR_HYPERVISOR)
- @Param(description = "hypervisor specific name for the Guest OS")
+ @Param(description = "Hypervisor specific name for the Guest OS")
private String osNameForHypervisor;
@SerializedName(ApiConstants.IS_USER_DEFINED)
- @Param(description = "is the mapping user defined")
+ @Param(description = "Is the mapping user defined")
private String isUserDefined;
public String getIsUserDefined() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/GuestVlanRangeResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/GuestVlanRangeResponse.java
index 133338d27ae..c67b3886698 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/GuestVlanRangeResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/GuestVlanRangeResponse.java
@@ -29,19 +29,19 @@ import com.cloud.serializer.Param;
@SuppressWarnings("unused")
public class GuestVlanRangeResponse extends BaseResponse implements ControlledEntityResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the guest VLAN range")
+ @Param(description = "The ID of the guest VLAN range")
private String id;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account of the guest VLAN range")
+ @Param(description = "The Account of the guest VLAN range")
private String accountName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain ID of the guest VLAN range")
+ @Param(description = "The domain ID of the guest VLAN range")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain name of the guest VLAN range")
+ @Param(description = "The domain name of the guest VLAN range")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
@@ -49,23 +49,23 @@ public class GuestVlanRangeResponse extends BaseResponse implements ControlledEn
private String domainPath;
@SerializedName(ApiConstants.GUEST_VLAN_RANGE)
- @Param(description = "the guest VLAN range")
+ @Param(description = "The guest VLAN range")
private String guestVlanRange;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the guest vlan range")
+ @Param(description = "The project id of the guest VLAN range")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the guest vlan range")
+ @Param(description = "The project name of the guest VLAN range")
private String projectName;
@SerializedName(ApiConstants.PHYSICAL_NETWORK_ID)
- @Param(description = "the physical network of the guest vlan range")
+ @Param(description = "The physical Network of the guest VLAN range")
private Long physicalNetworkId;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "the zone of the guest vlan range")
+ @Param(description = "The zone of the guest VLAN range")
private Long zoneId;
public void setId(String id) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/GuestVlanResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/GuestVlanResponse.java
index 6716911ab82..28d33e9fe65 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/GuestVlanResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/GuestVlanResponse.java
@@ -30,23 +30,23 @@ import java.util.List;
public class GuestVlanResponse extends BaseResponse implements ControlledEntityResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the guest VLAN id")
+ @Param(description = "The guest VLAN ID")
private long id;
@SerializedName(ApiConstants.VLAN)
- @Param(description = "the guest VLAN")
+ @Param(description = "The guest VLAN")
private String guestVlan;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account of the guest VLAN range")
+ @Param(description = "The Account of the guest VLAN range")
private String accountName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain ID of the guest VLAN range")
+ @Param(description = "The domain ID of the guest VLAN range")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain name of the guest VLAN range")
+ @Param(description = "The domain name of the guest VLAN range")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
@@ -54,43 +54,43 @@ public class GuestVlanResponse extends BaseResponse implements ControlledEntityR
private String domainPath;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the guest VLAN range")
+ @Param(description = "The project ID of the guest VLAN range")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the guest VLAN range")
+ @Param(description = "The project name of the guest VLAN range")
private String projectName;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "the zone ID of the guest VLAN range")
+ @Param(description = "The zone ID of the guest VLAN range")
private String zoneId;
@SerializedName(ApiConstants.ZONE_NAME)
- @Param(description = "the zone name of the guest VLAN range")
+ @Param(description = "The zone name of the guest VLAN range")
private String zoneName;
@SerializedName(ApiConstants.PHYSICAL_NETWORK_ID)
- @Param(description = "the physical network ID of the guest VLAN range")
+ @Param(description = "The physical Network ID of the guest VLAN range")
private String physicalNetworkId;
@SerializedName(ApiConstants.PHYSICAL_NETWORK_NAME)
- @Param(description = "the physical network name of the guest VLAN range")
+ @Param(description = "The physical Network name of the guest VLAN range")
private String physicalNetworkName;
@SerializedName(ApiConstants.IS_DEDICATED)
- @Param(description = "true if the guest VLAN is dedicated to the account")
+ @Param(description = "True if the guest VLAN is dedicated to the Account")
private Boolean isDedicated;
@SerializedName(ApiConstants.ALLOCATION_STATE)
- @Param(description = "the allocation state of the guest VLAN")
+ @Param(description = "The allocation state of the guest VLAN")
private String allocationState;
@SerializedName(ApiConstants.TAKEN)
- @Param(description = "date the guest VLAN was taken")
+ @Param(description = "Date the guest VLAN was taken")
private Date taken;
@SerializedName(ApiConstants.NETWORK)
- @Param(description = "the list of networks who use this guest VLAN", responseObject = NetworkResponse.class)
+ @Param(description = "The list of Networks who use this guest VLAN", responseObject = NetworkResponse.class)
private List networks;
public void setId(long id) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/HAProviderResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/HAProviderResponse.java
index d75cbc3e120..c1c76178008 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/HAProviderResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/HAProviderResponse.java
@@ -29,11 +29,11 @@ import java.util.List;
@EntityReference(value = HAConfig.class)
public final class HAProviderResponse extends BaseResponse {
@SerializedName(ApiConstants.HA_PROVIDER)
- @Param(description = "the HA provider")
+ @Param(description = "The HA provider")
private String provider;
@SerializedName(ApiConstants.TYPE)
- @Param(description = "the HA provider resource type detail")
+ @Param(description = "The HA provider resource type detail")
private List supportedResourceTypes;
public HAProviderResponse() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/HostForMigrationResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/HostForMigrationResponse.java
index b4de48baec4..b3853d9cc24 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/HostForMigrationResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/HostForMigrationResponse.java
@@ -26,7 +26,7 @@ import com.google.gson.annotations.SerializedName;
public class HostForMigrationResponse extends HostResponse {
@SerializedName("requiresStorageMotion")
- @Param(description = "true if migrating a vm to this host requires storage motion, false otherwise")
+ @Param(description = "True if migrating an Instance to this host requires storage motion, false otherwise")
private Boolean requiresStorageMotion;
public void setRequiresStorageMotion(Boolean requiresStorageMotion) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/HostHAResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/HostHAResponse.java
index a8b44bd5649..de2281dba31 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/HostHAResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/HostHAResponse.java
@@ -27,23 +27,23 @@ import org.apache.cloudstack.ha.HAConfig;
@EntityReference(value = HAConfig.class)
public final class HostHAResponse extends BaseResponse {
@SerializedName(ApiConstants.HOST_ID)
- @Param(description = "the ID of the host")
+ @Param(description = "The ID of the host")
private String id;
@SerializedName(ApiConstants.HA_ENABLE)
- @Param(description = "if host HA is enabled for the host")
+ @Param(description = "If host HA is enabled for the host")
private Boolean enabled;
@SerializedName(ApiConstants.HA_STATE)
- @Param(description = "the HA state of the host")
+ @Param(description = "The HA state of the host")
private HAConfig.HAState haState;
@SerializedName(ApiConstants.HA_PROVIDER)
- @Param(description = "the host HA provider")
+ @Param(description = "The host HA provider")
private String provider;
@SerializedName(ApiConstants.STATUS)
- @Param(description = "operation status")
+ @Param(description = "Operation status")
private Boolean status;
public HostHAResponse() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/HostResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/HostResponse.java
index 62bcc07b16d..668c7b8c699 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/HostResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/HostResponse.java
@@ -36,134 +36,134 @@ import com.google.gson.annotations.SerializedName;
@EntityReference(value = Host.class)
public class HostResponse extends BaseResponseWithAnnotations {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the host")
+ @Param(description = "The ID of the host")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the host")
+ @Param(description = "The name of the host")
private String name;
@SerializedName(ApiConstants.STATE)
- @Param(description = "the state of the host")
+ @Param(description = "The state of the host")
private Status state;
@SerializedName("disconnected")
- @Param(description = "true if the host is disconnected. False otherwise.")
+ @Param(description = "True if the host is disconnected. False otherwise.")
private Date disconnectedOn;
@SerializedName(ApiConstants.TYPE)
- @Param(description = "the host type")
+ @Param(description = "The host type")
private Host.Type hostType;
@SerializedName("oscategoryid")
- @Param(description = "the OS category ID of the host")
+ @Param(description = "The OS category ID of the host")
private String osCategoryId;
@SerializedName("oscategoryname")
- @Param(description = "the OS category name of the host")
+ @Param(description = "The OS category name of the host")
private String osCategoryName;
@SerializedName(ApiConstants.IP_ADDRESS)
- @Param(description = "the IP address of the host")
+ @Param(description = "The IP address of the host")
private String ipAddress;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "the Zone ID of the host")
+ @Param(description = "The Zone ID of the host")
private String zoneId;
@SerializedName(ApiConstants.ZONE_NAME)
- @Param(description = "the Zone name of the host")
+ @Param(description = "The Zone name of the host")
private String zoneName;
@SerializedName(ApiConstants.POD_ID)
- @Param(description = "the Pod ID of the host")
+ @Param(description = "The Pod ID of the host")
private String podId;
@SerializedName("podname")
- @Param(description = "the Pod name of the host")
+ @Param(description = "The Pod name of the host")
private String podName;
@SerializedName("version")
- @Param(description = "the host version")
+ @Param(description = "The host version")
private String version;
@SerializedName(ApiConstants.HYPERVISOR)
- @Param(description = "the host hypervisor")
+ @Param(description = "The host hypervisor")
private String hypervisor;
@SerializedName("cpusockets")
- @Param(description = "the number of CPU sockets on the host")
+ @Param(description = "The number of CPU sockets on the host")
private Integer cpuSockets;
@SerializedName("cpunumber")
- @Param(description = "the CPU number of the host")
+ @Param(description = "The CPU number of the host")
private Integer cpuNumber;
@SerializedName("cpuspeed")
- @Param(description = "the CPU speed of the host")
+ @Param(description = "The CPU speed of the host")
private Long cpuSpeed;
@Deprecated
@SerializedName("cpuallocated")
- @Param(description = "the amount of the host's CPU currently allocated")
+ @Param(description = "The amount of the host's CPU currently allocated")
private String cpuAllocated;
@SerializedName("cpuallocatedvalue")
- @Param(description = "the amount of the host's CPU currently allocated in MHz")
+ @Param(description = "The amount of the host's CPU currently allocated in MHz")
private Long cpuAllocatedValue;
@SerializedName("cpuallocatedpercentage")
- @Param(description = "the amount of the host's CPU currently allocated in percentage")
+ @Param(description = "The amount of the host's CPU currently allocated in percentage")
private String cpuAllocatedPercentage;
@SerializedName("cpuallocatedwithoverprovisioning")
- @Param(description = "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor")
+ @Param(description = "The amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor")
private String cpuAllocatedWithOverprovisioning;
@SerializedName("cpuused")
- @Param(description = "the amount of the host's CPU currently used")
+ @Param(description = "The amount of the host's CPU currently used")
private String cpuUsed;
@SerializedName("cpuwithoverprovisioning")
- @Param(description = "the amount of the host's CPU after applying the cpu.overprovisioning.factor")
+ @Param(description = "The amount of the host's CPU after applying the cpu.overprovisioning.factor")
private String cpuWithOverprovisioning;
@SerializedName(ApiConstants.CPU_LOAD_AVERAGE)
- @Param(description = "the cpu average load on the host")
+ @Param(description = "The average CPU load on the host")
private Double cpuloadaverage;
@SerializedName("networkkbsread")
- @Param(description = "the incoming network traffic on the host")
+ @Param(description = "The incoming Network traffic on the host")
private Long networkKbsRead;
@SerializedName("networkkbswrite")
- @Param(description = "the outgoing network traffic on the host")
+ @Param(description = "The outgoing Network traffic on the host")
private Long networkKbsWrite;
@Deprecated
@SerializedName("memorytotal")
- @Param(description = "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning")
+ @Param(description = "The memory total of the host, this parameter is deprecated use memorywithoverprovisioning")
private Long memoryTotal;
@SerializedName("memorywithoverprovisioning")
- @Param(description = "the amount of the host's memory after applying the mem.overprovisioning.factor")
+ @Param(description = "The amount of the host's memory after applying the mem.overprovisioning.factor")
private String memWithOverprovisioning;
@Deprecated
@SerializedName("memoryallocated")
- @Param(description = "the amount of the host's memory currently allocated")
+ @Param(description = "The amount of the host's memory currently allocated")
private long memoryAllocated;
@SerializedName("memoryallocatedpercentage")
- @Param(description = "the amount of the host's memory currently allocated in percentage")
+ @Param(description = "The amount of the host's memory currently allocated in percentage")
private String memoryAllocatedPercentage;
@SerializedName("memoryallocatedbytes")
- @Param(description = "the amount of the host's memory currently allocated in bytes")
+ @Param(description = "The amount of the host's memory currently allocated in bytes")
private Long memoryAllocatedBytes;
@SerializedName("memoryused")
- @Param(description = "the amount of the host's memory currently used")
+ @Param(description = "The amount of the host's memory currently used")
private Long memoryUsed;
@SerializedName(ApiConstants.GPUGROUP)
@@ -171,55 +171,55 @@ public class HostResponse extends BaseResponseWithAnnotations {
private List gpuGroup;
@SerializedName("disksizetotal")
- @Param(description = "the total disk size of the host")
+ @Param(description = "The total disk size of the host")
private Long diskSizeTotal;
@SerializedName("disksizeallocated")
- @Param(description = "the host's currently allocated disk size")
+ @Param(description = "The host's currently allocated disk size")
private Long diskSizeAllocated;
@SerializedName("capabilities")
- @Param(description = "capabilities of the host")
+ @Param(description = "Capabilities of the host")
private String capabilities;
@SerializedName("lastpinged")
- @Param(description = "the date and time the host was last pinged")
+ @Param(description = "The date and time the host was last pinged")
private Date lastPinged;
@SerializedName("managementserverid")
- @Param(description = "the management server ID of the host")
+ @Param(description = "The management server ID of the host")
private String managementServerId;
@SerializedName("clusterid")
- @Param(description = "the cluster ID of the host")
+ @Param(description = "The cluster ID of the host")
private String clusterId;
@SerializedName("clustername")
- @Param(description = "the cluster name of the host")
+ @Param(description = "The cluster name of the host")
private String clusterName;
@SerializedName("clustertype")
- @Param(description = "the cluster type of the cluster that host belongs to")
+ @Param(description = "The cluster type of the cluster that host belongs to")
private String clusterType;
@SerializedName("islocalstorageactive")
- @Param(description = "true if local storage is active, false otherwise")
+ @Param(description = "True if local storage is active, false otherwise")
private Boolean localStorageActive;
@SerializedName(ApiConstants.CREATED)
- @Param(description = "the date and time the host was created")
+ @Param(description = "The date and time the host was created")
private Date created;
@SerializedName("removed")
- @Param(description = "the date and time the host was removed")
+ @Param(description = "The date and time the host was removed")
private Date removed;
@SerializedName("events")
- @Param(description = "events available for the host")
+ @Param(description = "Events available for the host")
private String events;
@SerializedName("hosttags")
- @Param(description = "comma-separated list of tags for the host")
+ @Param(description = "Comma-separated list of tags for the host")
private String hostTags;
@SerializedName("explicithosttags")
@@ -235,31 +235,31 @@ public class HostResponse extends BaseResponseWithAnnotations {
private Boolean isTagARule;
@SerializedName("hasenoughcapacity")
- @Param(description = "true if this host has enough CPU and RAM capacity to migrate a VM to it, false otherwise")
+ @Param(description = "True if this host has enough CPU and RAM capacity to migrate an Instance to it, false otherwise")
private Boolean hasEnoughCapacity;
@SerializedName("suitableformigration")
- @Param(description = "true if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests vm limit etc) to migrate a VM to it , false otherwise")
+ @Param(description = "True if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests Instance limit etc) to migrate an Instance to it , false otherwise")
private Boolean suitableForMigration;
@SerializedName("hostha")
- @Param(description = "the host HA information information")
+ @Param(description = "The host HA information information")
private HostHAResponse hostHAResponse;
@SerializedName("outofbandmanagement")
- @Param(description = "the host out-of-band management information")
+ @Param(description = "The host out-of-band management information")
private OutOfBandManagementResponse outOfBandManagementResponse;
@SerializedName("resourcestate")
- @Param(description = "the resource state of the host")
+ @Param(description = "The resource state of the host")
private String resourceState;
@SerializedName(ApiConstants.HYPERVISOR_VERSION)
- @Param(description = "the hypervisor version")
+ @Param(description = "The hypervisor version")
private String hypervisorVersion;
@SerializedName(ApiConstants.HA_HOST)
- @Param(description = "true if the host is Ha host (dedicated to vms started by HA process; false otherwise")
+ @Param(description = "True if the host is Ha host (dedicated to Instances started by HA process; false otherwise")
private Boolean haHost;
@SerializedName(ApiConstants.DETAILS)
@@ -267,23 +267,23 @@ public class HostResponse extends BaseResponseWithAnnotations {
private Map details;
@SerializedName(ApiConstants.ANNOTATION)
- @Param(description = "the last annotation set on this host by an admin", since = "4.11")
+ @Param(description = "The last annotation set on this host by an admin", since = "4.11")
private String annotation;
@SerializedName(ApiConstants.LAST_ANNOTATED)
- @Param(description = "the last time this host was annotated", since = "4.11")
+ @Param(description = "The last time this host was annotated", since = "4.11")
private Date lastAnnotated;
@SerializedName(ApiConstants.USERNAME)
- @Param(description = "the admin that annotated this host", since = "4.11")
+ @Param(description = "The admin that annotated this host", since = "4.11")
private String username;
@SerializedName("ueficapability")
- @Param(description = "true if the host has capability to support UEFI boot")
+ @Param(description = "True if the host has capability to support UEFI boot")
private Boolean uefiCapability;
@SerializedName(ApiConstants.ENCRYPTION_SUPPORTED)
- @Param(description = "true if the host supports encryption", since = "4.18")
+ @Param(description = "True if the host supports encryption", since = "4.18")
private Boolean encryptionSupported;
@SerializedName(ApiConstants.INSTANCE_CONVERSION_SUPPORTED)
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/HostTagResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/HostTagResponse.java
index f772da6dcb6..fac30cae8c0 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/HostTagResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/HostTagResponse.java
@@ -24,15 +24,15 @@ import org.apache.cloudstack.api.BaseResponse;
public class HostTagResponse extends BaseResponse {
@SerializedName("id")
- @Param(description = "the ID of the host tag")
+ @Param(description = "The ID of the host tag")
private String id;
@SerializedName("hostid")
- @Param(description = "the host ID of the host tag")
+ @Param(description = "The host ID of the host tag")
private long hostId;
@SerializedName("name")
- @Param(description = "the name of the host tag")
+ @Param(description = "The name of the host tag")
private String name;
@SerializedName(ApiConstants.IS_IMPLICIT)
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/HypervisorCapabilitiesResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/HypervisorCapabilitiesResponse.java
index c19397e0c83..a835b237627 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/HypervisorCapabilitiesResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/HypervisorCapabilitiesResponse.java
@@ -27,39 +27,39 @@ import com.google.gson.annotations.SerializedName;
@EntityReference(value = HypervisorCapabilities.class)
public class HypervisorCapabilitiesResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the hypervisor capabilities row")
+ @Param(description = "The hypervisor capability ID")
private String id;
@SerializedName(ApiConstants.HYPERVISOR_VERSION)
- @Param(description = "the hypervisor version")
+ @Param(description = "The hypervisor version")
private String hypervisorVersion;
@SerializedName(ApiConstants.HYPERVISOR)
- @Param(description = "the hypervisor type")
+ @Param(description = "The hypervisor type")
private String hypervisor;
@SerializedName(ApiConstants.MAX_GUESTS_LIMIT)
- @Param(description = "the maximum number of guest vms recommended for this hypervisor")
+ @Param(description = "The maximum number of guest Instances recommended for this hypervisor")
private Long maxGuestsLimit;
@SerializedName(ApiConstants.SECURITY_GROUP_EANBLED)
- @Param(description = "true if security group is supported")
+ @Param(description = "True if security group is supported")
private boolean isSecurityGroupEnabled;
@SerializedName(ApiConstants.MAX_DATA_VOLUMES_LIMIT)
- @Param(description = "the maximum number of Data Volumes that can be attached for this hypervisor")
+ @Param(description = "The maximum number of Data Volumes that can be attached for this hypervisor")
private Integer maxDataVolumesLimit;
@SerializedName(ApiConstants.MAX_HOSTS_PER_CLUSTER)
- @Param(description = "the maximum number of Hosts per cluster for this hypervisor")
+ @Param(description = "The maximum number of Hosts per cluster for this hypervisor")
private Integer maxHostsPerCluster;
@SerializedName(ApiConstants.STORAGE_MOTION_ENABLED)
- @Param(description = "true if storage motion is supported")
+ @Param(description = "True if storage motion is supported")
private boolean isStorageMotionSupported;
@SerializedName(ApiConstants.VM_SNAPSHOT_ENABELD)
- @Param(description = "true if VM snapshots are enabled for this hypervisor")
+ @Param(description = "True if Instance Snapshots are enabled for this hypervisor")
private boolean isVmSnapshotEnabled;
public HypervisorCapabilitiesResponse(){
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/HypervisorGuestOsNamesResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/HypervisorGuestOsNamesResponse.java
index 52f55bf4569..e6441690083 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/HypervisorGuestOsNamesResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/HypervisorGuestOsNamesResponse.java
@@ -27,19 +27,19 @@ import com.google.gson.annotations.SerializedName;
public class HypervisorGuestOsNamesResponse extends BaseResponse {
@SerializedName(ApiConstants.HYPERVISOR)
- @Param(description = "the hypervisor")
+ @Param(description = "The hypervisor")
private String hypervisor;
@SerializedName(ApiConstants.HYPERVISOR_VERSION)
- @Param(description = "version of the hypervisor for guest os names")
+ @Param(description = "Version of the hypervisor for guest os names")
private String hypervisorVersion;
@SerializedName(ApiConstants.GUEST_OS_LIST)
- @Param(description = "the guest OS list of the hypervisor", responseObject = HypervisorGuestOsResponse.class)
+ @Param(description = "The guest OS list of the hypervisor", responseObject = HypervisorGuestOsResponse.class)
private List guestOSList;
@SerializedName(ApiConstants.GUEST_OS_COUNT)
- @Param(description = "the guest OS count of the hypervisor")
+ @Param(description = "The guest OS count of the hypervisor")
private Integer guestOSCount;
public String getHypervisor() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/HypervisorGuestOsResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/HypervisorGuestOsResponse.java
index e9ef630e17f..53da01a9854 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/HypervisorGuestOsResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/HypervisorGuestOsResponse.java
@@ -26,11 +26,11 @@ import com.cloud.serializer.Param;
public class HypervisorGuestOsResponse extends BaseResponse {
@SerializedName(ApiConstants.OS_DISPLAY_NAME)
- @Param(description = "standard display name for the Guest OS")
+ @Param(description = "Standard display name for the Guest OS")
private String osStdName;
@SerializedName(ApiConstants.OS_NAME_FOR_HYPERVISOR)
- @Param(description = "hypervisor specific name for the Guest OS")
+ @Param(description = "Hypervisor specific name for the Guest OS")
private String osNameForHypervisor;
public String getOsStdName() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/IPAddressResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/IPAddressResponse.java
index 0018edc8638..0f6d9038fac 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/IPAddressResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/IPAddressResponse.java
@@ -32,47 +32,47 @@ import com.google.gson.annotations.SerializedName;
@SuppressWarnings("unused")
public class IPAddressResponse extends BaseResponseWithAnnotations implements ControlledEntityResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "public IP address id")
+ @Param(description = "Public IP address ID")
private String id;
@SerializedName(ApiConstants.IP_ADDRESS)
- @Param(description = "public IP address")
+ @Param(description = "Public IP address")
private String ipAddress;
@SerializedName("allocated")
- @Param(description = "date the public IP address was acquired")
+ @Param(description = "Date the public IP address was acquired")
private Date allocated;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "the ID of the zone the public IP address belongs to")
+ @Param(description = "The ID of the zone the public IP address belongs to")
private String zoneId;
@SerializedName(ApiConstants.ZONE_NAME)
- @Param(description = "the name of the zone the public IP address belongs to")
+ @Param(description = "The name of the zone the public IP address belongs to")
private String zoneName;
@SerializedName("issourcenat")
- @Param(description = "true if the IP address is a source nat address, false otherwise")
+ @Param(description = "True if the IP address is a source NAT address, false otherwise")
private Boolean sourceNat;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account the public IP address is associated with")
+ @Param(description = "The Account the public IP address is associated with")
private String accountName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the ipaddress")
+ @Param(description = "The project id of the IP address")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the address")
+ @Param(description = "The project name of the address")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain ID the public IP address is associated with")
+ @Param(description = "The domain ID the public IP address is associated with")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain the public IP address is associated with")
+ @Param(description = "The domain the public IP address is associated with")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
@@ -80,95 +80,95 @@ public class IPAddressResponse extends BaseResponseWithAnnotations implements Co
private String domainPath;
@SerializedName(ApiConstants.FOR_VIRTUAL_NETWORK)
- @Param(description = "the virtual network for the IP address")
+ @Param(description = "The virtual Network for the IP address")
private Boolean forVirtualNetwork;
@SerializedName(ApiConstants.VLAN_ID)
- @Param(description = "the ID of the VLAN associated with the IP address." + " This parameter is visible to ROOT admins only")
+ @Param(description = "The ID of the VLAN associated with the IP address." + " This parameter is visible to ROOT admins only")
private String vlanId;
@SerializedName("vlanname")
- @Param(description = "the VLAN associated with the IP address")
+ @Param(description = "The VLAN associated with the IP address")
private String vlanName;
@SerializedName("isstaticnat")
- @Param(description = "true if this ip is for static nat, false otherwise")
+ @Param(description = "True if this IP is for static NAT, false otherwise")
private Boolean staticNat;
@SerializedName(ApiConstants.IS_SYSTEM)
- @Param(description = "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)")
+ @Param(description = "True if this IP is system IP (was allocated as a part of deployVm or createLbRule)")
private Boolean isSystem;
@SerializedName(ApiConstants.VIRTUAL_MACHINE_ID)
- @Param(description = "virtual machine id the ip address is assigned to")
+ @Param(description = "Instance id the IP address is assigned to")
private String virtualMachineId;
@SerializedName(ApiConstants.VIRTUAL_MACHINE_TYPE)
- @Param(description = "virtual machine type the ip address is assigned to", since = "4.19.0")
+ @Param(description = "Instance type the IP address is assigned to", since = "4.19.0")
private String virtualMachineType;
@SerializedName("vmipaddress")
- @Param(description = "virtual machine (dnat) ip address (not null only for static nat Ip)")
+ @Param(description = "Instance (DNAT) IP address (not null only for static NAT IP)")
private String virtualMachineIp;
@SerializedName("virtualmachinename")
- @Param(description = "virtual machine name the ip address is assigned to")
+ @Param(description = "Instance name the IP address is assigned to")
private String virtualMachineName;
@SerializedName("virtualmachinedisplayname")
- @Param(description = "virtual machine display name the ip address is assigned to (not null only for static nat Ip)")
+ @Param(description = "Instance display name the IP address is assigned to (not null only for static NAT IP)")
private String virtualMachineDisplayName;
@SerializedName(ApiConstants.ASSOCIATED_NETWORK_ID)
- @Param(description = "the ID of the Network associated with the IP address")
+ @Param(description = "The ID of the Network associated with the IP address")
private String associatedNetworkId;
@SerializedName(ApiConstants.ASSOCIATED_NETWORK_NAME)
- @Param(description = "the name of the Network associated with the IP address")
+ @Param(description = "The name of the Network associated with the IP address")
private String associatedNetworkName;
@SerializedName(ApiConstants.NETWORK_ID)
- @Param(description = "the ID of the Network where ip belongs to")
+ @Param(description = "The ID of the Network where IP belongs to")
private String networkId;
@SerializedName(ApiConstants.STATE)
- @Param(description = "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free")
+ @Param(description = "State of the IP address. Can be: Allocating, Allocated, Releasing, Reserved and Free")
private String state;
@SerializedName(ApiConstants.PHYSICAL_NETWORK_ID)
- @Param(description = "the physical network this belongs to")
+ @Param(description = "The physical Network this belongs to")
private String physicalNetworkId;
@SerializedName(ApiConstants.PURPOSE)
- @Param(description = "purpose of the IP address. In Acton this value is not null for Ips with isSystem=true, and can have either StaticNat or LB value")
+ @Param(description = "Purpose of the IP address. In Acton this value is not null for IPs with isSystem=true, and can have either StaticNat or LB value")
private String purpose;
@SerializedName(ApiConstants.VPC_ID)
- @Param(description = "VPC id the ip belongs to")
+ @Param(description = "VPC ID the IP belongs to")
private String vpcId;
@SerializedName(ApiConstants.VPC_NAME)
- @Param(description = "VPC name the ip belongs to", since = "4.13.2")
+ @Param(description = "VPC name the IP belongs to", since = "4.13.2")
private String vpcName;
@SerializedName(ApiConstants.TAGS)
- @Param(description = "the list of resource tags associated with ip address", responseObject = ResourceTagResponse.class)
+ @Param(description = "The list of resource tags associated with IP address", responseObject = ResourceTagResponse.class)
private List tags;
@SerializedName(ApiConstants.IS_PORTABLE)
- @Param(description = "is public IP portable across the zones")
+ @Param(description = "Is public IP portable across the zones")
private Boolean isPortable;
@SerializedName(ApiConstants.FOR_DISPLAY)
- @Param(description = "is public ip for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
+ @Param(description = "Is public IP for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
private Boolean forDisplay;
@SerializedName(ApiConstants.NETWORK_NAME)
- @Param(description="the name of the Network where ip belongs to")
+ @Param(description = "The name of the Network where IP belongs to")
private String networkName;
@SerializedName(ApiConstants.HAS_RULES)
- @Param(description="whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined")
+ @Param(description = "Whether the IP address has Firewall/PortForwarding/LoadBalancing rules defined")
private boolean hasRules;
@SerializedName(ApiConstants.FOR_SYSTEM_VMS)
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ImageStoreDetailResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ImageStoreDetailResponse.java
index 8863b632681..0afef6166f8 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ImageStoreDetailResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ImageStoreDetailResponse.java
@@ -24,11 +24,11 @@ import com.cloud.serializer.Param;
public class ImageStoreDetailResponse extends BaseResponse {
@SerializedName("name")
- @Param(description = "detail property name of the image store")
+ @Param(description = "Detail property name of the image store")
private String name;
@SerializedName("value")
- @Param(description = "detail property value of the image store")
+ @Param(description = "Detail property value of the image store")
private String value;
public ImageStoreDetailResponse() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ImageStoreResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ImageStoreResponse.java
index ee44b6bc474..79f7eb295ea 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ImageStoreResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ImageStoreResponse.java
@@ -28,47 +28,47 @@ import com.google.gson.annotations.SerializedName;
@EntityReference(value = ImageStore.class)
public class ImageStoreResponse extends BaseResponseWithAnnotations {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the image store")
+ @Param(description = "The ID of the image store")
private String id;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "the Zone ID of the image store")
+ @Param(description = "The Zone ID of the image store")
private String zoneId;
@SerializedName(ApiConstants.ZONE_NAME)
- @Param(description = "the Zone name of the image store")
+ @Param(description = "The Zone name of the image store")
private String zoneName;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the image store")
+ @Param(description = "The name of the image store")
private String name;
@SerializedName(ApiConstants.URL)
- @Param(description = "the url of the image store")
+ @Param(description = "The URL of the image store")
private String url;
@SerializedName(ApiConstants.PROTOCOL)
- @Param(description = "the protocol of the image store")
+ @Param(description = "The protocol of the image store")
private String protocol;
@SerializedName("providername")
- @Param(description = "the provider name of the image store")
+ @Param(description = "The provider name of the image store")
private String providerName;
@SerializedName(ApiConstants.SCOPE)
- @Param(description = "the scope of the image store")
+ @Param(description = "The scope of the image store")
private ScopeType scope;
@SerializedName(ApiConstants.READ_ONLY)
- @Param(description = "defines if store is read-only")
+ @Param(description = "Defines if store is read-only")
private Boolean readonly;
@SerializedName("disksizetotal")
- @Param(description = "the total disk size of the host")
+ @Param(description = "The total disk size of the host")
private Long diskSizeTotal;
@SerializedName("disksizeused")
- @Param(description = "the host's currently used disk size")
+ @Param(description = "The host's currently used disk size")
private Long diskSizeUsed;
public ImageStoreResponse() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/InstanceGroupResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/InstanceGroupResponse.java
index 9c7a4fc09a1..f15ccf61196 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/InstanceGroupResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/InstanceGroupResponse.java
@@ -32,35 +32,35 @@ import com.cloud.vm.InstanceGroup;
public class InstanceGroupResponse extends BaseResponseWithAnnotations implements ControlledViewEntityResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the instance group")
+ @Param(description = "The ID of the Instance group")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the instance group")
+ @Param(description = "The name of the Instance group")
private String name;
@SerializedName(ApiConstants.CREATED)
- @Param(description = "time and date the instance group was created")
+ @Param(description = "Time and date the Instance group was created")
private Date created;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account owning the instance group")
+ @Param(description = "The Account owning the Instance group")
private String accountName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project ID of the instance group")
+ @Param(description = "The project ID of the Instance group")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the instance group")
+ @Param(description = "The project name of the Instance group")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain ID of the instance group")
+ @Param(description = "The domain ID of the Instance group")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain name of the instance group")
+ @Param(description = "The domain name of the Instance group")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/InternalLoadBalancerElementResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/InternalLoadBalancerElementResponse.java
index 15b17d88851..59726e1c3fb 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/InternalLoadBalancerElementResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/InternalLoadBalancerElementResponse.java
@@ -29,11 +29,11 @@ import com.cloud.serializer.Param;
@SuppressWarnings("unused")
public class InternalLoadBalancerElementResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the id of the internal load balancer element")
+ @Param(description = "The ID of the internal Load balancer element")
private String id;
@SerializedName(ApiConstants.NSP_ID)
- @Param(description = "the physical network service provider id of the element")
+ @Param(description = "The physical Network service provider ID of the element")
private String nspId;
@SerializedName(ApiConstants.ENABLED)
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/IpForwardingRuleResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/IpForwardingRuleResponse.java
index e9856c7af1a..ba3a0ae3edb 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/IpForwardingRuleResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/IpForwardingRuleResponse.java
@@ -25,43 +25,43 @@ import com.cloud.serializer.Param;
public class IpForwardingRuleResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the port forwarding rule")
+ @Param(description = "The ID of the port forwarding rule")
private String id;
@SerializedName(ApiConstants.PROTOCOL)
- @Param(description = "the protocol of the port forwarding rule")
+ @Param(description = "The protocol of the port forwarding rule")
private String protocol;
@SerializedName(ApiConstants.VIRTUAL_MACHINE_ID)
- @Param(description = "the VM ID for the port forwarding rule")
+ @Param(description = "The Instance ID for the port forwarding rule")
private String virtualMachineId;
@SerializedName("virtualmachinename")
- @Param(description = "the VM name for the port forwarding rule")
+ @Param(description = "The Instance name for the port forwarding rule")
private String virtualMachineName;
@SerializedName("virtualmachinedisplayname")
- @Param(description = "the VM display name for the port forwarding rule")
+ @Param(description = "The Instance display name for the port forwarding rule")
private String virtualMachineDisplayName;
@SerializedName(ApiConstants.IP_ADDRESS_ID)
- @Param(description = "the public ip address id for the port forwarding rule")
+ @Param(description = "The public IP address id for the port forwarding rule")
private Long publicIpAddressId;
@SerializedName(ApiConstants.IP_ADDRESS)
- @Param(description = "the public ip address for the port forwarding rule")
+ @Param(description = "The public IP address for the port forwarding rule")
private String publicIpAddress;
@SerializedName(ApiConstants.START_PORT)
- @Param(description = "the start port of the rule")
+ @Param(description = "The start port of the rule")
private Integer startPort;
@SerializedName(ApiConstants.END_PORT)
- @Param(description = "the end port of the rule")
+ @Param(description = "The end port of the rule")
private Integer endPort;
@SerializedName(ApiConstants.STATE)
- @Param(description = "state of the ip forwarding rule")
+ @Param(description = "State of the IP forwarding rule")
private String state;
public String getId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/IpRangeResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/IpRangeResponse.java
index 364c19f2df0..5c93287ad07 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/IpRangeResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/IpRangeResponse.java
@@ -26,27 +26,27 @@ import com.google.gson.annotations.SerializedName;
public class IpRangeResponse extends BaseResponse {
@SerializedName(ApiConstants.GATEWAY)
- @Param(description = "the gateway for the range")
+ @Param(description = "The gateway for the range")
private String gateway;
@SerializedName(ApiConstants.CIDR)
- @Param(description = "the CIDR for the range")
+ @Param(description = "The CIDR for the range")
private String cidr;
@SerializedName(ApiConstants.START_IP)
- @Param(description = "the starting IP for the range")
+ @Param(description = "The starting IP for the range")
private String startIp;
@SerializedName(ApiConstants.END_IP)
- @Param(description = "the ending IP for the range")
+ @Param(description = "The ending IP for the range")
private String endIp;
@SerializedName(ApiConstants.FOR_SYSTEM_VMS)
- @Param(description = "indicates if range is dedicated for CPVM and SSVM")
+ @Param(description = "Indicates if range is dedicated for CPVM and SSVM")
private String forSystemVms;
@SerializedName(ApiConstants.VLAN_ID)
- @Param(description = "indicates Vlan ID for the range")
+ @Param(description = "Indicates VLAN ID for the range")
private String vlanId;
public String getGateway() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/Ipv6RouteResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/Ipv6RouteResponse.java
index 4111ed94d5b..68f05cdd6ce 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/Ipv6RouteResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/Ipv6RouteResponse.java
@@ -26,11 +26,11 @@ import com.google.gson.annotations.SerializedName;
public class Ipv6RouteResponse extends BaseResponse {
@SerializedName(ApiConstants.SUBNET)
- @Param(description = "the guest IPv6 cidr for route")
+ @Param(description = "The guest IPv6 CIDR for route")
private String subnet;
@SerializedName(ApiConstants.GATEWAY)
- @Param(description = "the outbound IPv6 gateway")
+ @Param(description = "The outbound IPv6 gateway")
private String gateway;
public Ipv6RouteResponse(String subnet, String gateway) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/IsAccountAllowedToCreateOfferingsWithTagsResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/IsAccountAllowedToCreateOfferingsWithTagsResponse.java
index 5c763c2058a..ed7f3b57a9d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/IsAccountAllowedToCreateOfferingsWithTagsResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/IsAccountAllowedToCreateOfferingsWithTagsResponse.java
@@ -23,7 +23,7 @@ import org.apache.cloudstack.api.BaseResponse;
public class IsAccountAllowedToCreateOfferingsWithTagsResponse extends BaseResponse {
@SerializedName("isallowed")
- @Param(description = "is domain admin allowed to create offerings with tags")
+ @Param(description = "Is domain admin allowed to create offerings with tags")
private Boolean isAllowed;
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/IsoVmResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/IsoVmResponse.java
index 27f286dfca5..1b4b90d4dc4 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/IsoVmResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/IsoVmResponse.java
@@ -28,47 +28,47 @@ import com.cloud.template.VirtualMachineTemplate;
@SuppressWarnings("unused")
public class IsoVmResponse extends BaseResponse {
@SerializedName("id")
- @Param(description = "the ISO ID")
+ @Param(description = "The ISO ID")
private String id;
@SerializedName("name")
- @Param(description = "the ISO name")
+ @Param(description = "The ISO name")
private String name;
@SerializedName("displaytext")
- @Param(description = "the ISO display text")
+ @Param(description = "The ISO display text")
private String displayText;
@SerializedName("bootable")
- @Param(description = "true if the ISO is bootable, false otherwise")
+ @Param(description = "True if the ISO is bootable, false otherwise")
private Boolean bootable;
@SerializedName("isfeatured")
- @Param(description = "true if this template is a featured template, false otherwise")
+ @Param(description = "True if this Template is a featured Template, false otherwise")
private Boolean featured;
@SerializedName("ostypeid")
- @Param(description = "the ID of the OS type for this template.")
+ @Param(description = "The ID of the OS type for this Template.")
private String osTypeId;
@SerializedName("ostypename")
- @Param(description = "the name of the OS type for this template.")
+ @Param(description = "The name of the OS type for this Template.")
private String osTypeName;
@SerializedName("virtualmachineid")
- @Param(description = "id of the virtual machine")
+ @Param(description = "ID of the Instance")
private String virtualMachineId;
@SerializedName("vmname")
- @Param(description = "name of the virtual machine")
+ @Param(description = "Name of the Instance")
private String virtualMachineName;
@SerializedName("vmdisplayname")
- @Param(description = "display name of the virtual machine")
+ @Param(description = "Display name of the Instance")
private String virtualMachineDisplayName;
@SerializedName("vmstate")
- @Param(description = "state of the virtual machine")
+ @Param(description = "State of the Instance")
private String virtualMachineState;
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/LBHealthCheckPolicyResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/LBHealthCheckPolicyResponse.java
index df3a7a0fb7b..6355b03b18d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/LBHealthCheckPolicyResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/LBHealthCheckPolicyResponse.java
@@ -26,19 +26,19 @@ import com.google.gson.annotations.SerializedName;
public class LBHealthCheckPolicyResponse extends BaseResponse {
@SerializedName("id")
- @Param(description = "the LB HealthCheck policy ID")
+ @Param(description = "The LB HealthCheck policy ID")
private String id;
@SerializedName("pingpath")
- @Param(description = "the pingpath of the healthcheck policy")
+ @Param(description = "The pingpath of the healthcheck policy")
private String pingpath;
@SerializedName("description")
- @Param(description = "the description of the healthcheck policy")
+ @Param(description = "The description of the healthcheck policy")
private String description;
@SerializedName("state")
- @Param(description = "the state of the policy")
+ @Param(description = "The state of the policy")
private String state;
@SerializedName("responsetime")
@@ -50,15 +50,15 @@ public class LBHealthCheckPolicyResponse extends BaseResponse {
private int healthcheckInterval;
@SerializedName("healthcheckthresshold")
- @Param(description = "Number of consecutive health check success before declaring an instance healthy")
+ @Param(description = "Number of consecutive health check success before declaring an Instance healthy")
private int healthcheckthresshold;
@SerializedName("unhealthcheckthresshold")
- @Param(description = "Number of consecutive health check failures before declaring an instance unhealthy.")
+ @Param(description = "Number of consecutive health check failures before declaring an Instance unhealthy.")
private int unhealthcheckthresshold;
@SerializedName(ApiConstants.FOR_DISPLAY)
- @Param(description = "is policy for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
+ @Param(description = "Is policy for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
private Boolean forDisplay;
public void setId(String id) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/LBHealthCheckResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/LBHealthCheckResponse.java
index cbd953d34a3..f796a1c4d6c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/LBHealthCheckResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/LBHealthCheckResponse.java
@@ -30,27 +30,27 @@ import com.cloud.serializer.Param;
@EntityReference(value = HealthCheckPolicy.class)
public class LBHealthCheckResponse extends BaseResponse {
@SerializedName("lbruleid")
- @Param(description = "the LB rule ID")
+ @Param(description = "The LB rule ID")
private String lbRuleId;
@SerializedName("account")
- @Param(description = "the account of the HealthCheck policy")
+ @Param(description = "The Account of the HealthCheck policy")
private String accountName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain ID of the HealthCheck policy")
+ @Param(description = "The domain ID of the HealthCheck policy")
private String domainId;
@SerializedName("domain")
- @Param(description = "the domain of the HealthCheck policy")
+ @Param(description = "The domain of the HealthCheck policy")
private String domainName;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "the id of the zone the HealthCheck policy belongs to")
+ @Param(description = "The ID of the zone the HealthCheck policy belongs to")
private String zoneId;
@SerializedName("healthcheckpolicy")
- @Param(description = "the list of healthcheckpolicies", responseObject = LBHealthCheckPolicyResponse.class)
+ @Param(description = "The list of healthcheckpolicies", responseObject = LBHealthCheckPolicyResponse.class)
private List healthCheckPolicies;
public void setlbRuleId(String lbRuleId) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/LBStickinessPolicyResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/LBStickinessPolicyResponse.java
index 82078b48362..db0a908dc72 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/LBStickinessPolicyResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/LBStickinessPolicyResponse.java
@@ -32,27 +32,27 @@ import com.cloud.utils.Pair;
public class LBStickinessPolicyResponse extends BaseResponse {
@SerializedName("id")
- @Param(description = "the LB Stickiness policy ID")
+ @Param(description = "The LB Stickiness policy ID")
private String id;
@SerializedName("name")
- @Param(description = "the name of the Stickiness policy")
+ @Param(description = "The name of the Stickiness policy")
private String name;
@SerializedName("methodname")
- @Param(description = "the method name of the Stickiness policy")
+ @Param(description = "The method name of the Stickiness policy")
private String methodName;
@SerializedName("description")
- @Param(description = "the description of the Stickiness policy")
+ @Param(description = "The description of the Stickiness policy")
private String description;;
@SerializedName("state")
- @Param(description = "the state of the policy")
+ @Param(description = "The state of the policy")
private String state;
@SerializedName(ApiConstants.FOR_DISPLAY)
- @Param(description = "is policy for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
+ @Param(description = "Is policy for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
private Boolean forDisplay;
// FIXME : if params with the same name exist more than once then values are concatenated with ":" as delimiter .
@@ -60,7 +60,7 @@ public class LBStickinessPolicyResponse extends BaseResponse {
// Example: {indirect=null, name=testcookie, nocache=null, domain=www.yahoo.com:www.google.com, postonly=null}
// in the above there are two domains with values www.yahoo.com and www.google.com
@SerializedName("params")
- @Param(description = "the params of the policy")
+ @Param(description = "The params of the policy")
private Map params;
public Map getParams() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/LBStickinessResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/LBStickinessResponse.java
index 75c00acfab0..7abcf307ced 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/LBStickinessResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/LBStickinessResponse.java
@@ -30,39 +30,39 @@ import com.cloud.serializer.Param;
@EntityReference(value = StickinessPolicy.class)
public class LBStickinessResponse extends BaseResponse {
@SerializedName("lbruleid")
- @Param(description = "the LB rule ID")
+ @Param(description = "The LB rule ID")
private String lbRuleId;
@SerializedName("name")
- @Param(description = "the name of the Stickiness policy")
+ @Param(description = "The name of the Stickiness policy")
private String name;
@SerializedName("description")
- @Param(description = "the description of the Stickiness policy")
+ @Param(description = "The description of the Stickiness policy")
private String description;;
@SerializedName("account")
- @Param(description = "the account of the Stickiness policy")
+ @Param(description = "The Account of the Stickiness policy")
private String accountName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain ID of the Stickiness policy")
+ @Param(description = "The domain ID of the Stickiness policy")
private String domainId;
@SerializedName("domain")
- @Param(description = "the domain of the Stickiness policy")
+ @Param(description = "The domain of the Stickiness policy")
private String domainName;
@SerializedName("state")
- @Param(description = "the state of the policy")
+ @Param(description = "The state of the policy")
private String state;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "the id of the zone the Stickiness policy belongs to")
+ @Param(description = "The ID of the zone the Stickiness policy belongs to")
private String zoneId;
@SerializedName("stickinesspolicy")
- @Param(description = "the list of stickinesspolicies", responseObject = LBStickinessPolicyResponse.class)
+ @Param(description = "The list of stickinesspolicies", responseObject = LBStickinessPolicyResponse.class)
private List stickinessPolicies;
public void setlbRuleId(String lbRuleId) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/LoadBalancerResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/LoadBalancerResponse.java
index e520dec09e7..c57323d439d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/LoadBalancerResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/LoadBalancerResponse.java
@@ -28,63 +28,63 @@ import com.google.gson.annotations.SerializedName;
@SuppressWarnings("unused")
public class LoadBalancerResponse extends BaseResponse implements ControlledEntityResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the load balancer rule ID")
+ @Param(description = "The Load balancer rule ID")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the load balancer")
+ @Param(description = "The name of the Load balancer")
private String name;
@SerializedName(ApiConstants.DESCRIPTION)
- @Param(description = "the description of the load balancer")
+ @Param(description = "The description of the Load balancer")
private String description;
@SerializedName(ApiConstants.PUBLIC_IP_ID)
- @Param(description = "the public ip address id")
+ @Param(description = "The public IP address ID")
private String publicIpId;
@SerializedName(ApiConstants.PUBLIC_IP)
- @Param(description = "the public ip address")
+ @Param(description = "The public IP address")
private String publicIp;
@SerializedName(ApiConstants.PUBLIC_PORT)
- @Param(description = "the public port")
+ @Param(description = "The public port")
private String publicPort;
@SerializedName(ApiConstants.PRIVATE_PORT)
- @Param(description = "the private port")
+ @Param(description = "The private port")
private String privatePort;
@SerializedName(ApiConstants.ALGORITHM)
- @Param(description = "the load balancer algorithm (source, roundrobin, leastconn)")
+ @Param(description = "The Load balancer algorithm (source, roundrobin, leastconn)")
private String algorithm;
@SerializedName(ApiConstants.NETWORK_ID)
- @Param(description = "the id of the guest network the lb rule belongs to")
+ @Param(description = "The ID of the guest Network the LB rule belongs to")
private String networkId;
@SerializedName(ApiConstants.CIDR_LIST)
- @Param(description = "the CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).")
+ @Param(description = "The CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).")
private String cidrList;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account of the load balancer rule")
+ @Param(description = "The Account of the Load balancer rule")
private String accountName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the load balancer")
+ @Param(description = "The project ID of the Load balancer")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the load balancer")
+ @Param(description = "The project name of the Load balancer")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain ID of the load balancer rule")
+ @Param(description = "The domain ID of the Load balancer rule")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain of the load balancer rule")
+ @Param(description = "The domain of the Load balancer rule")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
@@ -92,27 +92,27 @@ public class LoadBalancerResponse extends BaseResponse implements ControlledEnti
private String domainPath;
@SerializedName(ApiConstants.STATE)
- @Param(description = "the state of the rule")
+ @Param(description = "The state of the rule")
private String state;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "the id of the zone the rule belongs to")
+ @Param(description = "The ID of the zone the rule belongs to")
private String zoneId;
@SerializedName(ApiConstants.ZONE_NAME)
- @Param(description = "the name of the zone the load balancer rule belongs to", since = "4.11")
+ @Param(description = "The name of the zone the Load balancer rule belongs to", since = "4.11")
private String zoneName;
@SerializedName(ApiConstants.PROTOCOL)
- @Param(description = "the protocol of the loadbalanacer rule")
+ @Param(description = "The protocol of the Load Balancer rule")
private String lbProtocol;
@SerializedName(ApiConstants.TAGS)
- @Param(description = "the list of resource tags associated with load balancer", responseObject = ResourceTagResponse.class)
+ @Param(description = "The list of resource tags associated with Load balancer", responseObject = ResourceTagResponse.class)
private List tags;
@SerializedName(ApiConstants.FOR_DISPLAY)
- @Param(description = "is rule for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
+ @Param(description = "Is rule for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
private Boolean forDisplay;
public void setId(String id) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/LoadBalancerRuleVmMapResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/LoadBalancerRuleVmMapResponse.java
index 57c45e64324..497339938bb 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/LoadBalancerRuleVmMapResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/LoadBalancerRuleVmMapResponse.java
@@ -34,11 +34,11 @@ public class LoadBalancerRuleVmMapResponse extends BaseResponse {
@SerializedName("loadbalancerruleinstance")
- @Param(description = "the user vm set for lb rule")
+ @Param(description = "The user Instance set for LB rule")
private UserVmResponse UserVmResponse;
@SerializedName("lbvmipaddresses")
- @Param(description = "IP addresses of the vm set of lb rule")
+ @Param(description = "IP addresses of the Instance set of LB rule")
private List ipAddr;
public void setIpAddr(List ipAddr) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/LoginCmdResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/LoginCmdResponse.java
index 84c79d32321..4edcab2e577 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/LoginCmdResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/LoginCmdResponse.java
@@ -35,31 +35,31 @@ public class LoginCmdResponse extends AuthenticationCmdResponse {
private String domainId;
@SerializedName(value = ApiConstants.TIMEOUT)
- @Param(description = "the time period before the session has expired")
+ @Param(description = "The time period before the session has expired")
private Integer timeout;
@SerializedName(value = ApiConstants.ACCOUNT)
- @Param(description = "the account name the user belongs to")
+ @Param(description = "The Account name the User belongs to")
private String account;
@SerializedName(value = ApiConstants.FIRSTNAME)
- @Param(description = "first name of the user")
+ @Param(description = "First name of the user")
private String firstName;
@SerializedName(value = ApiConstants.LASTNAME)
- @Param(description = "last name of the user")
+ @Param(description = "Last name of the user")
private String lastName;
@SerializedName(value = ApiConstants.TYPE)
- @Param(description = "the account type (admin, domain-admin, read-only-admin, user)")
+ @Param(description = "The Account type (admin, domain-admin, read-only-admin, user)")
private String type;
@SerializedName(value = ApiConstants.TIMEZONE)
- @Param(description = "user time zone")
+ @Param(description = "User time zone")
private String timeZone;
@SerializedName(value = ApiConstants.TIMEZONEOFFSET)
- @Param(description = "user time zoneoffset")
+ @Param(description = "User time zoneoffset")
private String timeZoneOffset;
@SerializedName(value = ApiConstants.REGISTERED)
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ManagementServerResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ManagementServerResponse.java
index d3f1096d39e..077b3c34943 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ManagementServerResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ManagementServerResponse.java
@@ -31,52 +31,52 @@ import java.util.List;
@EntityReference(value = ManagementServerHost.class)
public class ManagementServerResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the management server")
+ @Param(description = "The ID of the management server")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the management server")
+ @Param(description = "The name of the management server")
private String name;
@SerializedName(ApiConstants.STATE)
- @Param(description = "the state of the management server")
+ @Param(description = "The state of the management server")
private State state;
@SerializedName(ApiConstants.VERSION)
- @Param(description = "the version of the management server")
+ @Param(description = "The version of the management server")
private String version;
@SerializedName(ApiConstants.JAVA_DISTRIBUTION)
- @Param(description = "the java distribution name running the management server process")
+ @Param(description = "The java distribution name running the management server process")
private String javaDistribution;
@SerializedName(ApiConstants.JAVA_VERSION)
- @Param(description = "the version of the java distribution running the management server process")
+ @Param(description = "The version of the java distribution running the management server process")
private String javaVersion;
@SerializedName(ApiConstants.OS_DISTRIBUTION)
- @Param(description = "the name of the OS distribution running on the management server")
+ @Param(description = "The name of the OS distribution running on the management server")
private String osDistribution;
@SerializedName(ApiConstants.LAST_SERVER_START)
- @Param(description = "the last time this Management Server was started")
+ @Param(description = "The last time this Management Server was started")
private Date lastServerStart;
@SerializedName(ApiConstants.LAST_SERVER_STOP)
- @Param(description = "the last time this Management Server was stopped")
+ @Param(description = "The last time this Management Server was stopped")
private Date lastServerStop;
@SerializedName(ApiConstants.LAST_BOOT)
- @Param(description = "the last time the host on which this Management Server runs was booted")
+ @Param(description = "The last time the host on which this Management Server runs was booted")
private Date lastBoot;
@SerializedName(ApiConstants.KERNEL_VERSION)
- @Param(description = "the running OS kernel version for this Management Server")
+ @Param(description = "The running OS kernel version for this Management Server")
private String kernelVersion;
@Deprecated
@SerializedName(ApiConstants.SERVICE_IP)
- @Param(description = "the IP Address for this Management Server. This is deprecated, please use 'ipaddress' instead.")
+ @Param(description = "The IP Address for this Management Server. This is deprecated, please use 'ipaddress' instead.")
private String serviceIp;
@SerializedName(ApiConstants.IP_ADDRESS)
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/MigrationResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/MigrationResponse.java
index c67b1d2d13e..62934151b38 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/MigrationResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/MigrationResponse.java
@@ -35,7 +35,7 @@ public class MigrationResponse extends BaseResponse {
private String migrationType;
@SerializedName("success")
- @Param(description = "true if operation is executed successfully")
+ @Param(description = "True if operation is executed successfully")
private boolean success;
MigrationResponse() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/NetworkACLItemResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/NetworkACLItemResponse.java
index f63cbbf4cb5..7af7ea2610b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/NetworkACLItemResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/NetworkACLItemResponse.java
@@ -30,51 +30,51 @@ import com.google.gson.annotations.SerializedName;
@EntityReference(value = NetworkACLItem.class)
public class NetworkACLItemResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the ACL Item")
+ @Param(description = "The ID of the ACL Item")
private String id;
@SerializedName(ApiConstants.PROTOCOL)
- @Param(description = "the protocol of the ACL")
+ @Param(description = "The protocol of the ACL")
private String protocol;
@SerializedName(ApiConstants.START_PORT)
- @Param(description = "the starting port of ACL's port range")
+ @Param(description = "The starting port of ACL's port range")
private String startPort;
@SerializedName(ApiConstants.END_PORT)
- @Param(description = "the ending port of ACL's port range")
+ @Param(description = "The ending port of ACL's port range")
private String endPort;
@SerializedName(ApiConstants.TRAFFIC_TYPE)
- @Param(description = "the traffic type for the ACL")
+ @Param(description = "The traffic type for the ACL")
private String trafficType;
@SerializedName(ApiConstants.STATE)
- @Param(description = "the state of the rule")
+ @Param(description = "The state of the rule")
private String state;
@SerializedName(ApiConstants.CIDR_LIST)
- @Param(description = "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).")
+ @Param(description = "The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).")
private String cidrList;
@SerializedName(ApiConstants.ICMP_TYPE)
- @Param(description = "type of the icmp message being sent")
+ @Param(description = "Type of the icmp message being sent")
private Integer icmpType;
@SerializedName(ApiConstants.ICMP_CODE)
- @Param(description = "error code for this icmp message")
+ @Param(description = "Error code for this icmp message")
private Integer icmpCode;
@SerializedName(ApiConstants.TAGS)
- @Param(description = "the list of resource tags associated with the network ACLs", responseObject = ResourceTagResponse.class)
+ @Param(description = "The list of resource tags associated with the Network ACLs", responseObject = ResourceTagResponse.class)
private List tags;
@SerializedName(ApiConstants.ACL_ID)
- @Param(description = "the ID of the ACL this item belongs to")
+ @Param(description = "The ID of the ACL this item belongs to")
private String aclId;
@SerializedName(ApiConstants.ACL_NAME)
- @Param(description = "the name of the ACL this item belongs to")
+ @Param(description = "The name of the ACL this item belongs to")
private String aclName;
@SerializedName(ApiConstants.NUMBER)
@@ -86,11 +86,11 @@ public class NetworkACLItemResponse extends BaseResponse {
private String action;
@SerializedName(ApiConstants.FOR_DISPLAY)
- @Param(description = "is rule for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
+ @Param(description = "Is rule for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
private Boolean forDisplay;
@SerializedName(ApiConstants.ACL_REASON)
- @Param(description = "an explanation on why this ACL rule is being applied", since = "4.12")
+ @Param(description = "An explanation on why this ACL rule is being applied", since = "4.12")
private String reason;
public void setId(String id) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/NetworkACLResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/NetworkACLResponse.java
index 72ee80a2b0a..7c120c59c81 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/NetworkACLResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/NetworkACLResponse.java
@@ -28,11 +28,11 @@ import com.google.gson.annotations.SerializedName;
@EntityReference(value = NetworkACL.class)
public class NetworkACLResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the ACL")
+ @Param(description = "The ID of the ACL")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the Name of the ACL")
+ @Param(description = "The Name of the ACL")
private String name;
@SerializedName(ApiConstants.DESCRIPTION)
@@ -48,7 +48,7 @@ public class NetworkACLResponse extends BaseResponse {
private String vpcName;
@SerializedName(ApiConstants.FOR_DISPLAY)
- @Param(description = "is ACL for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
+ @Param(description = "Is ACL for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
private Boolean forDisplay;
public void setId(String id) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/NetworkDeviceResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/NetworkDeviceResponse.java
index a991c7ae2b0..0d6f7be4557 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/NetworkDeviceResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/NetworkDeviceResponse.java
@@ -25,7 +25,7 @@ import com.cloud.serializer.Param;
public class NetworkDeviceResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the network device")
+ @Param(description = "The ID of the Network device")
private String id;
public String getId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/NetworkOfferingResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/NetworkOfferingResponse.java
index 81a8129ecb7..87f96059028 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/NetworkOfferingResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/NetworkOfferingResponse.java
@@ -32,71 +32,71 @@ import com.google.gson.annotations.SerializedName;
@SuppressWarnings("unused")
public class NetworkOfferingResponse extends BaseResponseWithAnnotations {
@SerializedName("id")
- @Param(description = "the id of the network offering")
+ @Param(description = "The ID of the Network offering")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the network offering")
+ @Param(description = "The name of the Network offering")
private String name;
@SerializedName(ApiConstants.DISPLAY_TEXT)
- @Param(description = "an alternate display text of the network offering.")
+ @Param(description = "An alternate display text of the Network offering.")
private String displayText;
@SerializedName(ApiConstants.TAGS)
- @Param(description = "the tags for the network offering")
+ @Param(description = "The tags for the Network offering")
private String tags;
@SerializedName(ApiConstants.CREATED)
- @Param(description = "the date this network offering was created")
+ @Param(description = "The date this Network offering was created")
private Date created;
@SerializedName(ApiConstants.TRAFFIC_TYPE)
- @Param(description = "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.")
+ @Param(description = "The traffic type for the Network offering, supported types are Public, Management, Control, Guest, VLAN or Storage.")
private String trafficType;
@SerializedName(ApiConstants.IS_DEFAULT)
- @Param(description = "true if network offering is default, false otherwise")
+ @Param(description = "True if Network offering is default, false otherwise")
private Boolean isDefault;
@SerializedName(ApiConstants.SPECIFY_VLAN)
- @Param(description = "true if network offering supports vlans, false otherwise")
+ @Param(description = "True if Network offering supports VLANs, false otherwise")
private Boolean specifyVlan;
@SerializedName(ApiConstants.CONSERVE_MODE)
- @Param(description = "true if network offering is ip conserve mode enabled")
+ @Param(description = "True if Network offering is IP conserve mode enabled")
private Boolean conserveMode;
@SerializedName(ApiConstants.SPECIFY_IP_RANGES)
- @Param(description = "true if network offering supports specifying ip ranges, false otherwise")
+ @Param(description = "True if Network offering supports specifying IP ranges, false otherwise")
private Boolean specifyIpRanges;
@SerializedName(ApiConstants.AVAILABILITY)
- @Param(description = "availability of the network offering")
+ @Param(description = "Availability of the Network offering")
private String availability;
@SerializedName(ApiConstants.NETWORKRATE)
- @Param(description = "data transfer rate in megabits per second allowed.")
+ @Param(description = "Data transfer rate in megabits per second allowed.")
private Integer networkRate;
@SerializedName(ApiConstants.STATE)
- @Param(description = "state of the network offering. Can be Disabled/Enabled/Inactive")
+ @Param(description = "State of the Network offering. Can be Disabled/Enabled/Inactive")
private String state;
@SerializedName(ApiConstants.GUEST_IP_TYPE)
- @Param(description = "guest type of the network offering, can be Shared or Isolated")
+ @Param(description = "Guest type of the Network offering, can be Shared or Isolated")
private String guestIpType;
@SerializedName(ApiConstants.SERVICE_OFFERING_ID)
- @Param(description = "the ID of the service offering used by virtual router provider")
+ @Param(description = "The ID of the service offering used by virtual router provider")
private String serviceOfferingId;
@SerializedName(ApiConstants.SERVICE)
- @Param(description = "the list of supported services", responseObject = ServiceResponse.class)
+ @Param(description = "The list of supported services", responseObject = ServiceResponse.class)
private List services;
@SerializedName(ApiConstants.FOR_VPC)
- @Param(description = "true if network offering can be used by VPC networks only")
+ @Param(description = "True if Network offering can be used by VPC Networks only")
private Boolean forVpc;
@SerializedName(ApiConstants.FOR_NSX)
@@ -104,7 +104,7 @@ public class NetworkOfferingResponse extends BaseResponseWithAnnotations {
private Boolean forNsx;
@SerializedName(ApiConstants.FOR_TUNGSTEN)
- @Param(description = "true if network offering can be used by Tungsten-Fabric networks only")
+ @Param(description = "True if Network offering can be used by Tungsten-Fabric Networks only")
private Boolean forTungsten;
@SerializedName(ApiConstants.NETWORK_MODE)
@@ -112,27 +112,27 @@ public class NetworkOfferingResponse extends BaseResponseWithAnnotations {
private String networkMode;
@SerializedName(ApiConstants.IS_PERSISTENT)
- @Param(description = "true if network offering supports persistent networks, false otherwise")
+ @Param(description = "True if Network offering supports persistent networks, false otherwise")
private Boolean isPersistent;
@SerializedName(ApiConstants.DETAILS)
- @Param(description = "additional key/value details tied with network offering", since = "4.2.0")
+ @Param(description = "Additional key/value details tied with network offering", since = "4.2.0")
private Map details;
@SerializedName(ApiConstants.EGRESS_DEFAULT_POLICY)
- @Param(description = "true if guest network default egress policy is allow; false if default egress policy is deny")
+ @Param(description = "True if guest network default egress policy is allow; false if default egress policy is deny")
private Boolean egressDefaultPolicy;
@SerializedName(ApiConstants.MAX_CONNECTIONS)
- @Param(description = "maximum number of concurrents connections to be handled by lb")
+ @Param(description = "Maximum number of concurrent connections to be handled by LB")
private Integer concurrentConnections;
@SerializedName(ApiConstants.SUPPORTS_STRECHED_L2_SUBNET)
- @Param(description = "true if network offering supports network that span multiple zones", since = "4.4")
+ @Param(description = "True if network offering supports network that span multiple zones", since = "4.4")
private Boolean supportsStrechedL2Subnet;
@SerializedName(ApiConstants.SUPPORTS_PUBLIC_ACCESS)
- @Param(description = "true if network offering supports public access for guest networks", since = "4.10.0")
+ @Param(description = "True if network offering supports public access for guest networks", since = "4.10.0")
private Boolean supportsPublicAccess;
@SerializedName(ApiConstants.SUPPORTS_INTERNAL_LB)
@@ -140,23 +140,23 @@ public class NetworkOfferingResponse extends BaseResponseWithAnnotations {
private Boolean supportsInternalLb;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.")
+ @Param(description = "The domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.")
+ @Param(description = "The domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.")
private String domain;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", since = "4.13.0")
+ @Param(description = "The zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", since = "4.13.0")
private String zoneId;
@SerializedName(ApiConstants.ZONE)
- @Param(description = "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", since = "4.13.0")
+ @Param(description = "The zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", since = "4.13.0")
private String zone;
@SerializedName(ApiConstants.INTERNET_PROTOCOL)
- @Param(description = "the internet protocol of the network offering")
+ @Param(description = "The internet protocol of the network offering")
private String internetProtocol;
@SerializedName(ApiConstants.SPECIFY_AS_NUMBER)
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/NetworkPermissionsResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/NetworkPermissionsResponse.java
index fcecd14e282..27be4a51514 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/NetworkPermissionsResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/NetworkPermissionsResponse.java
@@ -29,31 +29,31 @@ import com.cloud.serializer.Param;
@SuppressWarnings("unused")
public class NetworkPermissionsResponse extends BaseResponse {
@SerializedName(ApiConstants.NETWORK_ID)
- @Param(description = "the network ID")
+ @Param(description = "The Network ID")
private String networkId;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the ID of the domain to which the network belongs")
+ @Param(description = "The ID of the domain to which the Network belongs")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the name of the domain to which the network belongs")
+ @Param(description = "The name of the domain to which the Network belongs")
private String domainName;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account the network is available for")
+ @Param(description = "The Account the Network is available for")
private String accountName;
@SerializedName(ApiConstants.ACCOUNT_ID)
- @Param(description = "the ID of account the network is available for")
+ @Param(description = "The ID of Account the Network is available for")
private String accountId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project the network is available for")
+ @Param(description = "The project the Network is available for")
private String projectName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the ID of project the network is available for")
+ @Param(description = "The ID of project the Network is available for")
private String projectId;
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/NetworkResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/NetworkResponse.java
index a1ffda72234..faa257ccfa7 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/NetworkResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/NetworkResponse.java
@@ -36,103 +36,103 @@ import com.google.gson.annotations.SerializedName;
public class NetworkResponse extends BaseResponseWithAssociatedNetwork implements ControlledEntityResponse, SetResourceIconResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the id of the network")
+ @Param(description = "The ID of the Network")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the network")
+ @Param(description = "The name of the Network")
private String name;
@SerializedName(ApiConstants.DISPLAY_TEXT)
- @Param(description = "the displaytext of the network")
+ @Param(description = "The displaytext of the Network")
private String displaytext;
@SerializedName("broadcastdomaintype")
- @Param(description = "Broadcast domain type of the network")
+ @Param(description = "Broadcast domain type of the Network")
private String broadcastDomainType;
@SerializedName(ApiConstants.TRAFFIC_TYPE)
- @Param(description = "the traffic type of the network")
+ @Param(description = "The traffic type of the Network")
private String trafficType;
@SerializedName(ApiConstants.GATEWAY)
- @Param(description = "the network's gateway")
+ @Param(description = "The Network's gateway")
private String gateway;
@SerializedName(ApiConstants.NETMASK)
- @Param(description = "the network's netmask")
+ @Param(description = "The Network's netmask")
private String netmask;
@SerializedName(ApiConstants.CIDR)
- @Param(description = "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR")
+ @Param(description = "CloudStack managed address space, all CloudStack managed Instances get IP address from CIDR")
private String cidr;
@SerializedName(ApiConstants.NETWORK_CIDR)
- @Param(description = "the network CIDR of the guest network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE")
+ @Param(description = "The Network CIDR of the guest Network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE")
private String networkCidr;
@SerializedName(ApiConstants.RESERVED_IP_RANGE)
- @Param(description = "the network's IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes")
+ @Param(description = "The Network's IP range not to be used by CloudStack guest Instances and can be used for non CloudStack purposes")
private String reservedIpRange;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "zone id of the network")
+ @Param(description = "Zone ID of the Network")
private String zoneId;
@SerializedName(ApiConstants.ZONE_NAME)
- @Param(description = "the name of the zone the network belongs to")
+ @Param(description = "The name of the zone the Network belongs to")
private String zoneName;
@SerializedName("networkofferingid")
- @Param(description = "network offering id the network is created from")
+ @Param(description = "Network offering ID the Network is created from")
private String networkOfferingId;
@SerializedName("networkofferingname")
- @Param(description = "name of the network offering the network is created from")
+ @Param(description = "Name of the Network offering the Network is created from")
private String networkOfferingName;
@SerializedName("networkofferingdisplaytext")
- @Param(description = "display text of the network offering the network is created from")
+ @Param(description = "Display text of the Network offering the Network is created from")
private String networkOfferingDisplayText;
@SerializedName("networkofferingconservemode")
- @Param(description = "true if network offering is ip conserve mode enabled")
+ @Param(description = "True if Network offering is IP conserve mode enabled")
private Boolean networkOfferingConserveMode;
@SerializedName("networkofferingavailability")
- @Param(description = "availability of the network offering the network is created from")
+ @Param(description = "Availability of the Network offering the Network is created from")
private String networkOfferingAvailability;
@SerializedName(ApiConstants.IS_SYSTEM)
- @Param(description = "true if network is system, false otherwise")
+ @Param(description = "True if Network is system, false otherwise")
private Boolean isSystem;
@SerializedName(ApiConstants.STATE)
- @Param(description = "state of the network")
+ @Param(description = "State of the Network")
private String state;
@SerializedName("related")
- @Param(description = "related to what other network configuration")
+ @Param(description = "Related to what other Network configuration")
private String related;
@SerializedName("broadcasturi")
- @Param(description = "broadcast uri of the network. This parameter is visible to ROOT admins only")
+ @Param(description = "Broadcast URI of the Network. This parameter is visible to ROOT admins only")
private String broadcastUri;
@SerializedName(ApiConstants.DNS1)
- @Param(description = "the first IPv4 DNS for the network")
+ @Param(description = "The first IPv4 DNS for the Network")
private String dns1;
@SerializedName(ApiConstants.DNS2)
- @Param(description = "the second IPv4 DNS for the network")
+ @Param(description = "The second IPv4 DNS for the Network")
private String dns2;
@SerializedName(ApiConstants.TYPE)
- @Param(description = "the type of the network")
+ @Param(description = "The type of the Network")
private String type;
@SerializedName(ApiConstants.VLAN)
- @Param(description = "The vlan of the network. This parameter is visible to ROOT admins only")
+ @Param(description = "The VLAN of the Network. This parameter is visible to ROOT admins only")
private String vlan;
@SerializedName(ApiConstants.AS_NUMBER_ID)
@@ -144,139 +144,139 @@ public class NetworkResponse extends BaseResponseWithAssociatedNetwork implement
private Long asNumber;
@SerializedName(ApiConstants.ACL_TYPE)
- @Param(description = "acl type - access type to the network")
+ @Param(description = "ACL type - access type to the Network")
private String aclType;
@SerializedName(ApiConstants.SUBDOMAIN_ACCESS)
- @Param(description = "true if users from subdomains can access the domain level network")
+ @Param(description = "True if users from subdomains can access the domain level Network")
private Boolean subdomainAccess;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the owner of the network")
+ @Param(description = "The owner of the Network")
private String accountName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the ipaddress")
+ @Param(description = "The project ID of the IP address")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the address")
+ @Param(description = "The project name of the address")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain id of the network owner")
+ @Param(description = "The domain ID of the Network owner")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain name of the network owner")
+ @Param(description = "The domain name of the Network owner")
private String domain;
@SerializedName(ApiConstants.DOMAIN_PATH)
- @Param(description = "path of the Domain the network belongs to", since = "4.19.0.0")
+ @Param(description = "Path of the Domain the network belongs to", since = "4.19.0.0")
private String domainPath;
@SerializedName("isdefault")
- @Param(description = "true if network is default, false otherwise")
+ @Param(description = "True if Network is default, false otherwise")
private Boolean isDefault;
@SerializedName("service")
- @Param(description = "the list of services", responseObject = ServiceResponse.class)
+ @Param(description = "The list of services", responseObject = ServiceResponse.class)
private List services;
@SerializedName(ApiConstants.NETWORK_DOMAIN)
- @Param(description = "the network domain")
+ @Param(description = "The Network domain")
private String networkDomain;
@SerializedName(ApiConstants.PHYSICAL_NETWORK_ID)
- @Param(description = "the physical network id")
+ @Param(description = "The physical Network id")
private String physicalNetworkId;
@SerializedName(ApiConstants.RESTART_REQUIRED)
- @Param(description = "true network requires restart")
+ @Param(description = "True if Network requires restart")
private Boolean restartRequired;
@SerializedName(ApiConstants.SPECIFY_VLAN)
- @Param(description = "true if network supports specifying vlan, false otherwise")
+ @Param(description = "True if network supports specifying vlan, false otherwise")
private Boolean specifyVlan;
@SerializedName(ApiConstants.SPECIFY_IP_RANGES)
- @Param(description = "true if network supports specifying ip ranges, false otherwise")
+ @Param(description = "True if Network supports specifying IP ranges, false otherwise")
private Boolean specifyIpRanges;
@SerializedName(ApiConstants.VPC_ID)
- @Param(description = "VPC the network belongs to")
+ @Param(description = "VPC the Network belongs to")
private String vpcId;
@SerializedName(ApiConstants.VPC_NAME)
- @Param(description = "Name of the VPC to which this network belongs", since = "4.15")
+ @Param(description = "Name of the VPC to which this Network belongs", since = "4.15")
private String vpcName;
@SerializedName(ApiConstants.ASSOCIATED_NETWORK_ID)
- @Param(description = "the ID of the Network associated with this network")
+ @Param(description = "The ID of the Network associated with this Network")
private String associatedNetworkId;
@SerializedName(ApiConstants.ASSOCIATED_NETWORK)
- @Param(description = "the name of the Network associated with this network")
+ @Param(description = "The name of the Network associated with this Network")
private String associatedNetworkName;
@SerializedName(ApiConstants.TUNGSTEN_VIRTUAL_ROUTER_UUID)
- @Param(description = "Tungsten-Fabric virtual router the network belongs to")
+ @Param(description = "Tungsten-Fabric virtual router the Network belongs to")
private String tungstenVirtualRouterUuid;
@SerializedName(ApiConstants.CAN_USE_FOR_DEPLOY)
- @Param(description = "list networks available for vm deployment")
+ @Param(description = "List Networks available for Instance deployment")
private Boolean canUseForDeploy;
@SerializedName(ApiConstants.IS_PERSISTENT)
- @Param(description = "list networks that are persistent")
+ @Param(description = "List Networks that are persistent")
private Boolean isPersistent;
@SerializedName(ApiConstants.TAGS)
- @Param(description = "the list of resource tags associated with network", responseObject = ResourceTagResponse.class)
+ @Param(description = "The list of resource tags associated with Network", responseObject = ResourceTagResponse.class)
private List tags;
@SerializedName(ApiConstants.DETAILS)
- @Param(description = "the details of the network")
+ @Param(description = "The details of the Network")
private Map details;
@SerializedName(ApiConstants.IP6_GATEWAY)
- @Param(description = "the gateway of IPv6 network")
+ @Param(description = "The gateway of IPv6 Network")
private String ip6Gateway;
@SerializedName(ApiConstants.IP6_CIDR)
- @Param(description = "the cidr of IPv6 network")
+ @Param(description = "The CIDR of IPv6 Network")
private String ip6Cidr;
@SerializedName(ApiConstants.DISPLAY_NETWORK)
- @Param(description = "an optional field, whether to the display the network to the end user or not.", authorized = {RoleType.Admin})
+ @Param(description = "An optional field, whether to the display the Network to the end user or not.", authorized = {RoleType.Admin})
private Boolean displayNetwork;
@SerializedName(ApiConstants.ACL_ID)
- @Param(description = "ACL Id associated with the VPC network")
+ @Param(description = "ACL ID associated with the VPC Network")
private String aclId;
@SerializedName(ApiConstants.ACL_NAME)
- @Param(description = "ACL name associated with the VPC network")
+ @Param(description = "ACL name associated with the VPC Network")
private String aclName;
@SerializedName(ApiConstants.STRECHED_L2_SUBNET)
- @Param(description = "true if network can span multiple zones", since = "4.4")
+ @Param(description = "True if Network can span multiple zones", since = "4.4")
private Boolean strechedL2Subnet;
@SerializedName(ApiConstants.NETWORK_SPANNED_ZONES)
- @Param(description = "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", since = "4.4")
+ @Param(description = "If a Network is enabled for 'stretched L2 subnet' then represents zones on which Network currently spans", since = "4.4")
private Set networkSpannedZones;
@SerializedName(ApiConstants.EXTERNAL_ID)
- @Param(description = "The external id of the network", since = "4.11")
+ @Param(description = "The external ID of the Network", since = "4.11")
private String externalId;
@SerializedName(ApiConstants.REDUNDANT_ROUTER)
- @Param(description = "If the network has redundant routers enabled", since = "4.11.1")
+ @Param(description = "If the Network has redundant routers enabled", since = "4.11.1")
private Boolean redundantRouter;
@SerializedName(ApiConstants.SUPPORTS_VM_AUTOSCALING)
- @Param(description = "if network offering supports vm autoscaling feature", since = "4.18.0")
+ @Param(description = "If Network offering supports Instance autoscaling feature", since = "4.18.0")
private Boolean supportsVmAutoScaling;
@SerializedName(ApiConstants.RESOURCE_ICON)
@@ -284,35 +284,35 @@ public class NetworkResponse extends BaseResponseWithAssociatedNetwork implement
ResourceIconResponse icon;
@SerializedName(ApiConstants.CREATED)
- @Param(description = "the date this network was created", since = "4.16.0")
+ @Param(description = "The date this Network was created", since = "4.16.0")
private Date created;
@SerializedName(ApiConstants.RECEIVED_BYTES)
- @Param(description = "the total number of network traffic bytes received")
+ @Param(description = "The total number of Network traffic bytes received")
private Long bytesReceived;
@SerializedName(ApiConstants.SENT_BYTES)
- @Param(description = "the total number of network traffic bytes sent")
+ @Param(description = "The total number of Network traffic bytes sent")
private Long bytesSent;
@SerializedName((ApiConstants.EGRESS_DEFAULT_POLICY))
- @Param(description = "true if guest network default egress policy is allow; false if default egress policy is deny")
+ @Param(description = "True if guest Network default egress policy is allow; false if default egress policy is deny")
private Boolean egressDefaultPolicy;
@SerializedName(ApiConstants.INTERNET_PROTOCOL)
- @Param(description = "The internet protocol of network offering")
+ @Param(description = "The internet protocol of Network offering")
private String internetProtocol;
@SerializedName(ApiConstants.IPV6_ROUTING)
- @Param(description = "The Ipv6 routing type of network offering", since = "4.17.0")
+ @Param(description = "The IPv6 routing type of network offering", since = "4.17.0")
private String ipv6Routing;
@SerializedName(ApiConstants.IPV6_ROUTES)
- @Param(description = "The routes for the network to ease adding route in upstream router", since = "4.17.0")
+ @Param(description = "The routes for the Network to ease adding route in upstream router", since = "4.17.0")
private Set ipv6Routes;
@SerializedName(ApiConstants.PUBLIC_MTU)
- @Param(description = "MTU configured on the network VR's public facing interfaces")
+ @Param(description = "MTU configured on the Network VR's public facing interfaces")
private Integer publicMtu;
@SerializedName(ApiConstants.PRIVATE_MTU)
@@ -320,11 +320,11 @@ public class NetworkResponse extends BaseResponseWithAssociatedNetwork implement
private Integer privateMtu;
@SerializedName(ApiConstants.IP6_DNS1)
- @Param(description = "the first IPv6 DNS for the network", since = "4.18.0")
+ @Param(description = "The first IPv6 DNS for the network", since = "4.18.0")
private String ipv6Dns1;
@SerializedName(ApiConstants.IP6_DNS2)
- @Param(description = "the second IPv6 DNS for the network", since = "4.18.0")
+ @Param(description = "The second IPv6 DNS for the network", since = "4.18.0")
private String ipv6Dns2;
@SerializedName(ApiConstants.IPV4_ROUTING)
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/NicExtraDhcpOptionResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/NicExtraDhcpOptionResponse.java
index 4af89a37d8d..7d000737368 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/NicExtraDhcpOptionResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/NicExtraDhcpOptionResponse.java
@@ -28,23 +28,23 @@ import com.cloud.serializer.Param;
public class NicExtraDhcpOptionResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the extra dhcp option")
+ @Param(description = "The ID of the extra DHCP option")
private String id;
@SerializedName(ApiConstants.NIC_ID)
- @Param(description = "the ID of the nic")
+ @Param(description = "The ID of the NIC")
private String nicId;
@SerializedName(ApiConstants.EXTRA_DHCP_OPTION_NAME)
- @Param(description = "the name of the extra DHCP option")
+ @Param(description = "The name of the extra DHCP option")
private String codeName;
@SerializedName(ApiConstants.EXTRA_DHCP_OPTION_CODE)
- @Param(description = "the extra DHCP option code")
+ @Param(description = "The extra DHCP option code")
private int code;
@SerializedName(ApiConstants.EXTRA_DHCP_OPTION_VALUE)
- @Param(description = "the extra DHCP option value")
+ @Param(description = "The extra DHCP option value")
private String value;
public NicExtraDhcpOptionResponse() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/NicResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/NicResponse.java
index 65e126de545..f992514b8db 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/NicResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/NicResponse.java
@@ -31,79 +31,79 @@ import com.google.gson.annotations.SerializedName;
public class NicResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the nic")
+ @Param(description = "The ID of the NIC")
private String id;
@SerializedName(ApiConstants.NETWORK_ID)
- @Param(description = "the ID of the corresponding network")
+ @Param(description = "The ID of the corresponding Network")
private String networkId;
@SerializedName(ApiConstants.NETWORK_NAME)
- @Param(description = "the name of the corresponding network")
+ @Param(description = "The name of the corresponding Network")
private String networkName;
@SerializedName(ApiConstants.NETMASK)
- @Param(description = "the netmask of the nic")
+ @Param(description = "The netmask of the NIC")
private String netmask;
@SerializedName(ApiConstants.GATEWAY)
- @Param(description = "the gateway of the nic")
+ @Param(description = "The gateway of the NIC")
private String gateway;
@SerializedName(ApiConstants.IP_ADDRESS)
- @Param(description = "the ip address of the nic")
+ @Param(description = "The IP address of the NIC")
private String ipaddress;
@SerializedName(ApiConstants.ISOLATION_URI)
- @Param(description = "the isolation uri of the nic")
+ @Param(description = "The isolation URI of the NIC")
private String isolationUri;
@SerializedName(ApiConstants.BROADCAST_URI)
- @Param(description = "the broadcast uri of the nic")
+ @Param(description = "The broadcast URI of the NIC")
private String broadcastUri;
@SerializedName(ApiConstants.TRAFFIC_TYPE)
- @Param(description = "the traffic type of the nic")
+ @Param(description = "The traffic type of the NIC")
private String trafficType;
@SerializedName(ApiConstants.TYPE)
- @Param(description = "the type of the nic")
+ @Param(description = "The type of the NIC")
private String type;
@SerializedName(ApiConstants.IS_DEFAULT)
- @Param(description = "true if nic is default, false otherwise")
+ @Param(description = "True if NIC is default, false otherwise")
private Boolean isDefault;
@SerializedName(ApiConstants.MAC_ADDRESS)
- @Param(description = "true if nic is default, false otherwise")
+ @Param(description = "True if NIC is default, false otherwise")
private String macAddress;
@SerializedName(ApiConstants.IP6_GATEWAY)
- @Param(description = "the gateway of IPv6 network")
+ @Param(description = "The gateway of IPv6 Network")
private String ip6Gateway;
@SerializedName(ApiConstants.IP6_CIDR)
- @Param(description = "the cidr of IPv6 network")
+ @Param(description = "The CIDR of IPv6 Network")
private String ip6Cidr;
@SerializedName(ApiConstants.IP6_ADDRESS)
- @Param(description = "the IPv6 address of network")
+ @Param(description = "The IPv6 address of Network")
private String ip6Address;
@SerializedName(ApiConstants.SECONDARY_IP)
- @Param(description = "the Secondary ipv4 addr of nic")
+ @Param(description = "The Secondary IPv4 addr of NIC")
private List secondaryIps;
@SerializedName(ApiConstants.EXTRA_DHCP_OPTION)
- @Param(description = "the extra dhcp options on the nic", since = "4.11.0")
+ @Param(description = "The extra DHCP options on the NIC", since = "4.11.0")
private List extraDhcpOptions;
@SerializedName(ApiConstants.DEVICE_ID)
- @Param(description = "device id for the network when plugged into the virtual machine", since = "4.4")
+ @Param(description = "Device ID for the Network when plugged into the Instance", since = "4.4")
private String deviceId;
@SerializedName(ApiConstants.VIRTUAL_MACHINE_ID)
- @Param(description = "Id of the vm to which the nic belongs")
+ @Param(description = "Id of the Instance to which the NIC belongs")
private String vmId;
@SerializedName(ApiConstants.NSX_LOGICAL_SWITCH)
@@ -119,11 +119,11 @@ public class NicResponse extends BaseResponse {
private Integer vlanId;
@SerializedName(ApiConstants.ISOLATED_PVLAN)
- @Param(description = "the isolated private VLAN if available", since="4.14.0")
+ @Param(description = "The isolated private VLAN if available", since="4.14.0")
private Integer isolatedPvlanId;
@SerializedName(ApiConstants.ISOLATED_PVLAN_TYPE)
- @Param(description = "the isolated private VLAN type if available", since="4.14.0")
+ @Param(description = "The isolated private VLAN type if available", since="4.14.0")
private String isolatedPvlanType;
@SerializedName(ApiConstants.ADAPTER_TYPE)
@@ -131,7 +131,7 @@ public class NicResponse extends BaseResponse {
private String adapterType;
@SerializedName(ApiConstants.IP_ADDRESSES)
- @Param(description = "IP addresses associated with NIC found for unmanaged VM", since="4.14.0")
+ @Param(description = "IP addresses associated with NIC found for unmanaged Instance", since="4.14.0")
private List ipAddresses;
@SerializedName(ApiConstants.MTU)
@@ -139,11 +139,11 @@ public class NicResponse extends BaseResponse {
private Integer mtu;
@SerializedName(ApiConstants.PUBLIC_IP_ID)
- @Param(description = "public IP address id associated with this nic via Static nat rule")
+ @Param(description = "Public IP address ID associated with this NIC via Static NAT rule")
private String publicIpId;
@SerializedName(ApiConstants.PUBLIC_IP)
- @Param(description = "public IP address associated with this nic via Static nat rule")
+ @Param(description = "Public IP address associated with this NIC via Static NAT rule")
private String publicIp;
public void setVmId(String vmId) {
@@ -223,11 +223,11 @@ public class NicResponse extends BaseResponse {
}
@SerializedName(ApiConstants.VPC_ID)
- @Param(description = "Id of the vpc to which the nic belongs")
+ @Param(description = "ID of the VPC to which the NIC belongs")
private String vpcId;
@SerializedName(ApiConstants.VPC_NAME)
- @Param(description = "name of the vpc to which the nic belongs")
+ @Param(description = "Name of the VPC to which the NIC belongs")
private String vpcName;
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/NicSecondaryIpResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/NicSecondaryIpResponse.java
index 467a1c9e987..eba00da25cf 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/NicSecondaryIpResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/NicSecondaryIpResponse.java
@@ -30,11 +30,11 @@ import com.cloud.vm.NicSecondaryIp;
public class NicSecondaryIpResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the secondary private IP addr")
+ @Param(description = "The ID of the secondary private IP addr")
private String id;
@SerializedName("secondaryip")
- @Param(description = "the list of Secondary ipv4 addr of nic")
+ @Param(description = "The list of Secondary IPv4 addr of NIC")
private List secondaryIpsList;
@SerializedName(ApiConstants.IP_ADDRESS)
@@ -42,15 +42,15 @@ public class NicSecondaryIpResponse extends BaseResponse {
private String ipAddr;
@SerializedName(ApiConstants.NIC_ID)
- @Param(description = "the ID of the nic")
+ @Param(description = "The ID of the NIC")
private String nicId;
@SerializedName(ApiConstants.NETWORK_ID)
- @Param(description = "the ID of the network")
+ @Param(description = "The ID of the Network")
private String nwId;
@SerializedName(ApiConstants.VIRTUAL_MACHINE_ID)
- @Param(description = "the ID of the vm")
+ @Param(description = "The ID of the Instance")
private String vmId;
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/OutOfBandManagementResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/OutOfBandManagementResponse.java
index 3a8f5fb55ab..5ce75e44efa 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/OutOfBandManagementResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/OutOfBandManagementResponse.java
@@ -28,47 +28,47 @@ import org.apache.commons.lang3.StringUtils;
@EntityReference(value = Host.class)
public class OutOfBandManagementResponse extends BaseResponse {
@SerializedName(ApiConstants.HOST_ID)
- @Param(description = "the ID of the host")
+ @Param(description = "The ID of the host")
private String id;
@SerializedName(ApiConstants.POWER_STATE)
- @Param(description = "the out-of-band management interface powerState of the host")
+ @Param(description = "The out-of-band management interface powerState of the host")
private OutOfBandManagement.PowerState powerState;
@SerializedName(ApiConstants.ENABLED)
- @Param(description = "true if out-of-band management is enabled for the host")
+ @Param(description = "True if out-of-band management is enabled for the host")
private Boolean enabled;
@SerializedName(ApiConstants.DRIVER)
- @Param(description = "the out-of-band management driver for the host")
+ @Param(description = "The out-of-band management driver for the host")
private String driver;
@SerializedName(ApiConstants.ADDRESS)
- @Param(description = "the out-of-band management interface address")
+ @Param(description = "The out-of-band management interface address")
private String ipAddress;
@SerializedName(ApiConstants.PORT)
- @Param(description = "the out-of-band management interface port")
+ @Param(description = "The out-of-band management interface port")
private String port;
@SerializedName(ApiConstants.USERNAME)
- @Param(description = "the out-of-band management interface username")
+ @Param(description = "The out-of-band management interface username")
private String username;
@SerializedName(ApiConstants.PASSWORD)
- @Param(description = "the out-of-band management interface password")
+ @Param(description = "The out-of-band management interface password")
private String password;
@SerializedName(ApiConstants.ACTION)
- @Param(description = "the out-of-band management action (if issued)")
+ @Param(description = "The out-of-band management action (if issued)")
private String outOfBandManagementAction;
@SerializedName(ApiConstants.DESCRIPTION)
- @Param(description = "the operation result description")
+ @Param(description = "The operation result description")
private String resultDescription;
@SerializedName(ApiConstants.STATUS)
- @Param(description = "the operation result")
+ @Param(description = "The operation result")
private Boolean success;
public OutOfBandManagementResponse() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/OvsProviderResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/OvsProviderResponse.java
index 2b67e1618dc..9ed7247e403 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/OvsProviderResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/OvsProviderResponse.java
@@ -29,33 +29,33 @@ import com.google.gson.annotations.SerializedName;
public class OvsProviderResponse extends BaseResponse implements
ControlledEntityResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the id of the ovs")
+ @Param(description = "The ID of the ovs")
private String id;
@SerializedName(ApiConstants.NSP_ID)
- @Param(description = "the physical network service provider id of the provider")
+ @Param(description = "The physical Network service provider id of the provider")
private String nspId;
@SerializedName(ApiConstants.ENABLED)
@Param(description = "Enabled/Disabled the service provider")
private Boolean enabled;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account associated with the provider")
+ @Param(description = "The Account associated with the provider")
private String accountName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the ipaddress")
+ @Param(description = "The project ID of the IP address")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the address")
+ @Param(description = "The project name of the address")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain ID associated with the provider")
+ @Param(description = "The domain ID associated with the provider")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain associated with the provider")
+ @Param(description = "The domain associated with the provider")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
- @Param(description = "path of the domain to which the provider belongs", since = "4.19.2.0")
+ @Param(description = "Path of the domain to which the provider belongs", since = "4.19.2.0")
private String domainPath;
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/PhysicalNetworkResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/PhysicalNetworkResponse.java
index f5116829305..46cf233e279 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/PhysicalNetworkResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/PhysicalNetworkResponse.java
@@ -32,47 +32,47 @@ import com.cloud.serializer.Param;
public class PhysicalNetworkResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the uuid of the physical network")
+ @Param(description = "The UUID of the physical Network")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "name of the physical network")
+ @Param(description = "Name of the physical Network")
private String name;
@SerializedName(ApiConstants.BROADCAST_DOMAIN_RANGE)
- @Param(description = "Broadcast domain range of the physical network")
+ @Param(description = "Broadcast domain range of the physical Network")
private String broadcastDomainRange;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "zone id of the physical network")
+ @Param(description = "Zone ID of the physical Network")
private String zoneId;
@SerializedName(ApiConstants.ZONE_NAME)
- @Param(description = "zone name of the physical network")
+ @Param(description = "Zone name of the physical Network")
private String zoneName;
@SerializedName(ApiConstants.STATE)
- @Param(description = "state of the physical network")
+ @Param(description = "State of the physical Network")
private String state;
@SerializedName(ApiConstants.VLAN)
- @Param(description = "the vlan of the physical network")
+ @Param(description = "The VLAN of the physical Network")
private String vlan;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain id of the physical network owner")
+ @Param(description = "The domain ID of the physical Network owner")
private String domainId;
@SerializedName(ApiConstants.TAGS)
- @Param(description = "comma separated tag")
+ @Param(description = "Comma separated tag")
private String tags;
@SerializedName(ApiConstants.ISOLATION_METHODS)
- @Param(description = "isolation methods")
+ @Param(description = "Isolation methods")
private String isolationMethods;
@SerializedName(ApiConstants.NETWORK_SPEED)
- @Param(description = "the speed of the physical network")
+ @Param(description = "The speed of the physical Network")
private String networkSpeed;
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/PodResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/PodResponse.java
index 587fabfae8d..2a4a33b2e46 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/PodResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/PodResponse.java
@@ -30,59 +30,59 @@ import com.cloud.serializer.Param;
@EntityReference(value = Pod.class)
public class PodResponse extends BaseResponseWithAnnotations {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the Pod")
+ @Param(description = "The ID of the Pod")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the Pod")
+ @Param(description = "The name of the Pod")
private String name;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "the Zone ID of the Pod")
+ @Param(description = "The Zone ID of the Pod")
private String zoneId;
@SerializedName(ApiConstants.ZONE_NAME)
- @Param(description = "the Zone name of the Pod")
+ @Param(description = "The Zone name of the Pod")
private String zoneName;
@SerializedName(ApiConstants.GATEWAY)
- @Param(description = "the gateway of the Pod")
+ @Param(description = "The gateway of the Pod")
private String gateway;
@SerializedName(ApiConstants.NETMASK)
- @Param(description = "the netmask of the Pod")
+ @Param(description = "The netmask of the Pod")
private String netmask;
@SerializedName(ApiConstants.IP_RANGES)
- @Param(description = "the IP ranges for the Pod", responseObject = IpRangeResponse.class, since = "4.16.0")
+ @Param(description = "The IP ranges for the Pod", responseObject = IpRangeResponse.class, since = "4.16.0")
private List ipRanges;
@Deprecated(since = "4.16")
@SerializedName(ApiConstants.START_IP)
- @Param(description = "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.")
+ @Param(description = "The starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.")
private List startIp;
@Deprecated(since = "4.16")
@SerializedName(ApiConstants.END_IP)
- @Param(description = "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.")
+ @Param(description = "The ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.")
private List endIp;
@Deprecated(since = "4.16")
@SerializedName(ApiConstants.FOR_SYSTEM_VMS)
- @Param(description = "indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.")
+ @Param(description = "Indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.")
private List forSystemVms;
@Deprecated(since = "4.16")
@SerializedName(ApiConstants.VLAN_ID)
- @Param(description = "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.")
+ @Param(description = "Indicates VLAN ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.")
private List vlanId;
@SerializedName(ApiConstants.ALLOCATION_STATE)
- @Param(description = "the allocation state of the Pod")
+ @Param(description = "The allocation state of the Pod")
private String allocationState;
@SerializedName(ApiConstants.CAPACITY)
- @Param(description = "the capacity of the Pod", responseObject = CapacityResponse.class)
+ @Param(description = "The capacity of the Pod", responseObject = CapacityResponse.class)
private List capacities;
public String getId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/PortableIpRangeResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/PortableIpRangeResponse.java
index ddb2f9052d8..45316c8b642 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/PortableIpRangeResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/PortableIpRangeResponse.java
@@ -32,31 +32,31 @@ import com.cloud.serializer.Param;
public class PortableIpRangeResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "portable IP range ID")
+ @Param(description = "Portable IP range ID")
private String id;
@SerializedName(ApiConstants.REGION_ID)
- @Param(description = "Region Id in which portable ip range is provisioned")
+ @Param(description = "Region ID in which portable IP range is provisioned")
private Integer regionId;
@SerializedName(ApiConstants.GATEWAY)
- @Param(description = "the gateway of the VLAN IP range")
+ @Param(description = "The gateway of the VLAN IP range")
private String gateway;
@SerializedName(ApiConstants.NETMASK)
- @Param(description = "the netmask of the VLAN IP range")
+ @Param(description = "The netmask of the VLAN IP range")
private String netmask;
@SerializedName(ApiConstants.VLAN)
- @Param(description = "the ID or VID of the VLAN.")
+ @Param(description = "The ID or VID of the VLAN.")
private String vlan;
@SerializedName(ApiConstants.START_IP)
- @Param(description = "the start ip of the portable IP range")
+ @Param(description = "The start IP of the portable IP range")
private String startIp;
@SerializedName(ApiConstants.END_IP)
- @Param(description = "the end ip of the portable IP range")
+ @Param(description = "The end IP of the portable IP range")
private String endIp;
@SerializedName(ApiConstants.PORTABLE_IP_ADDRESS)
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/PortableIpResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/PortableIpResponse.java
index e477b111561..98279aaa1c5 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/PortableIpResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/PortableIpResponse.java
@@ -32,43 +32,43 @@ import com.cloud.serializer.Param;
public class PortableIpResponse extends BaseResponse {
@SerializedName(ApiConstants.REGION_ID)
- @Param(description = "Region Id in which global load balancer is created")
+ @Param(description = "Region ID in which global Load balancer is created")
private Integer regionId;
@SerializedName(ApiConstants.IP_ADDRESS)
- @Param(description = "public IP address")
+ @Param(description = "Public IP address")
private String ipAddress;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "the ID of the zone the public IP address belongs to")
+ @Param(description = "The ID of the zone the public IP address belongs to")
private String zoneId;
@SerializedName(ApiConstants.NETWORK_ID)
- @Param(description = "the ID of the Network where ip belongs to")
+ @Param(description = "The ID of the Network where IP belongs to")
private String networkId;
@SerializedName(ApiConstants.VPC_ID)
- @Param(description = "VPC the ip belongs to")
+ @Param(description = "VPC the IP belongs to")
private String vpcId;
@SerializedName(ApiConstants.PHYSICAL_NETWORK_ID)
- @Param(description = "the physical network this belongs to")
+ @Param(description = "The physical Network this belongs to")
private String physicalNetworkId;
@SerializedName(ApiConstants.ACCOUNT_ID)
- @Param(description = "the account ID the portable IP address is associated with")
+ @Param(description = "The Account ID the portable IP address is associated with")
private String accountId;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain ID the portable IP address is associated with")
+ @Param(description = "The domain ID the portable IP address is associated with")
private String domainId;
@SerializedName("allocated")
- @Param(description = "date the portal IP address was acquired")
+ @Param(description = "Date the portal IP address was acquired")
private Date allocated;
@SerializedName(ApiConstants.STATE)
- @Param(description = "State of the ip address. Can be: Allocating, Allocated, Releasing and Free")
+ @Param(description = "State of the IP address. Can be: Allocating, Allocated, Releasing and Free")
private String state;
public void setRegionId(Integer regionId) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/PrivateGatewayResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/PrivateGatewayResponse.java
index 414aed94bad..7a6d443c14a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/PrivateGatewayResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/PrivateGatewayResponse.java
@@ -30,35 +30,35 @@ import com.cloud.serializer.Param;
public class PrivateGatewayResponse extends BaseResponseWithAssociatedNetwork implements ControlledEntityResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the id of the private gateway")
+ @Param(description = "The ID of the private gateway")
private String id;
@SerializedName(ApiConstants.GATEWAY)
- @Param(description = "the gateway")
+ @Param(description = "The gateway")
private String gateway;
@SerializedName(ApiConstants.NETMASK)
- @Param(description = "the private gateway's netmask")
+ @Param(description = "The private gateway's netmask")
private String netmask;
@SerializedName(ApiConstants.IP_ADDRESS)
- @Param(description = "the private gateway's ip address")
+ @Param(description = "The private gateway's IP address")
private String address;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "zone id of the private gateway")
+ @Param(description = "Zone ID of the private gateway")
private String zoneId;
@SerializedName(ApiConstants.ZONE_NAME)
- @Param(description = "the name of the zone the private gateway belongs to")
+ @Param(description = "The name of the zone the private gateway belongs to")
private String zoneName;
@SerializedName(ApiConstants.VLAN)
- @Param(description = "the network implementation uri for the private gateway")
+ @Param(description = "The Network implementation uri for the private gateway")
private String broadcastUri;
@SerializedName(ApiConstants.VPC_ID)
- @Param(description = "VPC id the private gateway belongs to")
+ @Param(description = "VPC ID the private gateway belongs to")
private String vpcId;
@SerializedName(ApiConstants.VPC_NAME)
@@ -66,31 +66,31 @@ public class PrivateGatewayResponse extends BaseResponseWithAssociatedNetwork im
private String vpcName;
@SerializedName(ApiConstants.PHYSICAL_NETWORK_ID)
- @Param(description = "the physical network id")
+ @Param(description = "The physical Network id")
private String physicalNetworkId;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account associated with the private gateway")
+ @Param(description = "The Account associated with the private gateway")
private String accountName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the private gateway")
+ @Param(description = "The project ID of the private gateway")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the private gateway")
+ @Param(description = "The project name of the private gateway")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the ID of the domain associated with the private gateway")
+ @Param(description = "The ID of the domain associated with the private gateway")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain associated with the private gateway")
+ @Param(description = "The domain associated with the private gateway")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
- @Param(description = "path of the domain to which the private gateway belongs", since = "4.19.2.0")
+ @Param(description = "Path of the domain to which the private gateway belongs", since = "4.19.2.0")
private String domainPath;
@SerializedName(ApiConstants.STATE)
@@ -102,7 +102,7 @@ public class PrivateGatewayResponse extends BaseResponseWithAssociatedNetwork im
private Boolean sourceNat;
@SerializedName(ApiConstants.ACL_ID)
- @Param(description = "ACL Id set for private gateway")
+ @Param(description = "ACL ID set for private gateway")
private String aclId;
@SerializedName(ApiConstants.ACL_NAME)
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ProjectAccountResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ProjectAccountResponse.java
index d035622f65f..89e0c38a48e 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ProjectAccountResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ProjectAccountResponse.java
@@ -30,19 +30,19 @@ import com.google.gson.annotations.SerializedName;
@SuppressWarnings("unused")
public class ProjectAccountResponse extends BaseResponse implements ControlledViewEntityResponse {
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "project id")
+ @Param(description = "Project ID")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "project name")
+ @Param(description = "Project name")
private String projectName;
@SerializedName(ApiConstants.ACCOUNT_ID)
- @Param(description = "the id of the account")
+ @Param(description = "The ID of the Account")
private String accountId;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the name of the account")
+ @Param(description = "The name of the Account")
private String accountName;
@SerializedName(ApiConstants.USERNAME)
@@ -50,35 +50,35 @@ public class ProjectAccountResponse extends BaseResponse implements ControlledVi
private String username;
@SerializedName(ApiConstants.ACCOUNT_TYPE)
- @Param(description = "account type (admin, domain-admin, user)")
+ @Param(description = "Account type (admin, domain-admin, user)")
private Integer accountType;
@SerializedName(ApiConstants.USER_ID)
- @Param(description = "Id of the user")
+ @Param(description = "ID of the user")
private String userId;
@SerializedName(ApiConstants.PROJECT_ROLE_ID)
- @Param(description = "Id of the project role associated with the account/user")
+ @Param(description = "ID of the project role associated with the Account/User")
private String projectRoleId;
@SerializedName(ApiConstants.ROLE)
- @Param(description = "account role in the project (regular,owner)")
+ @Param(description = "Account role in the project (regular, owner)")
private String role;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "id of the Domain the account belongs too")
+ @Param(description = "ID of the Domain the Account belongs too")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "name of the Domain the account belongs too")
+ @Param(description = "Name of the Domain the Account belongs too")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
- @Param(description = "path of the Domain the account belongs to", since = "4.19.2.0")
+ @Param(description = "Path of the Domain the Account belongs to", since = "4.19.2.0")
private String domainPath;
@SerializedName(ApiConstants.USER)
- @Param(description = "the list of users associated with account", responseObject = UserResponse.class)
+ @Param(description = "The list of users associated with Account", responseObject = UserResponse.class)
private List users;
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ProjectInvitationResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ProjectInvitationResponse.java
index ad3f99f6b3f..c99e3edf6db 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ProjectInvitationResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ProjectInvitationResponse.java
@@ -28,43 +28,43 @@ import com.google.gson.annotations.SerializedName;
@SuppressWarnings("unused")
public class ProjectInvitationResponse extends BaseResponse implements ControlledViewEntityResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the id of the invitation")
+ @Param(description = "The ID of the invitation")
private String id;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the id of the project")
+ @Param(description = "The ID of the project")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the name of the project")
+ @Param(description = "The name of the project")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain id the project belongs to")
+ @Param(description = "The domain ID the project belongs to")
private String domainId;
@SerializedName(ApiConstants.USER_ID)
- @Param(description = "the User ID")
+ @Param(description = "The User ID")
private String userId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain name where the project belongs to")
+ @Param(description = "The domain name where the project belongs to")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
- @Param(description = "path of the Domain the project belongs to", since = "4.19.2.0")
+ @Param(description = "Path of the Domain the project belongs to", since = "4.19.2.0")
private String domainPath;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account name of the project's owner")
+ @Param(description = "The Account name of the project's owner")
private String accountName;
@SerializedName(ApiConstants.EMAIL)
- @Param(description = "the email the invitation was sent to")
+ @Param(description = "The email the invitation was sent to")
private String email;
@SerializedName(ApiConstants.STATE)
- @Param(description = "the invitation state")
+ @Param(description = "The invitation state")
private String invitationState;
public void setId(String id) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ProjectResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ProjectResponse.java
index 1c63697559b..ee40e9d3918 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ProjectResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ProjectResponse.java
@@ -33,179 +33,179 @@ import com.google.gson.annotations.SerializedName;
public class ProjectResponse extends BaseResponse implements ResourceLimitAndCountResponse, SetResourceIconResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the id of the project")
+ @Param(description = "The ID of the project")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the project")
+ @Param(description = "The name of the project")
private String name;
@SerializedName(ApiConstants.DISPLAY_TEXT)
- @Param(description = "the displaytext of the project")
+ @Param(description = "The displaytext of the project")
private String displaytext;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain id the project belongs to")
+ @Param(description = "The domain ID the project belongs to")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain name where the project belongs to")
+ @Param(description = "The domain name where the project belongs to")
private String domain;
@SerializedName(ApiConstants.OWNER)
- @Param(description = "the account name of the project's owners")
+ @Param(description = "The Account name of the project's owners")
private List> owners;
@SerializedName("projectaccountname")
- @Param(description="the project account name of the project")
+ @Param(description = "The project Account name of the project")
private String projectAccountName;
@SerializedName(ApiConstants.STATE)
- @Param(description = "the state of the project")
+ @Param(description = "The state of the project")
private String state;
@SerializedName(ApiConstants.TAGS)
- @Param(description = "the list of resource tags associated with vm", responseObject = ResourceTagResponse.class)
+ @Param(description = "The list of resource tags associated with Instance", responseObject = ResourceTagResponse.class)
private List tags = new ArrayList();
@SerializedName("networklimit")
- @Param(description = "the total number of networks the project can own", since = "4.2.0")
+ @Param(description = "The total number of Networks the project can own", since = "4.2.0")
private String networkLimit;
@SerializedName("networktotal")
- @Param(description = "the total number of networks owned by project", since = "4.2.0")
+ @Param(description = "The total number of Networks owned by project", since = "4.2.0")
private Long networkTotal;
@SerializedName("networkavailable")
- @Param(description = "the total number of networks available to be created for this project", since = "4.2.0")
+ @Param(description = "The total number of Networks available to be created for this project", since = "4.2.0")
private String networkAvailable;
@SerializedName("vpclimit")
- @Param(description = "the total number of vpcs the project can own", since = "4.2.0")
+ @Param(description = "The total number of VPCs the project can own", since = "4.2.0")
private String vpcLimit;
@SerializedName("vpctotal")
- @Param(description = "the total number of vpcs owned by project", since = "4.2.0")
+ @Param(description = "The total number of VPCs owned by project", since = "4.2.0")
private Long vpcTotal;
@SerializedName("vpcavailable")
- @Param(description = "the total number of vpcs available to be created for this project", since = "4.2.0")
+ @Param(description = "The total number of VPCs available to be created for this project", since = "4.2.0")
private String vpcAvailable;
@SerializedName("cpulimit")
- @Param(description = "the total number of cpu cores the project can own", since = "4.2.0")
+ @Param(description = "The total number of CPU cores the project can own", since = "4.2.0")
private String cpuLimit;
@SerializedName("cputotal")
- @Param(description = "the total number of cpu cores owned by project", since = "4.2.0")
+ @Param(description = "The total number of CPU cores owned by project", since = "4.2.0")
private Long cpuTotal;
@SerializedName("cpuavailable")
- @Param(description = "the total number of cpu cores available to be created for this project", since = "4.2.0")
+ @Param(description = "The total number of CPU cores available to be created for this project", since = "4.2.0")
private String cpuAvailable;
@SerializedName("memorylimit")
- @Param(description = "the total memory (in MB) the project can own", since = "4.2.0")
+ @Param(description = "The total memory (in MB) the project can own", since = "4.2.0")
private String memoryLimit;
@SerializedName("memorytotal")
- @Param(description = "the total memory (in MB) owned by project", since = "4.2.0")
+ @Param(description = "The total memory (in MB) owned by project", since = "4.2.0")
private Long memoryTotal;
@SerializedName("memoryavailable")
- @Param(description = "the total memory (in MB) available to be created for this project", since = "4.2.0")
+ @Param(description = "The total memory (in MB) available to be created for this project", since = "4.2.0")
private String memoryAvailable;
@SerializedName("primarystoragelimit")
- @Param(description = "the total primary storage space (in GiB) the project can own", since = "4.2.0")
+ @Param(description = "The total primary storage space (in GiB) the project can own", since = "4.2.0")
private String primaryStorageLimit;
@SerializedName("primarystoragetotal")
- @Param(description = "the total primary storage space (in GiB) owned by project", since = "4.2.0")
+ @Param(description = "The total primary storage space (in GiB) owned by project", since = "4.2.0")
private Long primaryStorageTotal;
@SerializedName("primarystorageavailable")
- @Param(description = "the total primary storage space (in GiB) available to be used for this project", since = "4.2.0")
+ @Param(description = "The total primary storage space (in GiB) available to be used for this project", since = "4.2.0")
private String primaryStorageAvailable;
@SerializedName("secondarystoragelimit")
- @Param(description = "the total secondary storage space (in GiB) the project can own", since = "4.2.0")
+ @Param(description = "The total secondary storage space (in GiB) the project can own", since = "4.2.0")
private String secondaryStorageLimit;
@SerializedName("secondarystoragetotal")
- @Param(description = "the total secondary storage space (in GiB) owned by project", since = "4.2.0")
+ @Param(description = "The total secondary storage space (in GiB) owned by project", since = "4.2.0")
private float secondaryStorageTotal;
@SerializedName("secondarystorageavailable")
- @Param(description = "the total secondary storage space (in GiB) available to be used for this project", since = "4.2.0")
+ @Param(description = "The total secondary storage space (in GiB) available to be used for this project", since = "4.2.0")
private String secondaryStorageAvailable;
@SerializedName(ApiConstants.VM_LIMIT)
- @Param(description = "the total number of virtual machines that can be deployed by this project", since = "4.2.0")
+ @Param(description = "The total number of Instances that can be deployed by this project", since = "4.2.0")
private String vmLimit;
@SerializedName(ApiConstants.VM_TOTAL)
- @Param(description = "the total number of virtual machines deployed by this project", since = "4.2.0")
+ @Param(description = "The total number of Instances deployed by this project", since = "4.2.0")
private Long vmTotal;
@SerializedName(ApiConstants.VM_AVAILABLE)
- @Param(description = "the total number of virtual machines available for this project to acquire", since = "4.2.0")
+ @Param(description = "The total number of Instances available for this project to acquire", since = "4.2.0")
private String vmAvailable;
@SerializedName(ApiConstants.IP_LIMIT)
- @Param(description = "the total number of public ip addresses this project can acquire", since = "4.2.0")
+ @Param(description = "The total number of public IP addresses this project can acquire", since = "4.2.0")
private String ipLimit;
@SerializedName(ApiConstants.IP_TOTAL)
- @Param(description = "the total number of public ip addresses allocated for this project", since = "4.2.0")
+ @Param(description = "The total number of public IP addresses allocated for this project", since = "4.2.0")
private Long ipTotal;
@SerializedName(ApiConstants.IP_AVAILABLE)
- @Param(description = "the total number of public ip addresses available for this project to acquire", since = "4.2.0")
+ @Param(description = "The total number of public IP addresses available for this project to acquire", since = "4.2.0")
private String ipAvailable;
@SerializedName("volumelimit")
- @Param(description = "the total volume which can be used by this project", since = "4.2.0")
+ @Param(description = "The total volume which can be used by this project", since = "4.2.0")
private String volumeLimit;
@SerializedName("volumetotal")
- @Param(description = "the total volume being used by this project", since = "4.2.0")
+ @Param(description = "The total volume being used by this project", since = "4.2.0")
private Long volumeTotal;
@SerializedName("volumeavailable")
- @Param(description = "the total volume available for this project", since = "4.2.0")
+ @Param(description = "The total volume available for this project", since = "4.2.0")
private String volumeAvailable;
@SerializedName("snapshotlimit")
- @Param(description = "the total number of snapshots which can be stored by this project", since = "4.2.0")
+ @Param(description = "The total number of Snapshots which can be stored by this project", since = "4.2.0")
private String snapshotLimit;
@SerializedName("snapshottotal")
- @Param(description = "the total number of snapshots stored by this project", since = "4.2.0")
+ @Param(description = "The total number of Snapshots stored by this project", since = "4.2.0")
private Long snapshotTotal;
@SerializedName("snapshotavailable")
- @Param(description = "the total number of snapshots available for this project", since = "4.2.0")
+ @Param(description = "The total number of Snapshots available for this project", since = "4.2.0")
private String snapshotAvailable;
@SerializedName("templatelimit")
- @Param(description = "the total number of templates which can be created by this project", since = "4.2.0")
+ @Param(description = "The total number of Templates which can be created by this project", since = "4.2.0")
private String templateLimit;
@SerializedName("templatetotal")
- @Param(description = "the total number of templates which have been created by this project", since = "4.2.0")
+ @Param(description = "The total number of Templates which have been created by this project", since = "4.2.0")
private Long templateTotal;
@SerializedName("templateavailable")
- @Param(description = "the total number of templates available to be created by this project", since = "4.2.0")
+ @Param(description = "The total number of Templates available to be created by this project", since = "4.2.0")
private String templateAvailable;
@SerializedName("vmstopped")
- @Param(description = "the total number of virtual machines stopped for this project", since = "4.2.0")
+ @Param(description = "The total number of Instances stopped for this project", since = "4.2.0")
private Integer vmStopped;
@SerializedName("vmrunning")
- @Param(description = "the total number of virtual machines running for this project", since = "4.2.0")
+ @Param(description = "The total number of Instances running for this project", since = "4.2.0")
private Integer vmRunning;
@SerializedName(ApiConstants.RESOURCE_ICON)
@@ -213,7 +213,7 @@ public class ProjectResponse extends BaseResponse implements ResourceLimitAndCou
ResourceIconResponse icon;
@SerializedName(ApiConstants.CREATED)
- @Param(description = "the date this project was created", since = "4.16.0")
+ @Param(description = "The date this project was created", since = "4.16.0")
private Date created;
@SerializedName(ApiConstants.TAGGED_RESOURCES)
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ProjectRolePermissionResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ProjectRolePermissionResponse.java
index 91b2036d3e6..55abd80c59b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ProjectRolePermissionResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ProjectRolePermissionResponse.java
@@ -27,19 +27,19 @@ import com.google.gson.annotations.SerializedName;
@EntityReference(value = ProjectRolePermission.class)
public class ProjectRolePermissionResponse extends BaseRolePermissionResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the project role permission")
+ @Param(description = "The ID of the project role permission")
private String id;
@SerializedName(ApiConstants.PROJECT_ROLE_ID)
- @Param(description = "the ID of the project role to which the role permission belongs")
+ @Param(description = "The ID of the project role to which the role permission belongs")
private String projectRoleId;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the ID of the project")
+ @Param(description = "The ID of the project")
private String projectId;
@SerializedName(ApiConstants.PROJECT_ROLE_NAME)
- @Param(description = "the name of the project role to which the role permission belongs")
+ @Param(description = "The name of the project role to which the role permission belongs")
private String projectRoleName;
public String getId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ProjectRoleResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ProjectRoleResponse.java
index 230329f0ee1..05df8d635ae 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ProjectRoleResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ProjectRoleResponse.java
@@ -27,7 +27,7 @@ import com.google.gson.annotations.SerializedName;
@EntityReference(value = ProjectRole.class)
public class ProjectRoleResponse extends BaseRoleResponse {
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the id of the project")
+ @Param(description = "The ID of the project")
private String projectId;
public String getProjectId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ProviderResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ProviderResponse.java
index 4d410837476..7f08ee88a7d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ProviderResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ProviderResponse.java
@@ -31,31 +31,31 @@ import com.google.gson.annotations.SerializedName;
public class ProviderResponse extends BaseResponse {
@SerializedName(ApiConstants.NAME)
- @Param(description = "the provider name")
+ @Param(description = "The provider name")
private String name;
@SerializedName(ApiConstants.PHYSICAL_NETWORK_ID)
- @Param(description = "the physical network this belongs to")
+ @Param(description = "The physical Network this belongs to")
private String physicalNetworkId;
@SerializedName(ApiConstants.DEST_PHYSICAL_NETWORK_ID)
- @Param(description = "the destination physical network")
+ @Param(description = "The destination physical Network")
private String destinationPhysicalNetworkId;
@SerializedName(ApiConstants.STATE)
- @Param(description = "state of the network provider")
+ @Param(description = "State of the Network provider")
private String state;
@SerializedName(ApiConstants.ID)
- @Param(description = "uuid of the network provider")
+ @Param(description = "UUID of the Network provider")
private String id;
@SerializedName(ApiConstants.SERVICE_LIST)
- @Param(description = "services for this provider")
+ @Param(description = "Services for this provider")
private List services;
@SerializedName(ApiConstants.CAN_ENABLE_INDIVIDUAL_SERVICE)
- @Param(description = "true if individual services can be enabled/disabled")
+ @Param(description = "True if individual services can be enabled/disabled")
private Boolean canEnableIndividualServices;
public void setName(String name) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/RegionResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/RegionResponse.java
index 6c74fa623ce..785bd1f6c23 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/RegionResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/RegionResponse.java
@@ -28,23 +28,23 @@ import com.cloud.serializer.Param;
@EntityReference(value = Region.class)
public class RegionResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the region")
+ @Param(description = "The ID of the region")
private Integer id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the region")
+ @Param(description = "The name of the region")
private String name;
@SerializedName(ApiConstants.END_POINT)
- @Param(description = "the end point of the region")
+ @Param(description = "The end point of the region")
private String endPoint;
@SerializedName("gslbserviceenabled")
- @Param(description = "true if GSLB service is enabled in the region, false otherwise")
+ @Param(description = "True if GSLB service is enabled in the region, false otherwise")
private boolean gslbServiceEnabled;
@SerializedName("portableipserviceenabled")
- @Param(description = "true if security groups support is enabled, false otherwise")
+ @Param(description = "True if security groups support is enabled, false otherwise")
private boolean portableipServiceEnabled;
public Integer getId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/RegisterResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/RegisterResponse.java
index dd17cc5cc8a..915fffe5150 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/RegisterResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/RegisterResponse.java
@@ -25,15 +25,15 @@ import com.cloud.serializer.Param;
public class RegisterResponse extends BaseResponse {
@SerializedName(ApiConstants.API_KEY)
- @Param(description = "the api key of the registered user", isSensitive = true)
+ @Param(description = "The API key of the registered user", isSensitive = true)
private String apiKey;
@SerializedName(ApiConstants.SECRET_KEY)
- @Param(description = "the secret key of the registered user", isSensitive = true)
+ @Param(description = "The secret key of the registered user", isSensitive = true)
private String secretKey;
@SerializedName(ApiConstants.API_KEY_ACCESS)
- @Param(description = "whether api key access is allowed or not", isSensitive = true)
+ @Param(description = "Whether API key access is allowed or not", isSensitive = true)
private Boolean apiKeyAccess;
public String getApiKey() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/RemoteAccessVpnResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/RemoteAccessVpnResponse.java
index 54164e3ac34..9fe5052b39d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/RemoteAccessVpnResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/RemoteAccessVpnResponse.java
@@ -30,55 +30,55 @@ import com.google.gson.annotations.SerializedName;
public class RemoteAccessVpnResponse extends BaseResponse implements ControlledEntityResponse {
@SerializedName(ApiConstants.PUBLIC_IP_ID)
- @Param(description = "the public ip address of the vpn server")
+ @Param(description = "The public IP address of the VPN server")
private String publicIpId;
@SerializedName(ApiConstants.PUBLIC_IP)
- @Param(description = "the public ip address of the vpn server")
+ @Param(description = "The public IP address of the VPN server")
private String publicIp;
@SerializedName("iprange")
- @Param(description = "the range of ips to allocate to the clients")
+ @Param(description = "The range of IPs to allocate to the clients")
private String ipRange;
@SerializedName("presharedkey")
- @Param(description = "the ipsec preshared key", isSensitive = true)
+ @Param(description = "The IPSec preshared key", isSensitive = true)
private String presharedKey;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account of the remote access vpn")
+ @Param(description = "The Account of the remote access VPN")
private String accountName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the vpn")
+ @Param(description = "The project ID of the VPN")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the vpn")
+ @Param(description = "The project name of the VPN")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain id of the account of the remote access vpn")
+ @Param(description = "The domain ID of the Account of the remote access VPN")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain name of the account of the remote access vpn")
+ @Param(description = "The domain name of the Account of the remote access VPN")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
- @Param(description = "path of the domain to which the remote access vpn belongs", since = "4.19.2.0")
+ @Param(description = "Path of the domain to which the remote access VPN belongs", since = "4.19.2.0")
private String domainPath;
@SerializedName(ApiConstants.STATE)
- @Param(description = "the state of the rule")
+ @Param(description = "The state of the rule")
private String state;
@SerializedName(ApiConstants.ID)
- @Param(description = "the id of the remote access vpn")
+ @Param(description = "The ID of the remote access VPN")
private String id;
@SerializedName(ApiConstants.FOR_DISPLAY)
- @Param(description = "is vpn for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
+ @Param(description = "Is VPN for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
private Boolean forDisplay;
public void setPublicIp(String publicIp) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ResourceCountResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ResourceCountResponse.java
index 74511a0f743..d44e6c8fef5 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ResourceCountResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ResourceCountResponse.java
@@ -26,35 +26,35 @@ import com.google.gson.annotations.SerializedName;
@SuppressWarnings("unused")
public class ResourceCountResponse extends BaseResponse implements ControlledEntityResponse {
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account for which resource count's are updated")
+ @Param(description = "The Account for which resource count's are updated")
private String accountName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id for which resource count's are updated")
+ @Param(description = "The project ID for which resource count's are updated")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name for which resource count's are updated")
+ @Param(description = "The project name for which resource count's are updated")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain ID for which resource count's are updated")
+ @Param(description = "The domain ID for which resource count's are updated")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain name for which resource count's are updated")
+ @Param(description = "The domain name for which resource count's are updated")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
- @Param(description = "path of the domain to which the resource counts are updated", since = "4.19.2.0")
+ @Param(description = "Path of the domain to which the resource counts are updated", since = "4.19.2.0")
private String domainPath;
@SerializedName(ApiConstants.RESOURCE_TYPE)
- @Param(description = "resource type. Values include 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.")
+ @Param(description = "Resource type. Values include 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.")
private String resourceType;
@SerializedName(ApiConstants.RESOURCE_TYPE_NAME)
- @Param(description = "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.")
+ @Param(description = "Resource type name. Values include user_vm, public_ip, volume, Snapshot, Template, project, Network, VPC, CPU, memory, primary_storage, secondary_storage.")
private String resourceTypeName;
@SerializedName(ApiConstants.RESOURCE_COUNT)
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ResourceDetailResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ResourceDetailResponse.java
index 3ebb9c737ec..bf5031a03ea 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ResourceDetailResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ResourceDetailResponse.java
@@ -34,15 +34,15 @@ public class ResourceDetailResponse extends BaseResponse {
private String resourceType;
@SerializedName(ApiConstants.KEY)
- @Param(description = "key of the resource detail")
+ @Param(description = "Key of the resource detail")
private String name;
@SerializedName(ApiConstants.VALUE)
- @Param(description = "value of the resource detail")
+ @Param(description = "Value of the resource detail")
private String value;
@SerializedName(ApiConstants.FOR_DISPLAY)
- @Param(description = "if detail is returned to the regular user", since = "4.3")
+ @Param(description = "If detail is returned to the regular user", since = "4.3")
private boolean forDisplay;
public String getResourceId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ResourceIconResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ResourceIconResponse.java
index 403a91c8894..1b205548388 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ResourceIconResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ResourceIconResponse.java
@@ -24,15 +24,15 @@ import org.apache.cloudstack.api.BaseResponse;
public class ResourceIconResponse extends BaseResponse {
@SerializedName(ApiConstants.RESOURCE_TYPE)
- @Param(description = "resource type")
+ @Param(description = "Resource type")
private ResourceTag.ResourceObjectType resourceType;
@SerializedName(ApiConstants.RESOURCE_ID)
- @Param(description = "id of the resource")
+ @Param(description = "ID of the resource")
private String resourceId;
@SerializedName(ApiConstants.BASE64_IMAGE)
- @Param(description = "base64 representation of resource icon")
+ @Param(description = "Base64 representation of resource icon")
private String image;
public ResourceTag.ResourceObjectType getResourceType() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ResourceLimitResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ResourceLimitResponse.java
index b5b03873f3f..7b4a23444e5 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ResourceLimitResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ResourceLimitResponse.java
@@ -29,39 +29,39 @@ import com.google.gson.annotations.SerializedName;
@SuppressWarnings("unused")
public class ResourceLimitResponse extends BaseResponse implements ControlledEntityResponse {
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account of the resource limit")
+ @Param(description = "The Account of the resource limit")
private String accountName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain ID of the resource limit")
+ @Param(description = "The domain ID of the resource limit")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain name of the resource limit")
+ @Param(description = "The domain name of the resource limit")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
- @Param(description = "path of the domain to which the resource limit belongs", since = "4.19.2.0")
+ @Param(description = "Path of the domain to which the resource limit belongs", since = "4.19.2.0")
private String domainPath;
@SerializedName(ApiConstants.RESOURCE_TYPE)
- @Param(description = "resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.")
+ @Param(description = "Resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.")
private String resourceType;
@SerializedName(ApiConstants.RESOURCE_TYPE_NAME)
- @Param(description = "resource type name. Values include user_vm, public_ip, volume, snapshot, template, project, network, vpc, cpu, memory, primary_storage, secondary_storage.")
+ @Param(description = "Resource type name. Values include user_vm, public_ip, volume, Snapshot, Template, project, Network, VPC, CPU, memory, primary_storage, secondary_storage.")
private String resourceTypeName;
@SerializedName("max")
- @Param(description = "the maximum number of the resource. A -1 means the resource currently has no limit.")
+ @Param(description = "The maximum number of the resource. A -1 means the resource currently has no limit.")
private Long max;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the resource limit")
+ @Param(description = "The project ID of the resource limit")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the resource limit")
+ @Param(description = "The project name of the resource limit")
private String projectName;
@SerializedName(ApiConstants.TAG)
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ResourceTagResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ResourceTagResponse.java
index 26e4d19cdba..af90d68dd66 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ResourceTagResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ResourceTagResponse.java
@@ -26,47 +26,47 @@ import com.cloud.serializer.Param;
@SuppressWarnings("unused")
public class ResourceTagResponse extends BaseResponse implements ControlledViewEntityResponse {
@SerializedName(ApiConstants.KEY)
- @Param(description = "tag key name")
+ @Param(description = "Tag key name")
private String key;
@SerializedName(ApiConstants.VALUE)
- @Param(description = "tag value")
+ @Param(description = "Tag value")
private String value;
@SerializedName(ApiConstants.RESOURCE_TYPE)
- @Param(description = "resource type")
+ @Param(description = "Resource type")
private String resourceType;
@SerializedName(ApiConstants.RESOURCE_ID)
- @Param(description = "id of the resource")
+ @Param(description = "ID of the resource")
private String resourceId;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account associated with the tag")
+ @Param(description = "The Account associated with the tag")
private String accountName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id the tag belongs to")
+ @Param(description = "The project ID the tag belongs to")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name where tag belongs to")
+ @Param(description = "The project name where tag belongs to")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the ID of the domain associated with the tag")
+ @Param(description = "The ID of the domain associated with the tag")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain associated with the tag")
+ @Param(description = "The domain associated with the tag")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
- @Param(description = "path of the Domain associated with the tag", since = "4.19.2.0")
+ @Param(description = "Path of the Domain associated with the tag", since = "4.19.2.0")
private String domainPath;
@SerializedName(ApiConstants.CUSTOMER)
- @Param(description = "customer associated with the tag")
+ @Param(description = "Customer associated with the tag")
private String customer;
public void setKey(String key) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/RolePermissionResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/RolePermissionResponse.java
index 7bff8764cbe..6b47cae4573 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/RolePermissionResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/RolePermissionResponse.java
@@ -27,15 +27,15 @@ import com.google.gson.annotations.SerializedName;
@EntityReference(value = RolePermission.class)
public class RolePermissionResponse extends BaseRolePermissionResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the role permission")
+ @Param(description = "The ID of the role permission")
private String id;
@SerializedName(ApiConstants.ROLE_ID)
- @Param(description = "the ID of the role to which the role permission belongs")
+ @Param(description = "The ID of the role to which the role permission belongs")
private String roleId;
@SerializedName(ApiConstants.ROLE_NAME)
- @Param(description = "the name of the role to which the role permission belongs")
+ @Param(description = "The name of the role to which the role permission belongs")
private String roleName;
public String getId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/RoleResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/RoleResponse.java
index 92e3b46139f..b394e83dca5 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/RoleResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/RoleResponse.java
@@ -29,11 +29,11 @@ import com.google.gson.annotations.SerializedName;
public class RoleResponse extends BaseRoleResponse {
@SerializedName(ApiConstants.TYPE)
- @Param(description = "the type of the role")
+ @Param(description = "The type of the role")
private String roleType;
@SerializedName(ApiConstants.IS_DEFAULT)
- @Param(description = "true if role is default, false otherwise")
+ @Param(description = "True if role is default, false otherwise")
private Boolean isDefault;
@SerializedName(ApiConstants.STATE)
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/RollingMaintenanceHostSkippedResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/RollingMaintenanceHostSkippedResponse.java
index 8d304543fb9..0071498f427 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/RollingMaintenanceHostSkippedResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/RollingMaintenanceHostSkippedResponse.java
@@ -24,15 +24,15 @@ import org.apache.cloudstack.api.BaseResponse;
public class RollingMaintenanceHostSkippedResponse extends BaseResponse {
@SerializedName(ApiConstants.HOST_ID)
- @Param(description = "the ID of the skipped host")
+ @Param(description = "The ID of the skipped host")
private String hostId;
@SerializedName(ApiConstants.HOST_NAME)
- @Param(description = "the name of the skipped host")
+ @Param(description = "The name of the skipped host")
private String hostName;
@SerializedName(ApiConstants.ACL_REASON)
- @Param(description = "the reason to skip the host")
+ @Param(description = "The reason to skip the host")
private String reason;
public String getHostId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/RollingMaintenanceHostUpdatedResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/RollingMaintenanceHostUpdatedResponse.java
index 821257d4e07..a1670831af2 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/RollingMaintenanceHostUpdatedResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/RollingMaintenanceHostUpdatedResponse.java
@@ -24,23 +24,23 @@ import org.apache.cloudstack.api.BaseResponse;
public class RollingMaintenanceHostUpdatedResponse extends BaseResponse {
@SerializedName(ApiConstants.HOST_ID)
- @Param(description = "the ID of the updated host")
+ @Param(description = "The ID of the updated host")
private String hostId;
@SerializedName(ApiConstants.HOST_NAME)
- @Param(description = "the name of the updated host")
+ @Param(description = "The name of the updated host")
private String hostName;
@SerializedName(ApiConstants.START_DATE)
- @Param(description = "start date of the update on the host")
+ @Param(description = "Start date of the update on the host")
private String startDate;
@SerializedName(ApiConstants.END_DATE)
- @Param(description = "end date of the update on the host")
+ @Param(description = "End date of the update on the host")
private String endDate;
@SerializedName(ApiConstants.OUTPUT)
- @Param(description = "output of the maintenance script on the host")
+ @Param(description = "Output of the maintenance script on the host")
private String output;
public String getHostId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/RollingMaintenanceResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/RollingMaintenanceResponse.java
index 89b838c2843..56427d7eaca 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/RollingMaintenanceResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/RollingMaintenanceResponse.java
@@ -25,19 +25,19 @@ import java.util.List;
public class RollingMaintenanceResponse extends BaseResponse {
@SerializedName("success")
- @Param(description = "indicates if the rolling maintenance operation was successful")
+ @Param(description = "Indicates if the rolling maintenance operation was successful")
private Boolean success;
@SerializedName("details")
- @Param(description = "in case of failure, details are displayed")
+ @Param(description = "In case of failure, details are displayed")
private String details;
@SerializedName("hostsupdated")
- @Param(description = "the hosts updated", responseObject = RollingMaintenanceHostUpdatedResponse.class)
+ @Param(description = "The hosts updated", responseObject = RollingMaintenanceHostUpdatedResponse.class)
private List updatedHosts;
@SerializedName("hostsskipped")
- @Param(description = "the hosts skipped", responseObject = RollingMaintenanceHostSkippedResponse.class)
+ @Param(description = "The hosts skipped", responseObject = RollingMaintenanceHostSkippedResponse.class)
private List skippedHosts;
public RollingMaintenanceResponse(Boolean success, String details) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/RouterHealthCheckResultResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/RouterHealthCheckResultResponse.java
index f98cf0acd5d..5bdd9b0d279 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/RouterHealthCheckResultResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/RouterHealthCheckResultResponse.java
@@ -27,23 +27,23 @@ import com.google.gson.annotations.SerializedName;
public class RouterHealthCheckResultResponse extends BaseResponse {
@SerializedName(ApiConstants.ROUTER_CHECK_NAME)
- @Param(description = "the name of the health check on the router")
+ @Param(description = "The name of the health check on the router")
private String checkName;
@SerializedName(ApiConstants.ROUTER_CHECK_TYPE)
- @Param(description = "the type of the health check - basic or advanced")
+ @Param(description = "The type of the health check - basic or advanced")
private String checkType;
@SerializedName(ApiConstants.RESULT)
- @Param(description = "result of the health check")
+ @Param(description = "Result of the health check")
private boolean result;
@SerializedName(ApiConstants.LAST_UPDATED)
- @Param(description = "the date this VPC was created")
+ @Param(description = "The date this VPC was created")
private Date lastUpdated;
@SerializedName(ApiConstants.DETAILS)
- @Param(description = "detailed response generated on running health check")
+ @Param(description = "Detailed response generated on running health check")
private String details;
public String getCheckName() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/RouterHealthCheckResultsListResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/RouterHealthCheckResultsListResponse.java
index e56f70d2c59..0d2d6cf8882 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/RouterHealthCheckResultsListResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/RouterHealthCheckResultsListResponse.java
@@ -27,11 +27,11 @@ import com.google.gson.annotations.SerializedName;
public class RouterHealthCheckResultsListResponse extends BaseResponse {
@SerializedName(ApiConstants.ROUTER_ID)
- @Param(description = "the id of the router")
+ @Param(description = "The ID of the router")
private String routerId;
@SerializedName(ApiConstants.ROUTER_HEALTH_CHECKS)
- @Param(description = "the id of the router")
+ @Param(description = "The ID of the router")
private List healthChecks;
public String getRouterId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/RunDiagnosticsResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/RunDiagnosticsResponse.java
index 4c8a923613a..0583020c7da 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/RunDiagnosticsResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/RunDiagnosticsResponse.java
@@ -29,15 +29,15 @@ import org.apache.cloudstack.api.EntityReference;
@EntityReference(value = VirtualMachine.class)
public class RunDiagnosticsResponse extends BaseResponse {
@SerializedName(ApiConstants.STDOUT)
- @Param(description = "the standard output from the command execution")
+ @Param(description = "The standard output from the command execution")
private String stdout;
@SerializedName(ApiConstants.STDERR)
- @Param(description = "the standard error output from the command execution")
+ @Param(description = "The standard error output from the command execution")
private String stderr;
@SerializedName(ApiConstants.EXITCODE)
- @Param(description = "the command execution return code")
+ @Param(description = "The command execution return code")
private String exitCode;
public String getStdout() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/SSHKeyPairResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/SSHKeyPairResponse.java
index 65e5c5b7413..a2b9788f9f0 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/SSHKeyPairResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/SSHKeyPairResponse.java
@@ -30,28 +30,28 @@ import org.apache.cloudstack.api.EntityReference;
public class SSHKeyPairResponse extends BaseResponseWithAnnotations {
@SerializedName(ApiConstants.ID)
- @Param(description = "ID of the ssh keypair")
+ @Param(description = "ID of the SSH keypair")
private String id;
@SerializedName(ApiConstants.NAME)
@Param(description = "Name of the keypair")
private String name;
- @SerializedName(ApiConstants.ACCOUNT) @Param(description="the owner of the keypair")
+ @SerializedName(ApiConstants.ACCOUNT) @Param(description = "The owner of the keypair")
private String accountName;
- @SerializedName(ApiConstants.DOMAIN_ID) @Param(description="the domain id of the keypair owner")
+ @SerializedName(ApiConstants.DOMAIN_ID) @Param(description = "The domain id of the keypair owner")
private String domainId;
- @SerializedName(ApiConstants.DOMAIN) @Param(description="the domain name of the keypair owner")
+ @SerializedName(ApiConstants.DOMAIN) @Param(description = "The domain name of the keypair owner")
private String domain;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the keypair owner")
+ @Param(description = "The project id of the keypair owner")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the keypair owner")
+ @Param(description = "The project name of the keypair owner")
private String projectName;
@SerializedName("fingerprint")
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/SecurityGroupResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/SecurityGroupResponse.java
index de486b5a374..2085e608973 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/SecurityGroupResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/SecurityGroupResponse.java
@@ -32,35 +32,35 @@ import com.google.gson.annotations.SerializedName;
public class SecurityGroupResponse extends BaseResponse implements ControlledViewEntityResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the security group")
+ @Param(description = "The ID of the security group")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the security group")
+ @Param(description = "The name of the security group")
private String name;
@SerializedName(ApiConstants.DESCRIPTION)
- @Param(description = "the description of the security group")
+ @Param(description = "The description of the security group")
private String description;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account owning the security group")
+ @Param(description = "The Account owning the security group")
private String accountName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the group")
+ @Param(description = "The project id of the group")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the group")
+ @Param(description = "The project name of the group")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain ID of the security group")
+ @Param(description = "The domain ID of the security group")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain name of the security group")
+ @Param(description = "The domain name of the security group")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
@@ -68,23 +68,23 @@ public class SecurityGroupResponse extends BaseResponse implements ControlledVie
private String domainPath;
@SerializedName("ingressrule")
- @Param(description = "the list of ingress rules associated with the security group", responseObject = SecurityGroupRuleResponse.class)
+ @Param(description = "The list of ingress rules associated with the security group", responseObject = SecurityGroupRuleResponse.class)
private Set ingressRules;
@SerializedName("egressrule")
- @Param(description = "the list of egress rules associated with the security group", responseObject = SecurityGroupRuleResponse.class)
+ @Param(description = "The list of egress rules associated with the security group", responseObject = SecurityGroupRuleResponse.class)
private Set egressRules;
@SerializedName(ApiConstants.TAGS)
- @Param(description = "the list of resource tags associated with the rule", responseObject = ResourceTagResponse.class)
+ @Param(description = "The list of resource tags associated with the rule", responseObject = ResourceTagResponse.class)
private Set tags;
@SerializedName(ApiConstants.VIRTUAL_MACHINE_COUNT)
- @Param(description = "the number of virtualmachines associated with this securitygroup", since = "4.6.0")
+ @Param(description = "The number of Instances associated with this Security Group", since = "4.6.0")
private Integer virtualMachineCount;
@SerializedName(ApiConstants.VIRTUAL_MACHINE_IDS)
- @Param(description = "the list of virtualmachine ids associated with this securitygroup", since = "4.6.0")
+ @Param(description = "The list of Instance IDs associated with this Security Group", since = "4.6.0")
private Set virtualMachineIds;
public SecurityGroupResponse() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/SecurityGroupRuleResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/SecurityGroupRuleResponse.java
index 9e553aa32cc..734fa50acb1 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/SecurityGroupRuleResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/SecurityGroupRuleResponse.java
@@ -30,43 +30,43 @@ import java.util.Set;
@EntityReference(value = SecurityRule.class)
public class SecurityGroupRuleResponse extends BaseResponse {
@SerializedName("ruleid")
- @Param(description = "the id of the security group rule")
+ @Param(description = "The ID of the security group rule")
private String ruleId;
@SerializedName("protocol")
- @Param(description = "the protocol of the security group rule")
+ @Param(description = "The protocol of the security group rule")
private String protocol;
@SerializedName(ApiConstants.ICMP_TYPE)
- @Param(description = "the type of the ICMP message response")
+ @Param(description = "The type of the ICMP message response")
private Integer icmpType;
@SerializedName(ApiConstants.ICMP_CODE)
- @Param(description = "the code for the ICMP message response")
+ @Param(description = "The code for the ICMP message response")
private Integer icmpCode;
@SerializedName(ApiConstants.START_PORT)
- @Param(description = "the starting IP of the security group rule")
+ @Param(description = "The starting IP of the security group rule")
private Integer startPort;
@SerializedName(ApiConstants.END_PORT)
- @Param(description = "the ending IP of the security group rule ")
+ @Param(description = "The ending IP of the security group rule ")
private Integer endPort;
@SerializedName(ApiConstants.SECURITY_GROUP_NAME)
- @Param(description = "security group name")
+ @Param(description = "Security group name")
private String securityGroupName;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "account owning the security group rule")
+ @Param(description = "Account owning the security group rule")
private String accountName;
@SerializedName(ApiConstants.CIDR)
- @Param(description = "the CIDR notation for the base IP address of the security group rule")
+ @Param(description = "The CIDR notation for the base IP address of the security group rule")
private String cidr;
@SerializedName(ApiConstants.TAGS)
- @Param(description = "the list of resource tags associated with the rule", responseObject = ResourceTagResponse.class)
+ @Param(description = "The list of resource tags associated with the rule", responseObject = ResourceTagResponse.class)
private java.util.Set tags;
public String getRuleId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ServiceOfferingResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ServiceOfferingResponse.java
index 0622b936f6e..224893072ba 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ServiceOfferingResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ServiceOfferingResponse.java
@@ -30,178 +30,178 @@ import com.google.gson.annotations.SerializedName;
@EntityReference(value = ServiceOffering.class)
public class ServiceOfferingResponse extends BaseResponseWithAnnotations {
@SerializedName("id")
- @Param(description = "the id of the service offering")
+ @Param(description = "The ID of the service offering")
private String id;
@SerializedName("name")
- @Param(description = "the name of the service offering")
+ @Param(description = "The name of the service offering")
private String name;
@SerializedName("state")
- @Param(description = "state of the service offering")
+ @Param(description = "State of the service offering")
private String state;
@SerializedName("displaytext")
- @Param(description = "an alternate display text of the service offering.")
+ @Param(description = "An alternate display text of the service offering.")
private String displayText;
@SerializedName("cpunumber")
- @Param(description = "the number of CPU")
+ @Param(description = "The number of CPU")
private Integer cpuNumber;
@SerializedName("cpuspeed")
- @Param(description = "the clock rate CPU speed in Mhz")
+ @Param(description = "The clock rate CPU speed in Mhz")
private Integer cpuSpeed;
@SerializedName("memory")
- @Param(description = "the memory in MB")
+ @Param(description = "The memory in MB")
private Integer memory;
@SerializedName("created")
- @Param(description = "the date this service offering was created")
+ @Param(description = "The date this service offering was created")
private Date created;
@SerializedName("storagetype")
- @Param(description = "the storage type for this service offering")
+ @Param(description = "The storage type for this service offering")
private String storageType;
- @SerializedName("provisioningtype") @Param(description="provisioning type used to create volumes. Valid values are thin, sparse, fat.", since = "4.4.0")
+ @SerializedName("provisioningtype") @Param(description = "Provisioning type used to create volumes. Valid values are thin, sparse, fat.", since = "4.4.0")
private String provisioningType;
@SerializedName("offerha")
- @Param(description = "the ha support in the service offering")
+ @Param(description = "The HA support in the service offering")
private Boolean offerHa;
@SerializedName("limitcpuuse")
- @Param(description = "restrict the CPU usage to committed service offering")
+ @Param(description = "Restrict the CPU usage to committed service offering")
private Boolean limitCpuUse;
@SerializedName("isvolatile")
- @Param(description = "true if the vm needs to be volatile, i.e., on every reboot of vm from API root disk is discarded and creates a new root disk")
+ @Param(description = "True if the Instance needs to be volatile, i.e., on every reboot of Instance from API root disk is discarded and creates a new root disk")
private Boolean isVolatile;
@SerializedName("storagetags")
- @Param(description = "the tags for the service offering")
+ @Param(description = "The tags for the service offering")
private String tags;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.")
+ @Param(description = "The domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.")
+ @Param(description = "The domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.")
private String domain;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", since = "4.13.0")
+ @Param(description = "The zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", since = "4.13.0")
private String zoneId;
@SerializedName(ApiConstants.ZONE)
- @Param(description = "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", since = "4.13.0")
+ @Param(description = "The zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", since = "4.13.0")
private String zone;
@SerializedName(ApiConstants.HOST_TAGS)
- @Param(description = "the host tag for the service offering")
+ @Param(description = "The host tag for the service offering")
private String hostTag;
@SerializedName(ApiConstants.IS_SYSTEM_OFFERING)
- @Param(description = "is this a system vm offering")
+ @Param(description = "Is this a System VM offering")
private Boolean isSystem;
@SerializedName(ApiConstants.IS_DEFAULT_USE)
- @Param(description = "is this a default system vm offering")
+ @Param(description = "Is this a default System VM offering")
private Boolean defaultUse;
@SerializedName(ApiConstants.SYSTEM_VM_TYPE)
- @Param(description = "is this a the systemvm type for system vm offering")
+ @Param(description = "Is this a the System VM type for System VM offering")
private String vmType;
@SerializedName(ApiConstants.NETWORKRATE)
- @Param(description = "data transfer rate in megabits per second allowed.")
+ @Param(description = "Data transfer rate in megabits per second allowed.")
private Integer networkRate;
@SerializedName("iscustomizediops")
- @Param(description = "true if disk offering uses custom iops, false otherwise", since = "4.4")
+ @Param(description = "True if disk offering uses custom IOPS, false otherwise", since = "4.4")
private Boolean customizedIops;
@SerializedName(ApiConstants.MIN_IOPS)
- @Param(description = "the min iops of the disk offering", since = "4.4")
+ @Param(description = "The min IOPS of the disk offering", since = "4.4")
private Long minIops;
@SerializedName(ApiConstants.MAX_IOPS)
- @Param(description = "the max iops of the disk offering", since = "4.4")
+ @Param(description = "The max IOPS of the disk offering", since = "4.4")
private Long maxIops;
@SerializedName(ApiConstants.HYPERVISOR_SNAPSHOT_RESERVE)
- @Param(description = "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", since = "4.4")
+ @Param(description = "Hypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", since = "4.4")
private Integer hypervisorSnapshotReserve;
@SerializedName("diskBytesReadRate")
- @Param(description = "bytes read rate of the service offering")
+ @Param(description = "Bytes read rate of the service offering")
private Long bytesReadRate;
@SerializedName("diskBytesReadRateMax")
- @Param(description = "burst bytes read rate of the disk offering")
+ @Param(description = "Burst bytes read rate of the disk offering")
private Long bytesReadRateMax;
@SerializedName("diskBytesReadRateMaxLength")
- @Param(description = "length (in seconds) of the burst")
+ @Param(description = "Length (in seconds) of the burst")
private Long bytesReadRateMaxLength;
@SerializedName("diskBytesWriteRate")
- @Param(description = "bytes write rate of the service offering")
+ @Param(description = "Bytes write rate of the service offering")
private Long bytesWriteRate;
@SerializedName("diskBytesWriteRateMax")
- @Param(description = "burst bytes write rate of the disk offering")
+ @Param(description = "Burst bytes write rate of the disk offering")
private Long bytesWriteRateMax;
@SerializedName("diskBytesWriteRateMaxLength")
- @Param(description = "length (in seconds) of the burst")
+ @Param(description = "Length (in seconds) of the burst")
private Long bytesWriteRateMaxLength;
@SerializedName("diskIopsReadRate")
- @Param(description = "io requests read rate of the service offering")
+ @Param(description = "I/O requests read rate of the service offering")
private Long iopsReadRate;
@SerializedName("diskIopsReadRateMax")
- @Param(description = "burst io requests read rate of the disk offering")
+ @Param(description = "Burst io requests read rate of the disk offering")
private Long iopsReadRateMax;
@SerializedName("diskIopsReadRateMaxLength")
- @Param(description = "length (in second) of the burst")
+ @Param(description = "Length (in second) of the burst")
private Long iopsReadRateMaxLength;
@SerializedName("diskIopsWriteRate")
- @Param(description = "io requests write rate of the service offering")
+ @Param(description = "I/O requests write rate of the service offering")
private Long iopsWriteRate;
@SerializedName("diskIopsWriteRateMax")
- @Param(description = "burst io requests write rate of the disk offering")
+ @Param(description = "Burst I/O requests write rate of the disk offering")
private Long iopsWriteRateMax;
@SerializedName("diskIopsWriteRateMaxLength")
- @Param(description = "length (in seconds) of the burst")
+ @Param(description = "Length (in seconds) of the burst")
private Long iopsWriteRateMaxLength;
@SerializedName(ApiConstants.DEPLOYMENT_PLANNER)
- @Param(description = "deployment strategy used to deploy VM.")
+ @Param(description = "Deployment strategy used to deploy Instance.")
private String deploymentPlanner;
@SerializedName(ApiConstants.SERVICE_OFFERING_DETAILS)
- @Param(description = "additional key/value details tied with this service offering", since = "4.2.0")
+ @Param(description = "Additional key/value details tied with this service offering", since = "4.2.0")
private Map details;
@SerializedName("iscustomized")
- @Param(description = "is true if the offering is customized", since = "4.3.0")
+ @Param(description = "Is true if the offering is customized", since = "4.3.0")
private Boolean isCustomized;
@SerializedName("cacheMode")
- @Param(description = "the cache mode to use for this disk offering. none, writeback or writethrough", since = "4.14")
+ @Param(description = "The cache mode to use for this disk offering. none, writeback or writethrough", since = "4.14")
private String cacheMode;
@SerializedName("vspherestoragepolicy")
- @Param(description = "the vsphere storage policy tagged to the service offering in case of VMware", since = "4.15")
+ @Param(description = "The vsphere storage policy tagged to the service offering in case of VMware", since = "4.15")
private String vsphereStoragePolicy;
@SerializedName(ApiConstants.ROOT_DISK_SIZE)
@@ -209,29 +209,29 @@ public class ServiceOfferingResponse extends BaseResponseWithAnnotations {
private Long rootDiskSize;
@SerializedName(ApiConstants.DYNAMIC_SCALING_ENABLED)
- @Param(description = "true if virtual machine needs to be dynamically scalable of cpu or memory", since = "4.16")
+ @Param(description = "True if Instance needs to be dynamically scalable of CPU or memory", since = "4.16")
private Boolean dynamicScalingEnabled;
@SerializedName(ApiConstants.DISK_OFFERING_STRICTNESS)
@Param(description = "True/False to indicate the strictness of the disk offering association with the compute offering. " +
- "When set to true, override of disk offering is not allowed when VM is deployed and " +
- "change disk offering is not allowed for the ROOT disk after the VM is deployed", since = "4.17")
+ "When set to true, override of disk offering is not allowed when Instance is deployed and " +
+ "change disk offering is not allowed for the ROOT disk after the Instance is deployed", since = "4.17")
private Boolean diskOfferingStrictness;
@SerializedName(ApiConstants.DISK_OFFERING_ID)
- @Param(description = "the ID of the disk offering to which service offering is linked", since = "4.17")
+ @Param(description = "The ID of the disk offering to which service offering is linked", since = "4.17")
private String diskOfferingId;
@SerializedName("diskofferingname")
- @Param(description = "name of the disk offering", since = "4.17")
+ @Param(description = "Name of the disk offering", since = "4.17")
private String diskOfferingName;
@SerializedName("diskofferingdisplaytext")
- @Param(description = "the display text of the disk offering", since = "4.17")
+ @Param(description = "The display text of the disk offering", since = "4.17")
private String diskOfferingDisplayText;
@SerializedName(ApiConstants.ENCRYPT_ROOT)
- @Param(description = "true if virtual machine root disk will be encrypted on storage", since = "4.18")
+ @Param(description = "True if Instance root disk will be encrypted on storage", since = "4.18")
private Boolean encryptRoot;
@SerializedName(ApiConstants.PURGE_RESOURCES)
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/ServiceResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/ServiceResponse.java
index 9f5acc13f8b..9d1470b64d7 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/ServiceResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/ServiceResponse.java
@@ -29,15 +29,15 @@ import com.cloud.serializer.Param;
public class ServiceResponse extends BaseResponse {
@SerializedName(ApiConstants.NAME)
- @Param(description = "the service name")
+ @Param(description = "The service name")
private String name;
@SerializedName(ApiConstants.PROVIDER)
- @Param(description = "the service provider name", responseObject = ProviderResponse.class)
+ @Param(description = "The service provider name", responseObject = ProviderResponse.class)
private List providers;
@SerializedName("capability")
- @Param(description = "the list of capabilities", responseObject = CapabilityResponse.class)
+ @Param(description = "The list of capabilities", responseObject = CapabilityResponse.class)
private List capabilities;
public void setName(String name) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/Site2SiteCustomerGatewayResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/Site2SiteCustomerGatewayResponse.java
index 4ae140ec573..4e5820279a2 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/Site2SiteCustomerGatewayResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/Site2SiteCustomerGatewayResponse.java
@@ -31,23 +31,23 @@ import com.cloud.serializer.Param;
@SuppressWarnings("unused")
public class Site2SiteCustomerGatewayResponse extends BaseResponseWithAnnotations implements ControlledEntityResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the vpn gateway ID")
+ @Param(description = "The VPN gateway ID")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "name of the customer gateway")
+ @Param(description = "Name of the customer gateway")
private String name;
@SerializedName(ApiConstants.GATEWAY)
- @Param(description = "public ip address id of the customer gateway")
+ @Param(description = "Public IP address ID of the customer gateway")
private String gatewayIp;
@SerializedName(ApiConstants.IP_ADDRESS)
- @Param(description = "guest ip of the customer gateway")
+ @Param(description = "Guest IP of the customer gateway")
private String guestIp;
@SerializedName(ApiConstants.CIDR_LIST)
- @Param(description = "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).")
+ @Param(description = "Guest CIDR list of the customer gateway. Multiple entries are separated by a single comma character (,).")
private String guestCidrList;
@SerializedName(ApiConstants.IPSEC_PSK)
@@ -71,47 +71,47 @@ public class Site2SiteCustomerGatewayResponse extends BaseResponseWithAnnotation
private Long espLifetime;
@SerializedName(ApiConstants.DPD)
- @Param(description = "if DPD is enabled for customer gateway")
+ @Param(description = "If DPD is enabled for customer gateway")
private Boolean dpd;
@SerializedName(ApiConstants.FORCE_ENCAP)
- @Param(description = "if Force NAT Encapsulation is enabled for customer gateway")
+ @Param(description = "If Force NAT Encapsulation is enabled for customer gateway")
private Boolean encap;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the owner")
+ @Param(description = "The owner")
private String accountName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id")
+ @Param(description = "The project ID")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name")
+ @Param(description = "The project name")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain id of the owner")
+ @Param(description = "The domain ID of the owner")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain name of the owner")
+ @Param(description = "The domain name of the owner")
private String domain;
@SerializedName(ApiConstants.DOMAIN_PATH)
- @Param(description = "the domain path of the owner", since = "4.19.2.0")
+ @Param(description = "The domain path of the owner", since = "4.19.2.0")
private String domainPath;
@SerializedName(ApiConstants.REMOVED)
- @Param(description = "the date and time the host was removed")
+ @Param(description = "The date and time the host was removed")
private Date removed;
@SerializedName(ApiConstants.SPLIT_CONNECTIONS)
- @Param(description = "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.")
+ @Param(description = "For IKEv2, whether to split multiple right subnet CIDRs into multiple connection statements.")
private Boolean splitConnections;
@SerializedName(ApiConstants.IKE_VERSION)
- @Param(description = "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike")
+ @Param(description = "Which IKE Version to use, one of ike (autoselect), IKEv1, or IKEv2. Defaults to ike")
private String ikeVersion;
public void setId(String id) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/Site2SiteVpnConnectionResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/Site2SiteVpnConnectionResponse.java
index a9fd0f9703c..e668b7d948f 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/Site2SiteVpnConnectionResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/Site2SiteVpnConnectionResponse.java
@@ -31,29 +31,29 @@ import com.google.gson.annotations.SerializedName;
@SuppressWarnings("unused")
public class Site2SiteVpnConnectionResponse extends BaseResponse implements ControlledEntityResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the connection ID")
+ @Param(description = "The connection ID")
private String id;
@SerializedName(ApiConstants.S2S_VPN_GATEWAY_ID)
- @Param(description = "the vpn gateway ID")
+ @Param(description = "The VPN gateway ID")
private String vpnGatewayId;
@SerializedName(ApiConstants.PUBLIC_IP)
- @Param(description = "the public IP address")
+ @Param(description = "The public IP address")
//from VpnGateway
private String ip;
@SerializedName(ApiConstants.S2S_CUSTOMER_GATEWAY_ID)
- @Param(description = "the customer gateway ID")
+ @Param(description = "The customer gateway ID")
private String customerGatewayId;
@SerializedName(ApiConstants.GATEWAY)
- @Param(description = "public ip address id of the customer gateway")
+ @Param(description = "Public IP address id of the customer gateway")
//from CustomerGateway
private String gatewayIp;
@SerializedName(ApiConstants.CIDR_LIST)
- @Param(description = "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).")
+ @Param(description = "Guest CIDR list of the customer gateway. Multiple entries are separated by a single comma character (,).")
//from CustomerGateway
private String guestCidrList;
@@ -83,41 +83,41 @@ public class Site2SiteVpnConnectionResponse extends BaseResponse implements Cont
private Long espLifetime;
@SerializedName(ApiConstants.DPD)
- @Param(description = "if DPD is enabled for customer gateway")
+ @Param(description = "If DPD is enabled for customer gateway")
//from CustomerGateway
private Boolean dpd;
@SerializedName(ApiConstants.FORCE_ENCAP)
- @Param(description = "if Force NAT Encapsulation is enabled for customer gateway")
+ @Param(description = "If Force NAT Encapsulation is enabled for customer gateway")
//from CustomerGateway
private Boolean encap;
@SerializedName(ApiConstants.STATE)
- @Param(description = "State of vpn connection")
+ @Param(description = "State of VPN connection")
private String state;
@SerializedName(ApiConstants.PASSIVE)
- @Param(description = "State of vpn connection")
+ @Param(description = "State of VPN connection")
private boolean passive;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the owner")
+ @Param(description = "The owner")
private String accountName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id")
+ @Param(description = "The project id")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name")
+ @Param(description = "The project name")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain id of the owner")
+ @Param(description = "The domain id of the owner")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain name of the owner")
+ @Param(description = "The domain name of the owner")
private String domain;
@SerializedName(ApiConstants.DOMAIN_PATH)
@@ -125,23 +125,23 @@ public class Site2SiteVpnConnectionResponse extends BaseResponse implements Cont
private String domainPath;
@SerializedName(ApiConstants.CREATED)
- @Param(description = "the date and time the host was created")
+ @Param(description = "The date and time the host was created")
private Date created;
@SerializedName(ApiConstants.REMOVED)
- @Param(description = "the date and time the host was removed")
+ @Param(description = "The date and time the host was removed")
private Date removed;
@SerializedName(ApiConstants.FOR_DISPLAY)
- @Param(description = "is connection for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
+ @Param(description = "Is connection for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
private Boolean forDisplay;
@SerializedName(ApiConstants.SPLIT_CONNECTIONS)
- @Param(description = "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.")
+ @Param(description = "Split multiple remote Networks into multiple phase 2 SAs. Often used with Cisco some products.")
private Boolean splitConnections;
@SerializedName(ApiConstants.IKE_VERSION)
- @Param(description = "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike")
+ @Param(description = "Which IKE Version to use, one of ike (autoselect), IKEv1, or IKEv2. Defaults to ike")
private String ikeVersion;
public void setId(String id) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/Site2SiteVpnGatewayResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/Site2SiteVpnGatewayResponse.java
index 1e63ba896c7..9f997ca5bb7 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/Site2SiteVpnGatewayResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/Site2SiteVpnGatewayResponse.java
@@ -31,39 +31,39 @@ import com.google.gson.annotations.SerializedName;
@SuppressWarnings("unused")
public class Site2SiteVpnGatewayResponse extends BaseResponse implements ControlledEntityResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the vpn gateway ID")
+ @Param(description = "The VPN gateway ID")
private String id;
@SerializedName(ApiConstants.PUBLIC_IP)
- @Param(description = "the public IP address")
+ @Param(description = "The public IP address")
private String ip;
@SerializedName(ApiConstants.VPC_ID)
- @Param(description = "the vpc id of this gateway")
+ @Param(description = "The VPC id of this gateway")
private String vpcId;
@SerializedName(ApiConstants.VPC_NAME)
- @Param(description = "the vpc name of this gateway", since = "4.13.2")
+ @Param(description = "The VPC name of this gateway", since = "4.13.2")
private String vpcName;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the owner")
+ @Param(description = "The owner")
private String accountName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id")
+ @Param(description = "The project id")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name")
+ @Param(description = "The project name")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain id of the owner")
+ @Param(description = "The domain id of the owner")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain name of the owner")
+ @Param(description = "The domain name of the owner")
private String domain;
@SerializedName(ApiConstants.DOMAIN_PATH)
@@ -71,11 +71,11 @@ public class Site2SiteVpnGatewayResponse extends BaseResponse implements Control
private String domainPath;
@SerializedName(ApiConstants.REMOVED)
- @Param(description = "the date and time the host was removed")
+ @Param(description = "The date and time the host was removed")
private Date removed;
@SerializedName(ApiConstants.FOR_DISPLAY)
- @Param(description = "is vpn gateway for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
+ @Param(description = "Is VPN gateway for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
private Boolean forDisplay;
public void setId(String id) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/SnapshotPolicyResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/SnapshotPolicyResponse.java
index bfa1cca1ca0..05d0ffdb731 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/SnapshotPolicyResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/SnapshotPolicyResponse.java
@@ -31,31 +31,31 @@ import com.google.gson.annotations.SerializedName;
@EntityReference(value = SnapshotPolicy.class)
public class SnapshotPolicyResponse extends BaseResponseWithTagInformation {
@SerializedName("id")
- @Param(description = "the ID of the snapshot policy")
+ @Param(description = "The ID of the Snapshot policy")
private String id;
@SerializedName("volumeid")
- @Param(description = "the ID of the disk volume")
+ @Param(description = "The ID of the disk volume")
private String volumeId;
@SerializedName("schedule")
- @Param(description = "time the snapshot is scheduled to be taken.")
+ @Param(description = "Time the Snapshot is scheduled to be taken.")
private String schedule;
@SerializedName("intervaltype")
- @Param(description = "the interval type of the snapshot policy")
+ @Param(description = "The interval type of the Snapshot policy")
private short intervalType;
@SerializedName("maxsnaps")
- @Param(description = "maximum number of snapshots retained")
+ @Param(description = "Maximum number of Snapshots retained")
private int maxSnaps;
@SerializedName("timezone")
- @Param(description = "the time zone of the snapshot policy")
+ @Param(description = "The time zone of the Snapshot policy")
private String timezone;
@SerializedName(ApiConstants.FOR_DISPLAY)
- @Param(description = "is this policy for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
+ @Param(description = "Is this policy for display to the regular user", since = "4.4", authorized = {RoleType.Admin})
private Boolean forDisplay;
@SerializedName(ApiConstants.ZONE)
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/SnapshotResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/SnapshotResponse.java
index 9f7a7f42dec..7a4090eb725 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/SnapshotResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/SnapshotResponse.java
@@ -32,19 +32,19 @@ import com.google.gson.annotations.SerializedName;
@EntityReference(value = Snapshot.class)
public class SnapshotResponse extends BaseResponseWithTagInformation implements ControlledViewEntityResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "ID of the snapshot")
+ @Param(description = "ID of the Snapshot")
private String id;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account associated with the snapshot")
+ @Param(description = "The Account associated with the Snapshot")
private String accountName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain ID of the snapshot's account")
+ @Param(description = "The domain ID of the Snapshot's Account")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain name of the snapshot's account")
+ @Param(description = "The domain name of the Snapshot's Account")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
@@ -52,15 +52,15 @@ public class SnapshotResponse extends BaseResponseWithTagInformation implements
private String domainPath;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the snapshot")
+ @Param(description = "The project id of the Snapshot")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the snapshot")
+ @Param(description = "The project name of the Snapshot")
private String projectName;
@SerializedName(ApiConstants.SNAPSHOT_TYPE)
- @Param(description = "the type of the snapshot")
+ @Param(description = "The type of the Snapshot")
private String snapshotType;
@SerializedName(ApiConstants.VOLUME_ID)
@@ -68,11 +68,11 @@ public class SnapshotResponse extends BaseResponseWithTagInformation implements
private String volumeId;
@SerializedName(ApiConstants.VOLUME_NAME)
- @Param(description = "name of the disk volume")
+ @Param(description = "Name of the disk volume")
private String volumeName;
@SerializedName("volumetype")
- @Param(description = "type of the disk volume")
+ @Param(description = "Type of the disk volume")
private String volumeType;
@SerializedName(ApiConstants.VOLUME_STATE)
@@ -80,23 +80,23 @@ public class SnapshotResponse extends BaseResponseWithTagInformation implements
private String volumeState;
@SerializedName(ApiConstants.CREATED)
- @Param(description = " the date the snapshot was created")
+ @Param(description = "The date the Snapshot was created")
private Date created;
@SerializedName(ApiConstants.NAME)
- @Param(description = "name of the snapshot")
+ @Param(description = "Name of the Snapshot")
private String name;
@SerializedName(ApiConstants.INTERVAL_TYPE)
- @Param(description = "valid types are hourly, daily, weekly, monthy, template, and none.")
+ @Param(description = "Valid types are hourly, daily, weekly, monthy, Template, and none.")
private String intervalType;
@SerializedName(ApiConstants.LOCATION_TYPE)
- @Param(description = "valid location types are primary and secondary.")
+ @Param(description = "Valid location types are primary and secondary.")
private String locationType;
@SerializedName(ApiConstants.STATE)
- @Param(description = "the state of the snapshot. BackedUp means that snapshot is ready to be used; Creating - the snapshot is being allocated on the primary storage; BackingUp - the snapshot is being backed up on secondary storage")
+ @Param(description = "The state of the Snapshot. BackedUp means that Snapshot is ready to be used; Creating - the Snapshot is being allocated on the primary storage; BackingUp - the Snapshot is being backed up on secondary storage")
private Snapshot.State state;
@SerializedName(ApiConstants.STATUS)
@@ -104,11 +104,11 @@ public class SnapshotResponse extends BaseResponseWithTagInformation implements
private String status;
@SerializedName(ApiConstants.PHYSICAL_SIZE)
- @Param(description = "physical size of backedup snapshot on image store")
+ @Param(description = "Physical size of backed up Snapshot on image store")
private long physicalSize;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "id of the availability zone")
+ @Param(description = "ID of the availability zone")
private String zoneId;
@SerializedName(ApiConstants.ZONE_NAME)
@@ -116,19 +116,19 @@ public class SnapshotResponse extends BaseResponseWithTagInformation implements
private String zoneName;
@SerializedName(ApiConstants.REVERTABLE)
- @Param(description = "indicates whether the underlying storage supports reverting the volume to this snapshot")
+ @Param(description = "Indicates whether the underlying storage supports reverting the volume to this Snapshot")
private boolean revertable;
@SerializedName(ApiConstants.OS_TYPE_ID)
- @Param(description = "id of the os on volume", since = "4.10")
+ @Param(description = "ID of the os on volume", since = "4.10")
private String osTypeId;
@SerializedName(ApiConstants.OS_DISPLAY_NAME)
- @Param(description = "display name of the os on volume")
+ @Param(description = "Display name of the os on volume")
private String osDisplayName;
@SerializedName(ApiConstants.VIRTUAL_SIZE)
- @Param(description = "virtual size of backedup snapshot on image store")
+ @Param(description = "Virtual size of backedup Snapshot on image store")
private long virtualSize;
@SerializedName(ApiConstants.DATASTORE_ID)
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/SnapshotScheduleResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/SnapshotScheduleResponse.java
index 7bc8ee8cba2..d8ce673d335 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/SnapshotScheduleResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/SnapshotScheduleResponse.java
@@ -26,19 +26,19 @@ import com.cloud.serializer.Param;
public class SnapshotScheduleResponse extends BaseResponse {
@SerializedName("id")
- @Param(description = "the ID of the snapshot schedule")
+ @Param(description = "The ID of the Snapshot schedule")
private String id;
@SerializedName("volumeid")
- @Param(description = "the volume ID the snapshot schedule applied for")
+ @Param(description = "The volume ID the Snapshot schedule applied for")
private String volumeId;
@SerializedName("snapshotpolicyid")
- @Param(description = "the snapshot policy ID used by the snapshot schedule")
+ @Param(description = "The Snapshot policy ID used by the Snapshot schedule")
private String snapshotPolicyId;
@SerializedName("scheduled")
- @Param(description = "time the snapshot is scheduled to be taken")
+ @Param(description = "Time the Snapshot is scheduled to be taken")
private Date scheduled;
public String getId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/SslCertResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/SslCertResponse.java
index aa729f123b4..ff2f9562027 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/SslCertResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/SslCertResponse.java
@@ -37,35 +37,35 @@ public class SslCertResponse extends BaseResponse {
private String id;
@SerializedName(ApiConstants.CERTIFICATE)
- @Param(description = "certificate")
+ @Param(description = "Certificate")
private String certificate;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "account for the certificate")
+ @Param(description = "Account for the certificate")
private String accountName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the certificate")
+ @Param(description = "The project id of the certificate")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the certificate")
+ @Param(description = "The project name of the certificate")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain id of the network owner")
+ @Param(description = "The domain id of the Network owner")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain name of the network owner")
+ @Param(description = "The domain name of the Network owner")
private String domain;
@SerializedName(ApiConstants.CERTIFICATE_CHAIN)
- @Param(description = "certificate chain")
+ @Param(description = "Certificate chain")
private String certchain;
@SerializedName(ApiConstants.CERTIFICATE_FINGERPRINT)
- @Param(description = "certificate fingerprint")
+ @Param(description = "Certificate fingerprint")
private String fingerprint;
@SerializedName(ApiConstants.LOAD_BALANCER_RULE_LIST)
@@ -73,7 +73,7 @@ public class SslCertResponse extends BaseResponse {
List lbIds;
@SerializedName(ApiConstants.NAME)
- @Param(description = "name")
+ @Param(description = "Name")
private String name;
public SslCertResponse() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/StaticRouteResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/StaticRouteResponse.java
index 51f8a130383..395c2cc967b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/StaticRouteResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/StaticRouteResponse.java
@@ -31,11 +31,11 @@ import com.cloud.serializer.Param;
@SuppressWarnings("unused")
public class StaticRouteResponse extends BaseResponse implements ControlledEntityResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of static route")
+ @Param(description = "The ID of static route")
private String id;
@SerializedName(ApiConstants.STATE)
- @Param(description = "the state of the static route")
+ @Param(description = "The state of the static route")
private String state;
@SerializedName(ApiConstants.VPC_ID)
@@ -47,27 +47,27 @@ public class StaticRouteResponse extends BaseResponse implements ControlledEntit
private String gatewayId;
@SerializedName(ApiConstants.CIDR)
- @Param(description = "static route CIDR")
+ @Param(description = "Static route CIDR")
private String cidr;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account associated with the static route")
+ @Param(description = "The Account associated with the static route")
private String accountName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the static route")
+ @Param(description = "The project ID of the static route")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the static route")
+ @Param(description = "The project name of the static route")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the ID of the domain associated with the static route")
+ @Param(description = "The ID of the domain associated with the static route")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain associated with the static route")
+ @Param(description = "The domain associated with the static route")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
@@ -75,7 +75,7 @@ public class StaticRouteResponse extends BaseResponse implements ControlledEntit
private String domainPath;
@SerializedName(ApiConstants.TAGS)
- @Param(description = "the list of resource tags associated with static route", responseObject = ResourceTagResponse.class)
+ @Param(description = "The list of resource tags associated with static route", responseObject = ResourceTagResponse.class)
private List tags;
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/StatsResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/StatsResponse.java
index 5dd76fa5eef..232daa4f4a9 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/StatsResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/StatsResponse.java
@@ -27,59 +27,59 @@ import com.google.gson.annotations.SerializedName;
public class StatsResponse extends BaseResponse {
@SerializedName("timestamp")
- @Param(description = "the time when the VM stats were collected. The format is \"yyyy-MM-dd hh:mm:ss\"")
+ @Param(description = "The time when the Instance stats were collected. The format is 'yyyy-MM-dd hh:mm:ss'")
private Date timestamp;
@SerializedName("cpuused")
- @Param(description = "the amount (percentage) of the VM's CPU currently used")
+ @Param(description = "The amount (percentage) of the Instance's CPU currently used")
private String cpuUsed;
@SerializedName(ApiConstants.DISK_IO_READ)
- @Param(description = "the VM's disk number of read requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration")
+ @Param(description = "The Instance's disk number of read requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration")
protected Long diskIORead;
@SerializedName(ApiConstants.DISK_IO_WRITE)
- @Param(description = "the VM's disk number of write requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration")
+ @Param(description = "The Instance's disk number of write requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration")
protected Long diskIOWrite;
@SerializedName(ApiConstants.DISK_IO_PSTOTAL)
- @Param(description = "the total disk iops since the last stats retrieval")
+ @Param(description = "The total disk IOPS since the last stats retrieval")
protected Long diskIopsTotal = 0L;
@SerializedName(ApiConstants.DISK_KBS_READ)
- @Param(description = "the VM's disk read in KiB")
+ @Param(description = "The Instance's disk read in KiB")
private Long diskKbsRead;
@SerializedName(ApiConstants.DISK_KBS_WRITE)
- @Param(description = "the VM's disk write in KiB")
+ @Param(description = "The Instance's disk write in KiB")
private Long diskKbsWrite;
@SerializedName("memoryintfreekbs")
- @Param(description = "the VM's free memory in KB or -1 if it cannot be gathered")
+ @Param(description = "The Instance's free memory in KB or -1 if it cannot be gathered")
private Long memoryIntFreeKBs;
@SerializedName("memorykbs")
- @Param(description = "the memory used by the VM in KB")
+ @Param(description = "The memory used by the Instance in KB")
private Long memoryKBs;
@SerializedName("memorytargetkbs")
- @Param(description = "the target memory in VM (KB)")
+ @Param(description = "The target memory in Instance (KB)")
private Long memoryTargetKBs;
@SerializedName("networkkbsread")
- @Param(description = "the incoming network traffic on the VM in KiB")
+ @Param(description = "The incoming Network traffic on the Instance in KiB")
protected Long networkKbsRead;
@SerializedName("networkkbswrite")
- @Param(description = "the outgoing network traffic on the host in KiB")
+ @Param(description = "The outgoing Network traffic on the host in KiB")
protected Long networkKbsWrite;
@SerializedName("networkread")
- @Param(description = "the amount of downloaded data by the VM in MiB")
+ @Param(description = "The amount of downloaded data by the Instance in MiB")
protected String networkRead;
@SerializedName("networkwrite")
- @Param(description = "the amount of uploaded data by the VM in MiB")
+ @Param(description = "The amount of uploaded data by the Instance in MiB")
protected String networkWrite;
public void setTimestamp(Date timestamp) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/StorageNetworkIpRangeResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/StorageNetworkIpRangeResponse.java
index 1dc60ce67f3..963d4d18ba6 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/StorageNetworkIpRangeResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/StorageNetworkIpRangeResponse.java
@@ -28,39 +28,39 @@ import com.cloud.serializer.Param;
@EntityReference(value = StorageNetworkIpRange.class)
public class StorageNetworkIpRangeResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the uuid of storage network IP range.")
+ @Param(description = "The UUID of storage Network IP range.")
private String uuid;
@SerializedName(ApiConstants.VLAN)
- @Param(description = "the ID or VID of the VLAN.")
+ @Param(description = "The ID or VID of the VLAN.")
private Integer vlan;
@SerializedName(ApiConstants.POD_ID)
- @Param(description = "the Pod uuid for the storage network IP range")
+ @Param(description = "The Pod UUID for the storage Network IP range")
private String podUuid;
@SerializedName(ApiConstants.START_IP)
- @Param(description = "the start ip of the storage network IP range")
+ @Param(description = "The start IP of the storage Network IP range")
private String startIp;
@SerializedName(ApiConstants.END_IP)
- @Param(description = "the end ip of the storage network IP range")
+ @Param(description = "The end IP of the storage Network IP range")
private String endIp;
@SerializedName(ApiConstants.GATEWAY)
- @Param(description = "the gateway of the storage network IP range")
+ @Param(description = "The gateway of the storage Network IP range")
private String gateway;
@SerializedName(ApiConstants.NETWORK_ID)
- @Param(description = "the network uuid of storage network IP range")
+ @Param(description = "The Network UUID of storage Network IP range")
private String networkUuid;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "the Zone uuid of the storage network IP range")
+ @Param(description = "The Zone UUID of the storage Network IP range")
private String zoneUuid;
@SerializedName(ApiConstants.NETMASK)
- @Param(description = "the netmask of the storage network IP range")
+ @Param(description = "The netmask of the storage Network IP range")
private String netmask;
public void setUuid(String uuid) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/StoragePoolResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/StoragePoolResponse.java
index 676803ea86b..d34feed9d9c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/StoragePoolResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/StoragePoolResponse.java
@@ -30,63 +30,63 @@ import java.util.Map;
@EntityReference(value = StoragePool.class)
public class StoragePoolResponse extends BaseResponseWithAnnotations {
@SerializedName("id")
- @Param(description = "the ID of the storage pool")
+ @Param(description = "The ID of the storage pool")
private String id;
@SerializedName("zoneid")
- @Param(description = "the Zone ID of the storage pool")
+ @Param(description = "The Zone ID of the storage pool")
private String zoneId;
@SerializedName(ApiConstants.ZONE_NAME)
- @Param(description = "the Zone name of the storage pool")
+ @Param(description = "The Zone name of the storage pool")
private String zoneName;
@SerializedName("podid")
- @Param(description = "the Pod ID of the storage pool")
+ @Param(description = "The Pod ID of the storage pool")
private String podId;
@SerializedName("podname")
- @Param(description = "the Pod name of the storage pool")
+ @Param(description = "The Pod name of the storage pool")
private String podName;
@SerializedName("name")
- @Param(description = "the name of the storage pool")
+ @Param(description = "The name of the storage pool")
private String name;
@SerializedName("ipaddress")
- @Param(description = "the IP address of the storage pool")
+ @Param(description = "The IP address of the storage pool")
private String ipAddress;
@SerializedName("path")
- @Param(description = "the storage pool path")
+ @Param(description = "The storage pool path")
private String path;
@SerializedName("created")
- @Param(description = "the date and time the storage pool was created")
+ @Param(description = "The date and time the storage pool was created")
private Date created;
@SerializedName("type")
- @Param(description = "the storage pool type")
+ @Param(description = "The storage pool type")
private String type;
@SerializedName("clusterid")
- @Param(description = "the ID of the cluster for the storage pool")
+ @Param(description = "The ID of the cluster for the storage pool")
private String clusterId;
@SerializedName("clustername")
- @Param(description = "the name of the cluster for the storage pool")
+ @Param(description = "The name of the cluster for the storage pool")
private String clusterName;
@SerializedName("disksizetotal")
- @Param(description = "the total disk size of the storage pool")
+ @Param(description = "The total disk size of the storage pool")
private Long diskSizeTotal;
@SerializedName("disksizeallocated")
- @Param(description = "the host's currently allocated disk size")
+ @Param(description = "The host's currently allocated disk size")
private Long diskSizeAllocated;
@SerializedName("disksizeused")
- @Param(description = "the host's currently used disk size")
+ @Param(description = "The host's currently used disk size")
private Long diskSizeUsed;
@SerializedName("capacityiops")
@@ -94,7 +94,7 @@ public class StoragePoolResponse extends BaseResponseWithAnnotations {
private Long capacityIops;
@SerializedName("allocatediops")
- @Param(description = "total min IOPS currently in use by volumes")
+ @Param(description = "Total min IOPS currently in use by volumes")
private Long allocatedIops;
@SerializedName(ApiConstants.USED_IOPS)
@@ -106,7 +106,7 @@ public class StoragePoolResponse extends BaseResponseWithAnnotations {
private Map customStats;
@SerializedName("tags")
- @Param(description = "the tags for the storage pool")
+ @Param(description = "The tags for the storage pool")
private String tags;
@SerializedName(ApiConstants.NFS_MOUNT_OPTIONS)
@@ -118,23 +118,23 @@ public class StoragePoolResponse extends BaseResponseWithAnnotations {
private Boolean isTagARule;
@SerializedName(ApiConstants.STATE)
- @Param(description = "the state of the storage pool")
+ @Param(description = "The state of the storage pool")
private StoragePoolStatus state;
@SerializedName(ApiConstants.SCOPE)
- @Param(description = "the scope of the storage pool")
+ @Param(description = "The scope of the storage pool")
private String scope;
@SerializedName("overprovisionfactor")
- @Param(description = "the overprovisionfactor for the storage pool", since = "4.4")
+ @Param(description = "The overprovisionfactor for the storage pool", since = "4.4")
private String overProvisionFactor;
@SerializedName(ApiConstants.HYPERVISOR)
- @Param(description = "the hypervisor type of the storage pool")
+ @Param(description = "The hypervisor type of the storage pool")
private String hypervisor;
@SerializedName("suitableformigration")
- @Param(description = "true if this pool is suitable to migrate a volume," + " false otherwise")
+ @Param(description = "True if this pool is suitable to migrate a volume," + " false otherwise")
private Boolean suitableForMigration;
@SerializedName("provider")
@@ -142,7 +142,7 @@ public class StoragePoolResponse extends BaseResponseWithAnnotations {
private String provider;
@SerializedName(ApiConstants.STORAGE_CAPABILITIES)
- @Param(description = "the storage pool capabilities")
+ @Param(description = "The storage pool capabilities")
private Map caps;
@SerializedName(ApiConstants.MANAGED)
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/StorageProviderResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/StorageProviderResponse.java
index d68979a5bcd..e063b88335a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/StorageProviderResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/StorageProviderResponse.java
@@ -26,11 +26,11 @@ import com.cloud.serializer.Param;
public class StorageProviderResponse extends BaseResponse {
@SerializedName("name")
- @Param(description = "the name of the storage provider")
+ @Param(description = "The name of the storage provider")
private String name;
@SerializedName("type")
- @Param(description = "the type of the storage provider: primary or image provider")
+ @Param(description = "The type of the storage provider: primary or image provider")
private String type;
/**
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/StorageTagResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/StorageTagResponse.java
index 7d8db39b4e9..fc6527f7e4c 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/StorageTagResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/StorageTagResponse.java
@@ -22,15 +22,15 @@ import com.cloud.serializer.Param;
public class StorageTagResponse extends BaseResponse {
@SerializedName("id")
- @Param(description = "the ID of the storage tag")
+ @Param(description = "The ID of the storage tag")
private String id;
@SerializedName("poolid")
- @Param(description = "the pool ID of the storage tag")
+ @Param(description = "The pool ID of the storage tag")
private long poolId;
@SerializedName("name")
- @Param(description = "the name of the storage tag")
+ @Param(description = "The name of the storage tag")
private String name;
public String getId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/SuccessResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/SuccessResponse.java
index 0dde6d0e423..3c03fb7b3bc 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/SuccessResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/SuccessResponse.java
@@ -24,11 +24,11 @@ import com.cloud.serializer.Param;
public class SuccessResponse extends BaseResponse {
@SerializedName("success")
- @Param(description = "true if operation is executed successfully")
+ @Param(description = "True if operation is executed successfully")
private Boolean success = true;
@SerializedName("displaytext")
- @Param(description = "any text associated with the success or failure")
+ @Param(description = "Any text associated with the success or failure")
private String displayText;
public Boolean getSuccess() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/SystemVmInstanceResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/SystemVmInstanceResponse.java
index 5e0638080b9..5f94537d4db 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/SystemVmInstanceResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/SystemVmInstanceResponse.java
@@ -27,27 +27,27 @@ import com.cloud.serializer.Param;
*/
public class SystemVmInstanceResponse extends BaseResponse {
@SerializedName("id")
- @Param(description = "the ID of the system VM")
+ @Param(description = "The ID of the System VM")
private String id;
@SerializedName("systemvmtype")
- @Param(description = "the system VM type")
+ @Param(description = "The System VM type")
private String systemVmType;
@SerializedName("name")
- @Param(description = "the name of the system VM")
+ @Param(description = "The name of the System VM")
private String name;
@SerializedName("hostid")
- @Param(description = "the host ID for the system VM")
+ @Param(description = "The host ID for the System VM")
private String hostId;
@SerializedName("state")
- @Param(description = "the state of the system VM")
+ @Param(description = "The state of the System VM")
private String state;
@SerializedName("role")
- @Param(description = "the role of the system VM")
+ @Param(description = "The role of the System VM")
private String role;
public String getId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/SystemVmResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/SystemVmResponse.java
index be9f14f5060..316852552dc 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/SystemVmResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/SystemVmResponse.java
@@ -31,151 +31,151 @@ import com.google.gson.annotations.SerializedName;
@EntityReference(value = VirtualMachine.class)
public class SystemVmResponse extends BaseResponseWithAnnotations {
@SerializedName("id")
- @Param(description = "the ID of the system VM")
+ @Param(description = "The ID of the System VM")
private String id;
@SerializedName("systemvmtype")
- @Param(description = "the system VM type")
+ @Param(description = "The System VM type")
private String systemVmType;
@SerializedName("jobid")
- @Param(description = "the job ID associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.")
+ @Param(description = "The job ID associated with the System VM. This is only displayed if the router listed is part of a currently running asynchronous job.")
private String jobId;
@SerializedName("jobstatus")
- @Param(description = "the job status associated with the system VM. This is only displayed if the router listed is part of a currently running asynchronous job.")
+ @Param(description = "The job status associated with the System VM. This is only displayed if the router listed is part of a currently running asynchronous job.")
private Integer jobStatus;
@SerializedName("zoneid")
- @Param(description = "the Zone ID for the system VM")
+ @Param(description = "The Zone ID for the System VM")
private String zoneId;
@SerializedName(ApiConstants.ZONE_NAME)
- @Param(description = "the Zone name for the system VM")
+ @Param(description = "The Zone name for the System VM")
private String zoneName;
@SerializedName("dns1")
- @Param(description = "the first DNS for the system VM")
+ @Param(description = "The first DNS for the System VM")
private String dns1;
@SerializedName("dns2")
- @Param(description = "the second DNS for the system VM")
+ @Param(description = "The second DNS for the System VM")
private String dns2;
@SerializedName("networkdomain")
- @Param(description = "the network domain for the system VM")
+ @Param(description = "The Network domain for the System VM")
private String networkDomain;
@SerializedName("gateway")
- @Param(description = "the gateway for the system VM")
+ @Param(description = "The gateway for the System VM")
private String gateway;
@SerializedName("name")
- @Param(description = "the name of the system VM")
+ @Param(description = "The name of the System VM")
private String name;
@SerializedName("podid")
- @Param(description = "the Pod ID for the system VM")
+ @Param(description = "The Pod ID for the System VM")
private String podId;
@SerializedName("podname")
- @Param(description = "the Pod name for the system VM", since = "4.13.2")
+ @Param(description = "The Pod name for the System VM", since = "4.13.2")
private String podName;
@SerializedName("hostid")
- @Param(description = "the host ID for the system VM")
+ @Param(description = "The host ID for the System VM")
private String hostId;
@SerializedName("hostname")
- @Param(description = "the hostname for the system VM")
+ @Param(description = "The hostname for the System VM")
private String hostName;
@SerializedName(ApiConstants.HOST_CONTROL_STATE)
- @Param(description = "the control state of the host for the system VM")
+ @Param(description = "The control state of the host for the System VM")
private String hostControlState;
@SerializedName("hypervisor")
- @Param(description = "the hypervisor on which the template runs")
+ @Param(description = "The hypervisor on which the Template runs")
private String hypervisor;
@SerializedName(ApiConstants.PRIVATE_IP)
- @Param(description = "the private IP address for the system VM")
+ @Param(description = "The private IP address for the System VM")
private String privateIp;
@SerializedName(ApiConstants.PRIVATE_MAC_ADDRESS)
- @Param(description = "the private MAC address for the system VM")
+ @Param(description = "The private MAC address for the System VM")
private String privateMacAddress;
@SerializedName(ApiConstants.PRIVATE_NETMASK)
- @Param(description = "the private netmask for the system VM")
+ @Param(description = "The private netmask for the System VM")
private String privateNetmask;
@SerializedName(ApiConstants.LINK_LOCAL_IP)
- @Param(description = "the link local IP address for the system vm")
+ @Param(description = "The Control IP address for the System VM")
private String linkLocalIp;
@SerializedName(ApiConstants.LINK_LOCAL_MAC_ADDRESS)
- @Param(description = "the link local MAC address for the system vm")
+ @Param(description = "The link local MAC address for the System VM")
private String linkLocalMacAddress;
@SerializedName(ApiConstants.LINK_LOCAL_MAC_NETMASK)
- @Param(description = "the link local netmask for the system vm")
+ @Param(description = "The link local netmask for the System VM")
private String linkLocalNetmask;
@SerializedName("publicip")
- @Param(description = "the public IP address for the system VM")
+ @Param(description = "The public IP address for the System VM")
private String publicIp;
@SerializedName("publicmacaddress")
- @Param(description = "the public MAC address for the system VM")
+ @Param(description = "The public MAC address for the System VM")
private String publicMacAddress;
@SerializedName("publicnetmask")
- @Param(description = "the public netmask for the system VM")
+ @Param(description = "The public netmask for the System VM")
private String publicNetmask;
@SerializedName("templateid")
- @Param(description = "the template ID for the system VM")
+ @Param(description = "The Template ID for the System VM")
private String templateId;
@SerializedName("templatename")
- @Param(description = "the template name for the system VM", since = "4.13.2")
+ @Param(description = "The Template name for the System VM", since = "4.13.2")
private String templateName;
@SerializedName("created")
- @Param(description = "the date and time the system VM was created")
+ @Param(description = "The date and time the System VM was created")
private Date created;
@SerializedName("state")
- @Param(description = "the state of the system VM")
+ @Param(description = "The state of the System VM")
private String state;
@SerializedName("agentstate")
- @Param(description = "the agent state of the system VM", since = "4.13.1")
+ @Param(description = "The agent state of the System VM", since = "4.13.1")
private String agentState;
@SerializedName("activeviewersessions")
- @Param(description = "the number of active console sessions for the console proxy system vm")
+ @Param(description = "The number of active console sessions for the console proxy System VM")
private Integer activeViewerSessions;
@SerializedName("guestvlan")
- @Param(description = "guest vlan range")
+ @Param(description = "Guest VLAN range")
private String guestVlan;
@SerializedName("publicvlan")
- @Param(description = "public vlan range")
+ @Param(description = "Public VLAN range")
private List publicVlan;
@SerializedName("disconnected")
- @Param(description = "the last disconnected date of host", since = "4.13.1")
+ @Param(description = "The last disconnected date of host", since = "4.13.1")
private Date disconnectedOn;
@SerializedName("version")
- @Param(description = "the systemvm agent version", since = "4.13.1")
+ @Param(description = "The systemvm agent version", since = "4.13.1")
private String version;
@SerializedName(ApiConstants.IS_DYNAMICALLY_SCALABLE)
- @Param(description = "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.")
+ @Param(description = "True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.")
private Boolean isDynamicallyScalable;
@SerializedName(ApiConstants.SERVICE_OFFERING_ID)
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/TemplateOVFPropertyResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/TemplateOVFPropertyResponse.java
index ebe0d1cfd0d..715d0e980ef 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/TemplateOVFPropertyResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/TemplateOVFPropertyResponse.java
@@ -27,43 +27,43 @@ import org.apache.cloudstack.api.BaseResponse;
public class TemplateOVFPropertyResponse extends BaseResponse {
@SerializedName(ApiConstants.KEY)
- @Param(description = "the ovf property key")
+ @Param(description = "The ovf property key")
private String key;
@SerializedName(ApiConstants.TYPE)
- @Param(description = "the ovf property type")
+ @Param(description = "The ovf property type")
private String type;
@SerializedName(ApiConstants.VALUE)
- @Param(description = "the ovf property value")
+ @Param(description = "The ovf property value")
private String value;
@SerializedName(ApiConstants.PASSWORD)
- @Param(description = "is the ovf property a password")
+ @Param(description = "Is the ovf property a password")
private Boolean password;
@SerializedName(ApiConstants.QUALIFIERS)
- @Param(description = "the ovf property qualifiers")
+ @Param(description = "The ovf property qualifiers")
private String qualifiers;
@SerializedName(ApiConstants.USER_CONFIGURABLE)
- @Param(description = "is the ovf property user configurable")
+ @Param(description = "Is the ovf property user configurable")
private Boolean userConfigurable;
@SerializedName(ApiConstants.LABEL)
- @Param(description = "the ovf property label")
+ @Param(description = "The ovf property label")
private String label;
@SerializedName(ApiConstants.DESCRIPTION)
- @Param(description = "the ovf property label")
+ @Param(description = "The ovf property label")
private String description;
@SerializedName(ApiConstants.INDEX)
- @Param(description = "the ovf property index")
+ @Param(description = "The ovf property index")
private Integer index;
@SerializedName(ApiConstants.CATEGORY)
- @Param(description = "the ovf property category")
+ @Param(description = "The ovf property category")
private String category;
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/TemplatePermissionsResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/TemplatePermissionsResponse.java
index 5f0b9a58c7c..c489deaffe5 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/TemplatePermissionsResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/TemplatePermissionsResponse.java
@@ -31,23 +31,23 @@ import com.cloud.template.VirtualMachineTemplate;
@SuppressWarnings("unused")
public class TemplatePermissionsResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the template ID")
+ @Param(description = "The Template ID")
private String id;
@SerializedName(ApiConstants.IS_PUBLIC)
- @Param(description = "true if this template is a public template, false otherwise")
+ @Param(description = "True if this Template is a public Template, false otherwise")
private Boolean publicTemplate;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the ID of the domain to which the template belongs")
+ @Param(description = "The ID of the domain to which the Template belongs")
private String domainId;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the list of accounts the template is available for")
+ @Param(description = "The list of Accounts the Template is available for")
private List accountNames;
@SerializedName(ApiConstants.PROJECT_IDS)
- @Param(description = "the list of projects the template is available for")
+ @Param(description = "The list of projects the Template is available for")
private List projectIds;
public void setId(String id) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/TemplateResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/TemplateResponse.java
index 98e96091d8c..2250d03a6c6 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/TemplateResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/TemplateResponse.java
@@ -36,151 +36,151 @@ import com.google.gson.annotations.SerializedName;
@SuppressWarnings("unused")
public class TemplateResponse extends BaseResponseWithTagInformation implements ControlledViewEntityResponse, SetResourceIconResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the template ID")
+ @Param(description = "The Template ID")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the template name")
+ @Param(description = "The Template name")
private String name;
@SerializedName(ApiConstants.DISPLAY_TEXT)
- @Param(description = "the template display text")
+ @Param(description = "The Template display text")
private String displayText;
@SerializedName(ApiConstants.IS_PUBLIC)
// propName="public" (FIXME: this used to be part of Param annotation, do we need it?)
- @Param(description = "true if this template is a public template, false otherwise")
+ @Param(description = "True if this Template is a public Template, false otherwise")
private boolean isPublic;
@SerializedName(ApiConstants.CREATED)
- @Param(description = "the date this template was created")
+ @Param(description = "The date this Template was created")
private Date created;
@SerializedName(ApiConstants.REMOVED)
- @Param(description = "the date this template was removed")
+ @Param(description = "The date this Template was removed")
private Date removed;
@SerializedName(ApiConstants.IS_READY)
// propName="ready" (FIXME: this used to be part of Param annotation, do we need it?)
- @Param(description = "true if the template is ready to be deployed from, false otherwise.")
+ @Param(description = "True if the Template is ready to be deployed from, false otherwise.")
private boolean isReady;
@SerializedName(ApiConstants.PASSWORD_ENABLED)
- @Param(description = "true if the reset password feature is enabled, false otherwise")
+ @Param(description = "True if the reset password feature is enabled, false otherwise")
private Boolean passwordEnabled;
@SerializedName(ApiConstants.FORMAT)
- @Param(description = "the format of the template.")
+ @Param(description = "The format of the Template.")
private ImageFormat format;
@SerializedName(ApiConstants.BOOTABLE)
- @Param(description = "true if the ISO is bootable, false otherwise")
+ @Param(description = "True if the ISO is bootable, false otherwise")
private Boolean bootable;
@SerializedName(ApiConstants.IS_FEATURED)
- @Param(description = "true if this template is a featured template, false otherwise")
+ @Param(description = "True if this Template is a featured Template, false otherwise")
private boolean featured;
@SerializedName(ApiConstants.CROSS_ZONES)
- @Param(description = "true if the template is managed across all Zones, false otherwise")
+ @Param(description = "True if the Template is managed across all Zones, false otherwise")
private boolean crossZones;
@SerializedName(ApiConstants.OS_TYPE_ID)
- @Param(description = "the ID of the OS type for this template.")
+ @Param(description = "The ID of the OS type for this Template.")
private String osTypeId;
@SerializedName("ostypename")
- @Param(description = "the name of the OS type for this template.")
+ @Param(description = "The name of the OS type for this Template.")
private String osTypeName;
@SerializedName(ApiConstants.ACCOUNT_ID)
- @Param(description = "the account id to which the template belongs")
+ @Param(description = "The Account id to which the Template belongs")
private String accountId;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account name to which the template belongs")
+ @Param(description = "The Account name to which the Template belongs")
private String account;
//TODO: since a template can be associated to more than one zones, this model is not accurate. For backward-compatibility, keep these fields
// here, but add a zones field to capture multiple zones.
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "the ID of the zone for this template")
+ @Param(description = "The ID of the zone for this Template")
private String zoneId;
@SerializedName(ApiConstants.ZONE_NAME)
- @Param(description = "the name of the zone for this template")
+ @Param(description = "The name of the zone for this Template")
private String zoneName;
@SerializedName(ApiConstants.STATUS)
- @Param(description = "the status of the template")
+ @Param(description = "The status of the Template")
private String status;
@SerializedName(ApiConstants.SIZE)
- @Param(description = "the size of the template")
+ @Param(description = "The size of the Template")
private Long size;
@SerializedName(ApiConstants.PHYSICAL_SIZE)
- @Param(description = "the physical size of the template")
+ @Param(description = "The physical size of the Template")
private Long physicalSize;
@SerializedName(ApiConstants.TEMPLATE_TYPE)
- @Param(description = "the type of the template")
+ @Param(description = "The type of the Template")
private String templateType;
@SerializedName(ApiConstants.HYPERVISOR)
- @Param(description = "the hypervisor on which the template runs")
+ @Param(description = "The hypervisor on which the Template runs")
private String hypervisor;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the name of the domain to which the template belongs")
+ @Param(description = "The name of the domain to which the Template belongs")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
- @Param(description = "path of the Domain the template belongs to", since = "4.19.2.0")
+ @Param(description = "Path of the Domain the template belongs to", since = "4.19.2.0")
private String domainPath;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the ID of the domain to which the template belongs")
+ @Param(description = "The ID of the domain to which the Template belongs")
private String domainId;
@SerializedName(ApiConstants.IS_EXTRACTABLE)
- @Param(description = "true if the template is extractable, false otherwise")
+ @Param(description = "True if the Template is extractable, false otherwise")
private Boolean extractable;
@SerializedName(ApiConstants.CHECKSUM)
- @Param(description = "checksum of the template")
+ @Param(description = "Checksum of the Template")
private String checksum;
@SerializedName(ApiConstants.SOURCETEMPLATEID)
- @Param(description = "the template ID of the parent template if present")
+ @Param(description = "The Template ID of the parent Template if present")
private String sourcetemplateId;
@SerializedName(ApiConstants.HOST_ID)
- @Param(description = "the ID of the secondary storage host for the template")
+ @Param(description = "The ID of the secondary storage host for the Template")
private String hostId;
@SerializedName(ApiConstants.HOST_NAME)
- @Param(description = "the name of the secondary storage host for the template")
+ @Param(description = "The name of the secondary storage host for the Template")
private String hostName;
@SerializedName(ApiConstants.TEMPLATE_TAG)
- @Param(description = "the tag of this template")
+ @Param(description = "The tag of this Template")
private String templateTag;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the template")
+ @Param(description = "The project ID of the Template")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the template")
+ @Param(description = "The project name of the Template")
private String projectName;
@SerializedName(ApiConstants.DETAILS)
- @Param(description = "additional key/value details tied with template")
+ @Param(description = "Additional key/value details tied with Template")
private Map details;
@SerializedName(ApiConstants.DOWNLOAD_DETAILS)
- @Param(description = "Lists the download progress of a template across all secondary storages")
+ @Param(description = "Lists the download progress of a Template across all secondary storages")
private List> downloadDetails;
@SerializedName(ApiConstants.ARCH)
@@ -188,63 +188,63 @@ public class TemplateResponse extends BaseResponseWithTagInformation implements
private String arch;
@SerializedName(ApiConstants.BITS)
- @Param(description = "the processor bit size", since = "4.10")
+ @Param(description = "The processor bit size", since = "4.10")
private int bits;
@SerializedName(ApiConstants.SSHKEY_ENABLED)
- @Param(description = "true if template is sshkey enabled, false otherwise")
+ @Param(description = "True if Template is sshkey enabled, false otherwise")
private Boolean sshKeyEnabled;
@SerializedName(ApiConstants.IS_DYNAMICALLY_SCALABLE)
- @Param(description = "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory")
+ @Param(description = "True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory")
private Boolean isDynamicallyScalable;
@SerializedName(ApiConstants.DIRECT_DOWNLOAD)
- @Param(description = "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage")
+ @Param(description = "KVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage")
private Boolean directDownload;
@SerializedName(ApiConstants.DEPLOY_AS_IS)
- @Param(description = "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.",
+ @Param(description = "VMware only: true if Template is deployed without orchestrating disks and Networks but \"as-is\" defined in the Template.",
since = "4.15")
private Boolean deployAsIs;
@SerializedName(ApiConstants.DEPLOY_AS_IS_DETAILS)
- @Param(description = "VMware only: additional key/value details tied with deploy-as-is template",
+ @Param(description = "VMware only: additional key/value details tied with deploy-as-is Template",
since = "4.15")
private Map deployAsIsDetails;
@SerializedName("parenttemplateid")
- @Param(description = "if Datadisk template, then id of the root disk template this template belongs to")
+ @Param(description = "If Datadisk Template, then id of the root disk Template this Template belongs to")
@Deprecated(since = "4.15")
private String parentTemplateId;
@SerializedName("childtemplates")
- @Param(description = "if root disk template, then ids of the datas disk templates this template owns")
+ @Param(description = "If root disk Template, then IDs of the datas disk Templates this Template owns")
@Deprecated(since = "4.15")
private Set childTemplates;
@SerializedName(ApiConstants.REQUIRES_HVM)
- @Param(description = "true if template requires HVM enabled, false otherwise")
+ @Param(description = "True if Template requires HVM enabled, false otherwise")
private Boolean requiresHvm;
@SerializedName(ApiConstants.URL)
- @Param(description = "the URL which the template/iso is registered from")
+ @Param(description = "The URL which the Template/ISO is registered from")
private String url;
@SerializedName(ApiConstants.RESOURCE_ICON)
@Param(description = "Base64 string representation of the resource icon", since = "4.16.0.0")
ResourceIconResponse icon;
- @SerializedName(ApiConstants.USER_DATA_ID) @Param(description="the id of userdata linked to this template", since = "4.18.0")
+ @SerializedName(ApiConstants.USER_DATA_ID) @Param(description = "The id of userdata linked to this Template", since = "4.18.0")
private String userDataId;
- @SerializedName(ApiConstants.USER_DATA_NAME) @Param(description="the name of userdata linked to this template", since = "4.18.0")
+ @SerializedName(ApiConstants.USER_DATA_NAME) @Param(description = "The name of userdata linked to this Template", since = "4.18.0")
private String userDataName;
- @SerializedName(ApiConstants.USER_DATA_POLICY) @Param(description="the userdata override policy with the userdata provided while deploying VM", since = "4.18.0")
+ @SerializedName(ApiConstants.USER_DATA_POLICY) @Param(description = "The userdata override policy with the userdata provided while deploying Instance", since = "4.18.0")
private String userDataPolicy;
- @SerializedName(ApiConstants.USER_DATA_PARAMS) @Param(description="list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", since = "4.18.0")
+ @SerializedName(ApiConstants.USER_DATA_PARAMS) @Param(description = "List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata", since = "4.18.0")
private String userDataParams;
public TemplateResponse() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/TrafficMonitorResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/TrafficMonitorResponse.java
index b19c422a5af..0251b2ab455 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/TrafficMonitorResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/TrafficMonitorResponse.java
@@ -26,23 +26,23 @@ import com.cloud.serializer.Param;
public class TrafficMonitorResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the external firewall")
+ @Param(description = "The ID of the external firewall")
private String id;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "the zone ID of the external firewall")
+ @Param(description = "The zone ID of the external firewall")
private String zoneId;
@SerializedName(ApiConstants.IP_ADDRESS)
- @Param(description = "the management IP address of the external firewall")
+ @Param(description = "The management IP address of the external firewall")
private String ipAddress;
@SerializedName(ApiConstants.NUM_RETRIES)
- @Param(description = "the number of times to retry requests to the external firewall")
+ @Param(description = "The number of times to retry requests to the external firewall")
private String numRetries;
@SerializedName(ApiConstants.TIMEOUT)
- @Param(description = "the timeout (in seconds) for requests to the external firewall")
+ @Param(description = "The timeout (in seconds) for requests to the external firewall")
private String timeout;
public String getId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/TrafficTypeImplementorResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/TrafficTypeImplementorResponse.java
index ebcd7c9a0d4..29512c2cdd5 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/TrafficTypeImplementorResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/TrafficTypeImplementorResponse.java
@@ -25,11 +25,11 @@ import com.cloud.serializer.Param;
public class TrafficTypeImplementorResponse extends BaseResponse {
@SerializedName(ApiConstants.TRAFFIC_TYPE)
- @Param(description = "network traffic type")
+ @Param(description = "Network traffic type")
private String trafficType;
@SerializedName(ApiConstants.TRAFFIC_TYPE_IMPLEMENTOR)
- @Param(description = "implementor of network traffic type")
+ @Param(description = "Implementor of Network traffic type")
private String implementor;
public void setTrafficType(String type) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/TrafficTypeResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/TrafficTypeResponse.java
index 9a79b072465..bbf7159a485 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/TrafficTypeResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/TrafficTypeResponse.java
@@ -29,35 +29,35 @@ import com.cloud.serializer.Param;
public class TrafficTypeResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "id of the network provider")
+ @Param(description = "ID of the Network provider")
private String id;
@SerializedName(ApiConstants.TRAFFIC_TYPE)
- @Param(description = "the trafficType to be added to the physical network")
+ @Param(description = "The trafficType to be added to the physical Network")
private String trafficType;
@SerializedName(ApiConstants.PHYSICAL_NETWORK_ID)
- @Param(description = "the physical network this belongs to")
+ @Param(description = "The physical Network this belongs to")
private String physicalNetworkId;
@SerializedName(ApiConstants.XENSERVER_NETWORK_LABEL)
- @Param(description = "The network name label of the physical device dedicated to this traffic on a XenServer host")
+ @Param(description = "The Network name label of the physical device dedicated to this traffic on a XenServer host")
private String xenNetworkLabel;
@SerializedName(ApiConstants.KVM_NETWORK_LABEL)
- @Param(description = "The network name label of the physical device dedicated to this traffic on a KVM host")
+ @Param(description = "The Network name label of the physical device dedicated to this traffic on a KVM host")
private String kvmNetworkLabel;
@SerializedName(ApiConstants.VMWARE_NETWORK_LABEL)
- @Param(description = "The network name label of the physical device dedicated to this traffic on a VMware host")
+ @Param(description = "The Network name label of the physical device dedicated to this traffic on a VMware host")
private String vmwareNetworkLabel;
@SerializedName(ApiConstants.HYPERV_NETWORK_LABEL)
- @Param(description = "The network name label of the physical device dedicated to this traffic on a HyperV host")
+ @Param(description = "The Network name label of the physical device dedicated to this traffic on a HyperV host")
private String hypervNetworkLabel;
@SerializedName(ApiConstants.OVM3_NETWORK_LABEL)
- @Param(description = "The network name of the physical device dedicated to this traffic on an OVM3 host")
+ @Param(description = "The Network name of the physical device dedicated to this traffic on an OVM3 host")
private String ovm3NetworkLabel;
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/UnmanageVMInstanceResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/UnmanageVMInstanceResponse.java
index cec70f20cff..1da5ab89a60 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/UnmanageVMInstanceResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/UnmanageVMInstanceResponse.java
@@ -25,11 +25,11 @@ import org.apache.cloudstack.api.BaseResponse;
public class UnmanageVMInstanceResponse extends BaseResponse {
@SerializedName(ApiConstants.RESULT)
- @Param(description = "result of the unmanage VM operation")
+ @Param(description = "Result of the unmanage Instance operation")
private boolean success;
@SerializedName(ApiConstants.DETAILS)
- @Param(description = "details of the unmanage VM operation")
+ @Param(description = "Details of the unmanage Instance operation")
private String details;
public UnmanageVMInstanceResponse() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/UnmanagedInstanceDiskResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/UnmanagedInstanceDiskResponse.java
index 083c83fbf85..4367164722b 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/UnmanagedInstanceDiskResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/UnmanagedInstanceDiskResponse.java
@@ -26,47 +26,47 @@ import com.google.gson.annotations.SerializedName;
public class UnmanagedInstanceDiskResponse extends BaseResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the disk")
+ @Param(description = "The ID of the disk")
private String diskId;
@SerializedName(ApiConstants.LABEL)
- @Param(description = "the label of the disk")
+ @Param(description = "The label of the disk")
private String label;
@SerializedName(ApiConstants.CAPACITY)
- @Param(description = "the capacity of the disk in bytes")
+ @Param(description = "The capacity of the disk in bytes")
private Long capacity;
@SerializedName(ApiConstants.IMAGE_PATH)
- @Param(description = "the file path of the disk image")
+ @Param(description = "The file path of the disk image")
private String imagePath;
@SerializedName(ApiConstants.CONTROLLER)
- @Param(description = "the controller of the disk")
+ @Param(description = "The controller of the disk")
private String controller;
@SerializedName(ApiConstants.CONTROLLER_UNIT)
- @Param(description = "the controller unit of the disk")
+ @Param(description = "The controller unit of the disk")
private Integer controllerUnit;
@SerializedName(ApiConstants.POSITION)
- @Param(description = "the position of the disk")
+ @Param(description = "The position of the disk")
private Integer position;
@SerializedName(ApiConstants.DATASTORE_NAME)
- @Param(description = "the controller of the disk")
+ @Param(description = "The controller of the disk")
private String datastoreName;
@SerializedName(ApiConstants.DATASTORE_HOST)
- @Param(description = "the controller of the disk")
+ @Param(description = "The controller of the disk")
private String datastoreHost;
@SerializedName(ApiConstants.DATASTORE_PATH)
- @Param(description = "the controller of the disk")
+ @Param(description = "The controller of the disk")
private String datastorePath;
@SerializedName(ApiConstants.DATASTORE_TYPE)
- @Param(description = "the controller of the disk")
+ @Param(description = "The controller of the disk")
private String datastoreType;
public String getDiskId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/UnmanagedInstanceResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/UnmanagedInstanceResponse.java
index c1156f5f23a..195323b741d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/UnmanagedInstanceResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/UnmanagedInstanceResponse.java
@@ -32,11 +32,11 @@ import com.google.gson.annotations.SerializedName;
public class UnmanagedInstanceResponse extends BaseResponse {
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the virtual machine")
+ @Param(description = "The name of the Instance")
private String name;
@SerializedName(ApiConstants.CLUSTER_ID)
- @Param(description = "the ID of the cluster to which virtual machine belongs")
+ @Param(description = "The ID of the cluster to which Instance belongs")
private String clusterId;
@SerializedName(ApiConstants.CLUSTER_NAME)
@@ -44,39 +44,39 @@ public class UnmanagedInstanceResponse extends BaseResponse {
private String clusterName;
@SerializedName(ApiConstants.HOST_ID)
- @Param(description = "the ID of the host to which virtual machine belongs")
+ @Param(description = "The ID of the host to which Instance belongs")
private String hostId;
@SerializedName(ApiConstants.HOST_NAME)
- @Param(description = "the name of the host to which virtual machine belongs")
+ @Param(description = "The name of the host to which Instance belongs")
private String hostName;
@SerializedName(ApiConstants.POWER_STATE)
- @Param(description = "the power state of the virtual machine")
+ @Param(description = "The power state of the Instance")
private String powerState;
@SerializedName(ApiConstants.CPU_NUMBER)
- @Param(description = "the CPU cores of the virtual machine")
+ @Param(description = "The CPU cores of the Instance")
private Integer cpuCores;
@SerializedName(ApiConstants.CPU_CORE_PER_SOCKET)
- @Param(description = "the CPU cores per socket for the virtual machine. VMware specific")
+ @Param(description = "The CPU cores per socket for the Instance. VMware specific")
private Integer cpuCoresPerSocket;
@SerializedName(ApiConstants.CPU_SPEED)
- @Param(description = "the CPU speed of the virtual machine")
+ @Param(description = "The CPU speed of the Instance")
private Integer cpuSpeed;
@SerializedName(ApiConstants.MEMORY)
- @Param(description = "the memory of the virtual machine in MB")
+ @Param(description = "The memory of the Instance in MB")
private Integer memory;
@SerializedName(ApiConstants.OS_ID)
- @Param(description = "the operating system ID of the virtual machine")
+ @Param(description = "The operating system ID of the Instance")
private String operatingSystemId;
@SerializedName(ApiConstants.OS_DISPLAY_NAME)
- @Param(description = "the operating system of the virtual machine")
+ @Param(description = "The operating system of the Instance")
private String operatingSystem;
@SerializedName(ApiConstants.BOOT_MODE)
@@ -88,11 +88,11 @@ public class UnmanagedInstanceResponse extends BaseResponse {
private String bootType;
@SerializedName(ApiConstants.DISK)
- @Param(description = "the list of disks associated with the virtual machine", responseObject = UnmanagedInstanceDiskResponse.class)
+ @Param(description = "The list of disks associated with the Instance", responseObject = UnmanagedInstanceDiskResponse.class)
private Set disks;
@SerializedName(ApiConstants.NIC)
- @Param(description = "the list of nics associated with the virtual machine", responseObject = NicResponse.class)
+ @Param(description = "The list of NICs associated with the Instance", responseObject = NicResponse.class)
private Set nics;
public UnmanagedInstanceResponse() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/UpgradeRouterTemplateResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/UpgradeRouterTemplateResponse.java
index d89631ae428..3174fa48067 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/UpgradeRouterTemplateResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/UpgradeRouterTemplateResponse.java
@@ -29,7 +29,7 @@ import com.cloud.serializer.Param;
@SuppressWarnings("unused")
public class UpgradeRouterTemplateResponse extends BaseResponse {
@SerializedName(ApiConstants.JOB_ID)
- @Param(description = "the id of AsyncJob")
+ @Param(description = "The ID of AsyncJob")
private String asyncJobId;
public String getAsyncJobId() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/UsageRecordResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/UsageRecordResponse.java
index 4aeded64287..21b421e66bf 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/UsageRecordResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/UsageRecordResponse.java
@@ -29,119 +29,119 @@ import com.google.gson.annotations.SerializedName;
@SuppressWarnings("unused")
public class UsageRecordResponse extends BaseResponseWithTagInformation implements ControlledEntityResponse {
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the user account name")
+ @Param(description = "The user Account name")
private String accountName;
@SerializedName(ApiConstants.ACCOUNT_ID)
- @Param(description = "the user account Id")
+ @Param(description = "The user Account ID")
private String accountId;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the resource")
+ @Param(description = "The project ID of the resource")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the resource")
+ @Param(description = "The project name of the resource")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the domain ID")
+ @Param(description = "The domain ID")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the domain the resource is associated with")
+ @Param(description = "The domain the resource is associated with")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
- @Param(description = "path of the domain to which the usage reocrd belongs", since = "4.19.2.0")
+ @Param(description = "Path of the domain to which the usage reocrd belongs", since = "4.19.2.0")
private String domainPath;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "the zone ID")
+ @Param(description = "The zone ID")
private String zoneId;
@SerializedName(ApiConstants.DESCRIPTION)
- @Param(description = "description of the usage record")
+ @Param(description = "Description of the usage record")
private String description;
@SerializedName("usage")
- @Param(description = "usage in hours")
+ @Param(description = "Usage in hours")
private String usage;
@SerializedName("usagetype")
- @Param(description = "usage type ID")
+ @Param(description = "Usage type ID")
private Integer usageType;
@SerializedName("rawusage")
- @Param(description = "raw usage in hours")
+ @Param(description = "Raw usage in hours")
private String rawUsage;
@SerializedName(ApiConstants.VIRTUAL_MACHINE_ID)
- @Param(description = "virtual machine ID")
+ @Param(description = "Instance ID")
private String virtualMachineId;
@SerializedName(ApiConstants.NAME)
- @Param(description = "resource or virtual machine name")
+ @Param(description = "Resource or Instance name")
private String resourceName;
@SerializedName("offeringid")
- @Param(description = "offering ID")
+ @Param(description = "Offering ID")
private String offeringId;
@SerializedName(ApiConstants.TEMPLATE_ID)
- @Param(description = "template ID")
+ @Param(description = "Template ID")
private String templateId;
@SerializedName(ApiConstants.OS_TYPE_ID)
- @Param(description = "virtual machine os type ID")
+ @Param(description = "Instance os type ID")
private String osTypeId;
@SerializedName(ApiConstants.OS_DISPLAY_NAME)
- @Param(description = "virtual machine os display name")
+ @Param(description = "Instance os display name")
private String osDisplayName;
@SerializedName(ApiConstants.OS_CATEGORY_ID)
- @Param(description = "virtual machine guest os category ID")
+ @Param(description = "Instance guest os category ID")
private String osCategoryId;
@SerializedName(ApiConstants.OS_CATEGORY_NAME)
- @Param(description = "virtual machine os category name")
+ @Param(description = "Instance os category name")
private String osCategoryName;
@SerializedName("usageid")
- @Param(description = "id of the resource")
+ @Param(description = "ID of the resource")
private String usageId;
@SerializedName(ApiConstants.TYPE)
- @Param(description = "resource type")
+ @Param(description = "Resource type")
private String type;
@SerializedName(ApiConstants.SIZE)
- @Param(description = "resource size")
+ @Param(description = "Resource size")
private Long size;
@SerializedName("virtualsize")
- @Param(description = "virtual size of resource")
+ @Param(description = "Virtual size of resource")
private Long virtualSize;
@SerializedName(ApiConstants.CPU_NUMBER)
- @Param(description = "number of cpu of resource")
+ @Param(description = "Number of CPU of resource")
private Long cpuNumber;
@SerializedName(ApiConstants.CPU_SPEED)
- @Param(description = "speed of each cpu of resource")
+ @Param(description = "Speed of each CPU of resource")
private Long cpuSpeed;
@SerializedName(ApiConstants.MEMORY)
- @Param(description = "memory allocated for the resource")
+ @Param(description = "Memory allocated for the resource")
private Long memory;
@SerializedName(ApiConstants.START_DATE)
- @Param(description = "start date of the usage record")
+ @Param(description = "Start date of the usage record")
private Date startDate;
@SerializedName(ApiConstants.END_DATE)
- @Param(description = "end date of the usage record")
+ @Param(description = "End date of the usage record")
private Date endDate;
@SerializedName("issourcenat")
@@ -149,11 +149,11 @@ public class UsageRecordResponse extends BaseResponseWithTagInformation implemen
private Boolean isSourceNat;
@SerializedName(ApiConstants.IS_SYSTEM)
- @Param(description = "True if the IPAddress is system IP - allocated during vm deploy or lb rule create")
+ @Param(description = "True if the IPAddress is system IP - allocated during Instance deploy or LB rule create")
private Boolean isSystem;
@SerializedName("networkid")
- @Param(description = "id of the network")
+ @Param(description = "ID of the Network")
private String networkId;
@SerializedName("isdefault")
@@ -161,7 +161,7 @@ public class UsageRecordResponse extends BaseResponseWithTagInformation implemen
private Boolean isDefault;
@SerializedName("vpcid")
- @Param(description = "id of the vpc")
+ @Param(description = "ID of the VPC")
private String vpcId;
public UsageRecordResponse() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/UserDataResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/UserDataResponse.java
index 2dfc66fa7d5..5871ae6ee7a 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/UserDataResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/UserDataResponse.java
@@ -27,41 +27,41 @@ import org.apache.cloudstack.api.EntityReference;
public class UserDataResponse extends BaseResponseWithAnnotations implements ControlledEntityResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "ID of the ssh keypair")
+ @Param(description = "ID of the User Data")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "Name of the userdata")
+ @Param(description = "Name of the User Data")
private String name;
- @SerializedName(ApiConstants.ACCOUNT_ID) @Param(description="the owner id of the userdata")
+ @SerializedName(ApiConstants.ACCOUNT_ID) @Param(description="The owner id of the User Data")
private String accountId;
- @SerializedName(ApiConstants.ACCOUNT) @Param(description="the owner of the userdata")
+ @SerializedName(ApiConstants.ACCOUNT) @Param(description="The owner of the User Data")
private String accountName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the userdata", since = "4.19.1")
+ @Param(description = "The project id of the User Data", since = "4.19.1")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the userdata", since = "4.19.1")
+ @Param(description = "The project name of the User Data", since = "4.19.1")
private String projectName;
- @SerializedName(ApiConstants.DOMAIN_ID) @Param(description="the domain id of the userdata owner")
+ @SerializedName(ApiConstants.DOMAIN_ID) @Param(description="The domain id of the User Data owner")
private String domainId;
- @SerializedName(ApiConstants.DOMAIN) @Param(description="the domain name of the userdata owner")
+ @SerializedName(ApiConstants.DOMAIN) @Param(description="The domain name of the User Data owner")
private String domain;
@SerializedName(ApiConstants.DOMAIN_PATH)
- @Param(description = "path of the domain to which the userdata owner belongs", since = "4.19.2.0")
+ @Param(description = "Path of the domain to which the User Data owner belongs", since = "4.19.2.0")
private String domainPath;
- @SerializedName(ApiConstants.USER_DATA) @Param(description="base64 encoded userdata content")
+ @SerializedName(ApiConstants.USER_DATA) @Param(description="Base64 encoded User Data content")
private String userData;
- @SerializedName(ApiConstants.PARAMS) @Param(description="list of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata")
+ @SerializedName(ApiConstants.PARAMS) @Param(description="List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in the User Data")
private String params;
public UserDataResponse() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/UserResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/UserResponse.java
index df97a915700..9566e10991d 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/UserResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/UserResponse.java
@@ -32,88 +32,88 @@ import com.cloud.user.User;
@EntityReference(value = User.class)
public class UserResponse extends BaseResponse implements SetResourceIconResponse {
@SerializedName("id")
- @Param(description = "the user ID")
+ @Param(description = "The user ID")
private String id;
@SerializedName("username")
- @Param(description = "the user name")
+ @Param(description = "The user name")
private String username;
@SerializedName("firstname")
- @Param(description = "the user firstname")
+ @Param(description = "The user firstname")
private String firstname;
@SerializedName("lastname")
- @Param(description = "the user lastname")
+ @Param(description = "The user lastname")
private String lastname;
@SerializedName("email")
- @Param(description = "the user email address")
+ @Param(description = "The user email address")
private String email;
@SerializedName("created")
- @Param(description = "the date and time the user account was created")
+ @Param(description = "The date and time the user Account was created")
private Date created;
@SerializedName("state")
- @Param(description = "the user state")
+ @Param(description = "The user state")
private String state;
@SerializedName("account")
- @Param(description = "the account name of the user")
+ @Param(description = "The Account name of the user")
private String accountName;
@SerializedName("accounttype")
- @Param(description = "the account type of the user")
+ @Param(description = "The Account type of the user")
private Integer accountType;
@SerializedName("usersource")
- @Param(description = "the source type of the user in lowercase, such as native, ldap, saml2")
+ @Param(description = "The source type of the user in lowercase, such as native, ldap, saml2")
private String userSource;
@SerializedName(ApiConstants.ROLE_ID)
- @Param(description = "the ID of the role")
+ @Param(description = "The ID of the role")
private String roleId;
@SerializedName(ApiConstants.ROLE_TYPE)
- @Param(description = "the type of the role")
+ @Param(description = "The type of the role")
private String roleType;
@SerializedName(ApiConstants.ROLE_NAME)
- @Param(description = "the name of the role")
+ @Param(description = "The name of the role")
private String roleName;
@SerializedName("domainid")
- @Param(description = "the domain ID of the user")
+ @Param(description = "The domain ID of the user")
private String domainId;
@SerializedName("domain")
- @Param(description = "the domain name of the user")
+ @Param(description = "The domain name of the user")
private String domainName;
@SerializedName("timezone")
- @Param(description = "the timezone user was created in")
+ @Param(description = "The timezone user was created in")
private String timezone;
@SerializedName("apikey")
- @Param(description = "the api key of the user", isSensitive = true)
+ @Param(description = "The API key of the user", isSensitive = true)
private String apiKey;
@Deprecated
@SerializedName("secretkey")
- @Param(description = "the secret key of the user", isSensitive = true)
+ @Param(description = "The secret key of the user", isSensitive = true)
private String secretKey;
@SerializedName("accountid")
- @Param(description = "the account ID of the user")
+ @Param(description = "The Account ID of the user")
private String accountId;
@SerializedName("iscallerchilddomain")
- @Param(description = "the boolean value representing if the updating target is in caller's child domain")
+ @Param(description = "The boolean value representing if the updating target is in caller's child domain")
private boolean isCallerChildDomain;
@SerializedName(ApiConstants.IS_DEFAULT)
- @Param(description = "true if user is default, false otherwise", since = "4.2.0")
+ @Param(description = "True if user is default, false otherwise", since = "4.2.0")
private Boolean isDefault;
@SerializedName(ApiConstants.RESOURCE_ICON)
@@ -121,15 +121,15 @@ public class UserResponse extends BaseResponse implements SetResourceIconRespons
ResourceIconResponse icon;
@SerializedName(ApiConstants.IS_2FA_ENABLED)
- @Param(description = "true if user has two factor authentication enabled", since = "4.18.0.0")
+ @Param(description = "True if user has two factor authentication enabled", since = "4.18.0.0")
private Boolean is2FAenabled;
@SerializedName(ApiConstants.IS_2FA_MANDATED)
- @Param(description = "true if user has two factor authentication is mandated", since = "4.18.0.0")
+ @Param(description = "True if user has two factor authentication is mandated", since = "4.18.0.0")
private Boolean is2FAmandated;
@SerializedName(ApiConstants.API_KEY_ACCESS)
- @Param(description = "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", since = "4.20.1.0")
+ @Param(description = "Whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", since = "4.20.1.0")
ApiConstants.ApiKeyAccess apiKeyAccess;
@Override
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/UserTwoFactorAuthenticationSetupResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/UserTwoFactorAuthenticationSetupResponse.java
index 35beefde403..43118a4c474 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/UserTwoFactorAuthenticationSetupResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/UserTwoFactorAuthenticationSetupResponse.java
@@ -26,19 +26,19 @@ import com.google.gson.annotations.SerializedName;
public class UserTwoFactorAuthenticationSetupResponse extends BaseResponse {
@SerializedName("id")
- @Param(description = "the user ID")
+ @Param(description = "The user ID")
private String id;
@SerializedName("username")
- @Param(description = "the user name")
+ @Param(description = "The user name")
private String username;
@SerializedName("accountid")
- @Param(description = "the account ID of the user")
+ @Param(description = "The Account ID of the user")
private String accountId;
@SerializedName(ApiConstants.SECRET_CODE)
- @Param(description = "secret code that needs to be registered with authenticator")
+ @Param(description = "Secret code that needs to be registered with authenticator")
private String secretCode;
public void setId(String id) {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/UserTwoFactorAuthenticatorProviderResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/UserTwoFactorAuthenticatorProviderResponse.java
index 4101dc375ed..7b0057d66ea 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/UserTwoFactorAuthenticatorProviderResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/UserTwoFactorAuthenticatorProviderResponse.java
@@ -27,11 +27,11 @@ import org.apache.cloudstack.auth.UserTwoFactorAuthenticator;
public class UserTwoFactorAuthenticatorProviderResponse extends BaseResponse {
@SerializedName(ApiConstants.NAME)
- @Param(description = "the user two factor authenticator provider name")
+ @Param(description = "The user two factor authenticator provider name")
private String name;
@SerializedName(ApiConstants.DESCRIPTION)
- @Param(description = "the description of the user two factor authenticator provider")
+ @Param(description = "The description of the user two factor authenticator provider")
private String description;
public String getName() {
diff --git a/api/src/main/java/org/apache/cloudstack/api/response/UserVmResponse.java b/api/src/main/java/org/apache/cloudstack/api/response/UserVmResponse.java
index 2f519ccf3a5..fb7c4389928 100644
--- a/api/src/main/java/org/apache/cloudstack/api/response/UserVmResponse.java
+++ b/api/src/main/java/org/apache/cloudstack/api/response/UserVmResponse.java
@@ -43,239 +43,239 @@ import com.google.gson.annotations.SerializedName;
@EntityReference(value = {VirtualMachine.class, UserVm.class, VirtualRouter.class})
public class UserVmResponse extends BaseResponseWithTagInformation implements ControlledEntityResponse, SetResourceIconResponse {
@SerializedName(ApiConstants.ID)
- @Param(description = "the ID of the virtual machine")
+ @Param(description = "The ID of the Instance")
private String id;
@SerializedName(ApiConstants.NAME)
- @Param(description = "the name of the virtual machine")
+ @Param(description = "The name of the Instance")
private String name;
@SerializedName("displayname")
- @Param(description = "user generated name. The name of the virtual machine is returned if no displayname exists.")
+ @Param(description = "User generated name. The name of the Instance is returned if no displayname exists.")
private String displayName;
@SerializedName(ApiConstants.ACCOUNT)
- @Param(description = "the account associated with the virtual machine")
+ @Param(description = "The Account associated with the Instance")
private String accountName;
@SerializedName(ApiConstants.USER_ID)
- @Param(description = "the user's ID who deployed the virtual machine")
+ @Param(description = "The User's ID who deployed the Instance")
private String userId;
@SerializedName(ApiConstants.USERNAME)
- @Param(description = "the user's name who deployed the virtual machine")
+ @Param(description = "The User's name who deployed the Instance")
private String userName;
@SerializedName(ApiConstants.PROJECT_ID)
- @Param(description = "the project id of the vm")
+ @Param(description = "The project ID of the Instance")
private String projectId;
@SerializedName(ApiConstants.PROJECT)
- @Param(description = "the project name of the vm")
+ @Param(description = "The project name of the Instance")
private String projectName;
@SerializedName(ApiConstants.DOMAIN_ID)
- @Param(description = "the ID of the domain in which the virtual machine exists")
+ @Param(description = "The ID of the domain in which the Instance exists")
private String domainId;
@SerializedName(ApiConstants.DOMAIN)
- @Param(description = "the name of the domain in which the virtual machine exists")
+ @Param(description = "The name of the domain in which the Instance exists")
private String domainName;
@SerializedName(ApiConstants.DOMAIN_PATH)
- @Param(description = "path of the domain in which the virtual machine exists", since = "4.19.2.0")
+ @Param(description = "Path of the domain in which the virtual machine exists", since = "4.19.2.0")
private String domainPath;
@SerializedName(ApiConstants.CREATED)
- @Param(description = "the date when this virtual machine was created")
+ @Param(description = "The date when this Instance was created")
private Date created;
@SerializedName("lastupdated")
- @Param(description="the date when this virtual machine was updated last time", since="4.16.0")
+ @Param(description = "The date when this Instance was updated last time", since="4.16.0")
private Date lastUpdated;
@SerializedName(ApiConstants.STATE)
- @Param(description = "the state of the virtual machine")
+ @Param(description = "The state of the Instance")
private String state;
@SerializedName(ApiConstants.HA_ENABLE)
- @Param(description = "true if high-availability is enabled, false otherwise")
+ @Param(description = "True if high-availability is enabled, false otherwise")
private Boolean haEnable;
@SerializedName(ApiConstants.GROUP_ID)
- @Param(description = "the group ID of the virtual machine")
+ @Param(description = "The group ID of the Instance")
private String groupId;
@SerializedName(ApiConstants.GROUP)
- @Param(description = "the group name of the virtual machine")
+ @Param(description = "The group name of the Instance")
private String group;
@SerializedName(ApiConstants.ZONE_ID)
- @Param(description = "the ID of the availability zone for the virtual machine")
+ @Param(description = "The ID of the availability zone for the Instance")
private String zoneId;
@SerializedName(ApiConstants.ZONE_NAME)
- @Param(description = "the name of the availability zone for the virtual machine")
+ @Param(description = "The name of the availability zone for the Instance")
private String zoneName;
@SerializedName(ApiConstants.HOST_ID)
- @Param(description = "the ID of the host for the virtual machine")
+ @Param(description = "The ID of the host for the Instance")
private String hostId;
@SerializedName("hostname")
- @Param(description = "the name of the host for the virtual machine")
+ @Param(description = "The name of the host for the Instance")
private String hostName;
@SerializedName(ApiConstants.HOST_CONTROL_STATE)
- @Param(description = "the control state of the host for the virtual machine")
+ @Param(description = "The control state of the host for the Instance")
private String hostControlState;
@SerializedName(ApiConstants.TEMPLATE_ID)
- @Param(description = "the ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.")
+ @Param(description = "The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.")
private String templateId;
@SerializedName("templatename")
- @Param(description = "the name of the template for the virtual machine")
+ @Param(description = "The name of the Template for the Instance")
private String templateName;
@SerializedName(ApiConstants.TEMPLATE_TYPE)
- @Param(description = "the type of the template for the virtual machine", since = "4.19.0")
+ @Param(description = "The type of the template for the virtual machine", since = "4.19.0")
private String templateType;
@SerializedName(ApiConstants.TEMPLATE_FORMAT)
- @Param(description = "the format of the template for the virtual machine", since = "4.19.1")
+ @Param(description = "The format of the template for the virtual machine", since = "4.19.1")
private String templateFormat;
@SerializedName("templatedisplaytext")
- @Param(description = " an alternate display text of the template for the virtual machine")
+ @Param(description = "An alternate display text of the Template for the Instance")
private String templateDisplayText;
@SerializedName(ApiConstants.PASSWORD_ENABLED)
- @Param(description = "true if the password rest feature is enabled, false otherwise")
+ @Param(description = "True if the password rest feature is enabled, false otherwise")
private Boolean passwordEnabled;
@SerializedName("isoid")
- @Param(description = "the ID of the ISO attached to the virtual machine")
+ @Param(description = "The ID of the ISO attached to the Instance")
private String isoId;
@SerializedName("isoname")
- @Param(description = "the name of the ISO attached to the virtual machine")
+ @Param(description = "The name of the ISO attached to the Instance")
private String isoName;
@SerializedName("isodisplaytext")
- @Param(description = "an alternate display text of the ISO attached to the virtual machine")
+ @Param(description = "An alternate display text of the ISO attached to the Instance")
private String isoDisplayText;
@SerializedName(ApiConstants.SERVICE_OFFERING_ID)
- @Param(description = "the ID of the service offering of the virtual machine")
+ @Param(description = "The ID of the service offering of the Instance")
private String serviceOfferingId;
@SerializedName("serviceofferingname")
- @Param(description = "the name of the service offering of the virtual machine")
+ @Param(description = "The name of the service offering of the Instance")
private String serviceOfferingName;
@SerializedName(ApiConstants.DISK_OFFERING_ID)
- @Param(description = "the ID of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", since = "4.4")
+ @Param(description = "The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", since = "4.4")
private String diskOfferingId;
@SerializedName("diskofferingname")
- @Param(description = "the name of the disk offering of the virtual machine. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", since = "4.4")
+ @Param(description = "The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead", since = "4.4")
private String diskOfferingName;
@SerializedName(ApiConstants.BACKUP_OFFERING_ID)
- @Param(description = "the ID of the backup offering of the virtual machine", since = "4.14")
+ @Param(description = "The ID of the backup offering of the Instance", since = "4.14")
private String backupOfferingId;
@SerializedName(ApiConstants.BACKUP_OFFERING_NAME)
- @Param(description = "the name of the backup offering of the virtual machine", since = "4.14")
+ @Param(description = "The name of the backup offering of the Instance", since = "4.14")
private String backupOfferingName;
@SerializedName("forvirtualnetwork")
- @Param(description = "the virtual network for the service offering")
+ @Param(description = "The virtual Network for the service offering")
private Boolean forVirtualNetwork;
@SerializedName(ApiConstants.CPU_NUMBER)
- @Param(description = "the number of vCPUs this virtual machine is using")
+ @Param(description = "The number of vCPUs this Instance is using")
private Integer cpuNumber;
@SerializedName(ApiConstants.CPU_SPEED)
- @Param(description = "the speed of each vCPU")
+ @Param(description = "The speed of each vCPU")
private Integer cpuSpeed;
@SerializedName(ApiConstants.MEMORY)
- @Param(description = "the memory allocated for the virtual machine")
+ @Param(description = "The memory allocated for the Instance")
private Integer memory;
@SerializedName(ApiConstants.VGPU)
- @Param(description = "the vGPU type used by the virtual machine", since = "4.4")
+ @Param(description = "The vGPU type used by the Instance", since = "4.4")
private String vgpu;
@SerializedName("cpuused")
- @Param(description = "the amount of the vm's CPU currently used")
+ @Param(description = "The amount of the Instance's CPU currently used")
private String cpuUsed;
@SerializedName("networkkbsread")
- @Param(description = "the incoming network traffic on the VM in KiB")
+ @Param(description = "The incoming Network traffic on the Instance in KiB")
private Long networkKbsRead;
@SerializedName("networkkbswrite")
- @Param(description = "the outgoing network traffic on the host in KiB")
+ @Param(description = "The outgoing Network traffic on the host in KiB")
private Long networkKbsWrite;
@SerializedName(ApiConstants.DISK_KBS_READ)
- @Param(description = "the VM's disk read in KiB")
+ @Param(description = "The Instance's disk read in KiB")
private Long diskKbsRead;
@SerializedName(ApiConstants.DISK_KBS_WRITE)
- @Param(description = "the VM's disk write in KiB")
+ @Param(description = "The Instance's disk write in KiB")
private Long diskKbsWrite;
@SerializedName("memorykbs")
- @Param(description = "the memory used by the VM in KiB")
+ @Param(description = "The memory used by the Instance in KiB")
private Long memoryKBs;
@SerializedName("memoryintfreekbs")
- @Param(description = "the internal memory (KiB) that's free in VM or zero if it can not be calculated")
+ @Param(description = "The internal memory (KiB) that's free in Instance or zero if it can not be calculated")
private Long memoryIntFreeKBs;
@SerializedName("memorytargetkbs")
- @Param(description = "the target memory in VM (KiB)")
+ @Param(description = "The target memory in Instance (KiB)")
private Long memoryTargetKBs;
@SerializedName(ApiConstants.DISK_IO_READ)
- @Param(description = "the read (IO) of disk on the VM")
+ @Param(description = "The read (IO) of disk on the Instance")
private Long diskIORead;
@SerializedName(ApiConstants.DISK_IO_WRITE)
- @Param(description = "the write (IO) of disk on the VM")
+ @Param(description = "The write (IO) of disk on the Instance")
private Long diskIOWrite;
@SerializedName("guestosid")
- @Param(description = "Os type ID of the virtual machine")
+ @Param(description = "OS type ID of the Instance")
private String guestOsId;
@SerializedName("rootdeviceid")
- @Param(description = "device ID of the root volume")
+ @Param(description = "Device ID of the root volume")
private Long rootDeviceId;
@SerializedName("rootdevicetype")
- @Param(description = "device type of the root volume")
+ @Param(description = "Device type of the root volume")
private String rootDeviceType;
@SerializedName("securitygroup")
- @Param(description = "list of security groups associated with the virtual machine", responseObject = SecurityGroupResponse.class)
+ @Param(description = "List of security groups associated with the Instance", responseObject = SecurityGroupResponse.class)
private Set