From e7b478f43d1ca42f9fcbbecb4e7f23af13da0905 Mon Sep 17 00:00:00 2001 From: alena Date: Thu, 7 Oct 2010 14:45:08 -0700 Subject: [PATCH] Added descriptions for Api commands and corresponding requrest parameters --- server/src/com/cloud/api/BaseListCmd.java | 2 +- .../com/cloud/api/commands/AddHostCmd.java | 2 +- .../api/commands/AddSecondaryStorageCmd.java | 2 +- .../AssignPortForwardingServiceCmd.java | 2 +- .../commands/AssignToLoadBalancerRuleCmd.java | 2 +- .../api/commands/AssociateIPAddrCmd.java | 8 +++---- .../com/cloud/api/commands/AttachIsoCmd.java | 2 +- .../cloud/api/commands/AttachVolumeCmd.java | 2 +- .../api/commands/CancelMaintenanceCmd.java | 2 +- .../com/cloud/api/commands/CopyIsoCmd.java | 2 +- .../cloud/api/commands/CopyTemplateCmd.java | 2 +- .../api/commands/CreateDiskOfferingCmd.java | 2 +- .../cloud/api/commands/CreateDomainCmd.java | 6 +++--- .../commands/CreateIPForwardingRuleCmd.java | 12 +++++------ .../commands/CreateLoadBalancerRuleCmd.java | 2 +- .../com/cloud/api/commands/CreatePodCmd.java | 2 +- .../CreatePortForwardingServiceCmd.java | 10 ++++----- .../CreatePortForwardingServiceRuleCmd.java | 2 +- .../commands/CreateServiceOfferingCmd.java | 2 +- .../cloud/api/commands/CreateSnapshotCmd.java | 2 +- .../api/commands/CreateSnapshotPolicyCmd.java | 2 +- .../api/commands/CreateStoragePoolCmd.java | 2 +- .../cloud/api/commands/CreateTemplateCmd.java | 4 +++- .../com/cloud/api/commands/CreateUserCmd.java | 20 +++++++++--------- .../api/commands/CreateVlanIpRangeCmd.java | 2 +- .../cloud/api/commands/CreateVolumeCmd.java | 3 ++- .../com/cloud/api/commands/CreateZoneCmd.java | 2 +- .../api/commands/DeleteDiskOfferingCmd.java | 2 +- .../cloud/api/commands/DeleteDomainCmd.java | 4 ++-- .../com/cloud/api/commands/DeleteHostCmd.java | 2 +- .../commands/DeleteIPForwardingRuleCmd.java | 4 ++-- .../com/cloud/api/commands/DeleteIsoCmd.java | 2 +- .../commands/DeleteLoadBalancerRuleCmd.java | 2 +- .../com/cloud/api/commands/DeletePodCmd.java | 2 +- .../com/cloud/api/commands/DeletePoolCmd.java | 2 +- .../DeletePortForwardingServiceCmd.java | 2 +- .../DeletePortForwardingServiceRuleCmd.java | 4 ++-- .../commands/DeleteServiceOfferingCmd.java | 2 +- .../cloud/api/commands/DeleteSnapshotCmd.java | 2 +- .../commands/DeleteSnapshotPoliciesCmd.java | 2 +- .../cloud/api/commands/DeleteTemplateCmd.java | 2 +- .../com/cloud/api/commands/DeleteUserCmd.java | 4 ++-- .../api/commands/DeleteVlanIpRangeCmd.java | 2 +- .../cloud/api/commands/DeleteVolumeCmd.java | 2 +- .../com/cloud/api/commands/DeleteZoneCmd.java | 2 +- .../com/cloud/api/commands/DeployVMCmd.java | 2 +- .../com/cloud/api/commands/DestroyVMCmd.java | 2 +- .../com/cloud/api/commands/DetachIsoCmd.java | 2 +- .../cloud/api/commands/DetachVolumeCmd.java | 2 +- .../cloud/api/commands/DisableAccountCmd.java | 6 +++--- .../cloud/api/commands/DisableUserCmd.java | 4 ++-- .../api/commands/DisassociateIPAddrCmd.java | 4 ++-- .../cloud/api/commands/EnableAccountCmd.java | 6 +++--- .../com/cloud/api/commands/EnableUserCmd.java | 4 ++-- .../api/commands/GetCloudIdentifierCmd.java | 2 +- .../cloud/api/commands/ListAccountsCmd.java | 14 ++++++------- .../com/cloud/api/commands/ListAlertsCmd.java | 2 +- .../cloud/api/commands/ListAsyncJobsCmd.java | 2 +- .../cloud/api/commands/ListCapacityCmd.java | 2 +- .../com/cloud/api/commands/ListCfgsByCmd.java | 2 +- .../cloud/api/commands/ListClustersCmd.java | 2 +- .../api/commands/ListDiskOfferingsCmd.java | 2 +- .../api/commands/ListDomainChildrenCmd.java | 8 +++---- .../cloud/api/commands/ListDomainsCmd.java | 8 +++---- .../com/cloud/api/commands/ListEventsCmd.java | 2 +- .../commands/ListGuestOsCategoriesCmd.java | 2 +- .../cloud/api/commands/ListGuestOsCmd.java | 2 +- .../com/cloud/api/commands/ListHostsCmd.java | 2 +- .../com/cloud/api/commands/ListIsosCmd.java | 2 +- .../ListLoadBalancerRuleInstancesCmd.java | 2 +- .../commands/ListLoadBalancerRulesCmd.java | 2 +- .../com/cloud/api/commands/ListPodsByCmd.java | 2 +- .../commands/ListPortForwardingRulesCmd.java | 2 +- .../ListPortForwardingServiceRulesCmd.java | 10 ++++----- .../ListPortForwardingServicesByVmCmd.java | 2 +- .../ListPortForwardingServicesCmd.java | 2 +- .../commands/ListPublicIpAddressesCmd.java | 16 +++++++------- .../api/commands/ListResourceLimitsCmd.java | 2 +- .../cloud/api/commands/ListRoutersCmd.java | 2 +- .../api/commands/ListServiceOfferingsCmd.java | 2 +- .../api/commands/ListSnapshotPoliciesCmd.java | 2 +- .../cloud/api/commands/ListSnapshotsCmd.java | 2 +- .../api/commands/ListStoragePoolsCmd.java | 2 +- .../cloud/api/commands/ListSystemVMsCmd.java | 2 +- .../ListTemplateOrIsoPermissionsCmd.java | 2 +- .../cloud/api/commands/ListTemplatesCmd.java | 2 +- .../com/cloud/api/commands/ListUsersCmd.java | 14 ++++++------- .../com/cloud/api/commands/ListVMsCmd.java | 2 +- .../api/commands/ListVlanIpRangesCmd.java | 2 +- .../cloud/api/commands/ListVolumesCmd.java | 2 +- .../cloud/api/commands/LockAccountCmd.java | 6 +++--- .../com/cloud/api/commands/LockUserCmd.java | 4 ++-- .../commands/PrepareForMaintenanceCmd.java | 2 +- .../api/commands/QueryAsyncJobResultCmd.java | 2 +- .../cloud/api/commands/RebootRouterCmd.java | 2 +- .../cloud/api/commands/RebootSystemVmCmd.java | 2 +- .../com/cloud/api/commands/RebootVMCmd.java | 2 +- .../cloud/api/commands/ReconnectHostCmd.java | 2 +- .../com/cloud/api/commands/RecoverVMCmd.java | 2 +- .../com/cloud/api/commands/RegisterCmd.java | 4 ++-- .../cloud/api/commands/RegisterIsoCmd.java | 2 +- .../api/commands/RegisterTemplateCmd.java | 2 +- .../RemoveFromLoadBalancerRuleCmd.java | 2 +- .../RemovePortForwardingServiceCmd.java | 2 +- .../api/commands/ResetVMPasswordCmd.java | 4 +++- .../cloud/api/commands/StartRouterCmd.java | 2 +- .../cloud/api/commands/StartSystemVMCmd.java | 2 +- .../com/cloud/api/commands/StartVMCmd.java | 2 +- .../com/cloud/api/commands/StopRouterCmd.java | 2 +- .../cloud/api/commands/StopSystemVmCmd.java | 2 +- .../src/com/cloud/api/commands/StopVMCmd.java | 2 +- .../cloud/api/commands/UpdateAccountCmd.java | 8 +++---- .../com/cloud/api/commands/UpdateCfgCmd.java | 2 +- .../api/commands/UpdateDiskOfferingCmd.java | 2 +- .../cloud/api/commands/UpdateDomainCmd.java | 6 +++--- .../com/cloud/api/commands/UpdateHostCmd.java | 2 +- .../commands/UpdateIPForwardingRuleCmd.java | 14 ++++++------- .../com/cloud/api/commands/UpdateIsoCmd.java | 2 +- .../com/cloud/api/commands/UpdatePodCmd.java | 2 +- .../api/commands/UpdateResourceLimitCmd.java | 2 +- .../commands/UpdateServiceOfferingCmd.java | 2 +- .../api/commands/UpdateStoragePoolCmd.java | 2 +- .../cloud/api/commands/UpdateTemplateCmd.java | 2 +- .../UpdateTemplatePermissionsCmd.java | 6 +++++- .../com/cloud/api/commands/UpdateUserCmd.java | 21 +++++++++---------- .../com/cloud/api/commands/UpdateVMCmd.java | 2 +- .../com/cloud/api/commands/UpdateZoneCmd.java | 2 +- .../com/cloud/api/commands/UpgradeVMCmd.java | 4 +++- .../com/cloud/api/doc/ApiXmlDocWriter.java | 5 +++++ 129 files changed, 231 insertions(+), 216 deletions(-) diff --git a/server/src/com/cloud/api/BaseListCmd.java b/server/src/com/cloud/api/BaseListCmd.java index bed689b72bd..a5aee7daf02 100644 --- a/server/src/com/cloud/api/BaseListCmd.java +++ b/server/src/com/cloud/api/BaseListCmd.java @@ -8,7 +8,7 @@ public abstract class BaseListCmd extends BaseCmd { /////////// BaseList API parameters ///////////////// ///////////////////////////////////////////////////// - @Parameter(name="keyword", type=CommandType.STRING) + @Parameter(name="keyword", type=CommandType.STRING, description="List by keyword") private String keyword; // FIXME: Need to be able to specify next/prev/first/last, so Integer might not be right diff --git a/server/src/com/cloud/api/commands/AddHostCmd.java b/server/src/com/cloud/api/commands/AddHostCmd.java index ec473e2c26e..5c198fb0637 100644 --- a/server/src/com/cloud/api/commands/AddHostCmd.java +++ b/server/src/com/cloud/api/commands/AddHostCmd.java @@ -43,7 +43,7 @@ import com.cloud.offering.ServiceOffering; import com.cloud.storage.GuestOSCategoryVO; import com.cloud.vm.UserVmVO; -@Implementation(method="discoverHosts", manager=Manager.AgentManager) +@Implementation(method="discoverHosts", manager=Manager.AgentManager, description="Adds a new host.") public class AddHostCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(AddHostCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/AddSecondaryStorageCmd.java b/server/src/com/cloud/api/commands/AddSecondaryStorageCmd.java index d6931ab3f02..3798252187c 100644 --- a/server/src/com/cloud/api/commands/AddSecondaryStorageCmd.java +++ b/server/src/com/cloud/api/commands/AddSecondaryStorageCmd.java @@ -39,7 +39,7 @@ import com.cloud.host.HostVO; import com.cloud.host.Status.Event; import com.cloud.storage.GuestOSCategoryVO; -@Implementation(method="discoverHosts", manager=Manager.AgentManager) +@Implementation(method="discoverHosts", manager=Manager.AgentManager, description="Adds secondary storage.") public class AddSecondaryStorageCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(AddSecondaryStorageCmd.class.getName()); private static final String s_name = "addsecondarystorageresponse"; diff --git a/server/src/com/cloud/api/commands/AssignPortForwardingServiceCmd.java b/server/src/com/cloud/api/commands/AssignPortForwardingServiceCmd.java index d62995a300f..e1f97f7784e 100644 --- a/server/src/com/cloud/api/commands/AssignPortForwardingServiceCmd.java +++ b/server/src/com/cloud/api/commands/AssignPortForwardingServiceCmd.java @@ -31,7 +31,7 @@ import com.cloud.event.EventTypes; import com.cloud.network.SecurityGroupVO; import com.cloud.user.Account; -@Implementation(method="assignSecurityGroup", manager=Manager.ManagementServer) +@Implementation(method="assignSecurityGroup", manager=Manager.ManagementServer, description="Assigns a single or a list of port forwarding services to a virtual machine. If a list of port forwarding services is given, it will overwrite the previous assignment of port forwarding services. For example, on the first call, if you assigned port forwarding service A to virtual machine 1 and on the next call, you assign port forwarding services B and C to virtual machine 1, the ultimate result of these two commands would be that virtual machine 1 would only have port forwarding services B and C assigned to it. Individual port forwarding services can be assigned to the virtual machine by specifying a single port forwarding service group.") public class AssignPortForwardingServiceCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(AssignPortForwardingServiceCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/AssignToLoadBalancerRuleCmd.java b/server/src/com/cloud/api/commands/AssignToLoadBalancerRuleCmd.java index ed3cf397540..de80b9b38d7 100644 --- a/server/src/com/cloud/api/commands/AssignToLoadBalancerRuleCmd.java +++ b/server/src/com/cloud/api/commands/AssignToLoadBalancerRuleCmd.java @@ -31,7 +31,7 @@ import com.cloud.event.EventTypes; import com.cloud.network.LoadBalancerVO; import com.cloud.user.Account; -@Implementation(method="assignToLoadBalancer", manager=Manager.NetworkManager) +@Implementation(method="assignToLoadBalancer", manager=Manager.NetworkManager, description="Assigns virtual machine or a list of virtual machines to a load balancer rule.") public class AssignToLoadBalancerRuleCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(AssignToLoadBalancerRuleCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/AssociateIPAddrCmd.java b/server/src/com/cloud/api/commands/AssociateIPAddrCmd.java index f87df59d7c3..507f343d3e0 100644 --- a/server/src/com/cloud/api/commands/AssociateIPAddrCmd.java +++ b/server/src/com/cloud/api/commands/AssociateIPAddrCmd.java @@ -31,7 +31,7 @@ import com.cloud.network.IPAddressVO; import com.cloud.user.Account; import com.cloud.user.UserContext; -@Implementation(method="associateIP", manager=Manager.NetworkManager) +@Implementation(method="associateIP", manager=Manager.NetworkManager, description="Acquires and associates a public IP to an account.") public class AssociateIPAddrCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(AssociateIPAddrCmd.class.getName()); private static final String s_name = "associateipaddressresponse"; @@ -40,13 +40,13 @@ public class AssociateIPAddrCmd extends BaseCmd { //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="account", type=CommandType.STRING) + @Parameter(name="account", type=CommandType.STRING, description="the account to associate with this IP address") private String accountName; - @Parameter(name="domainid", type=CommandType.LONG) + @Parameter(name="domainid", type=CommandType.LONG, description="the ID of the domain to associate with this IP address") private Long domainId; - @Parameter(name="zoneid", type=CommandType.LONG, required=true) + @Parameter(name="zoneid", type=CommandType.LONG, required=true, description="the ID of the availability zone you want to acquire an public IP address from") private Long zoneId; diff --git a/server/src/com/cloud/api/commands/AttachIsoCmd.java b/server/src/com/cloud/api/commands/AttachIsoCmd.java index 12e2a8552cc..c57980ff620 100644 --- a/server/src/com/cloud/api/commands/AttachIsoCmd.java +++ b/server/src/com/cloud/api/commands/AttachIsoCmd.java @@ -31,7 +31,7 @@ import com.cloud.event.EventTypes; import com.cloud.storage.VMTemplateVO; import com.cloud.user.Account; -@Implementation(method="attachIso", manager=Manager.TemplateManager) +@Implementation(method="attachIso", manager=Manager.TemplateManager, description="Attaches an ISO to a virtual machine.") public class AttachIsoCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(AttachIsoCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/AttachVolumeCmd.java b/server/src/com/cloud/api/commands/AttachVolumeCmd.java index b3e5209a73e..15170a77c49 100644 --- a/server/src/com/cloud/api/commands/AttachVolumeCmd.java +++ b/server/src/com/cloud/api/commands/AttachVolumeCmd.java @@ -31,7 +31,7 @@ import com.cloud.storage.VolumeVO; import com.cloud.user.Account; import com.cloud.uservm.UserVm; -@Implementation(method="attachVolumeToVM", manager=Manager.UserVmManager) +@Implementation(method="attachVolumeToVM", manager=Manager.UserVmManager, description="Attaches a disk volume to a virtual machine.") public class AttachVolumeCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(AttachVolumeCmd.class.getName()); private static final String s_name = "attachvolumeresponse"; diff --git a/server/src/com/cloud/api/commands/CancelMaintenanceCmd.java b/server/src/com/cloud/api/commands/CancelMaintenanceCmd.java index 6b692422d49..57b7369215f 100644 --- a/server/src/com/cloud/api/commands/CancelMaintenanceCmd.java +++ b/server/src/com/cloud/api/commands/CancelMaintenanceCmd.java @@ -44,7 +44,7 @@ import com.cloud.user.Account; import com.cloud.user.UserContext; import com.cloud.vm.UserVmVO; -@Implementation(method="cancelMaintenance", manager=Manager.AgentManager) +@Implementation(method="cancelMaintenance", manager=Manager.AgentManager, description="Cancels host maintenance.") public class CancelMaintenanceCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(CancelMaintenanceCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/CopyIsoCmd.java b/server/src/com/cloud/api/commands/CopyIsoCmd.java index 57787859226..afc04740fb2 100644 --- a/server/src/com/cloud/api/commands/CopyIsoCmd.java +++ b/server/src/com/cloud/api/commands/CopyIsoCmd.java @@ -36,7 +36,7 @@ import com.cloud.storage.VMTemplateVO; import com.cloud.user.Account; import com.cloud.user.UserContext; -@Implementation(method="copyIso", manager=Manager.TemplateManager) +@Implementation(method="copyIso", manager=Manager.TemplateManager, description="Copies an ISO file.") public class CopyIsoCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(CopyIsoCmd.class.getName()); private static final String s_name = "copyisoresponse"; diff --git a/server/src/com/cloud/api/commands/CopyTemplateCmd.java b/server/src/com/cloud/api/commands/CopyTemplateCmd.java index f42a23576b4..98cb9de2f93 100644 --- a/server/src/com/cloud/api/commands/CopyTemplateCmd.java +++ b/server/src/com/cloud/api/commands/CopyTemplateCmd.java @@ -36,7 +36,7 @@ import com.cloud.storage.VMTemplateVO; import com.cloud.user.Account; import com.cloud.user.UserContext; -@Implementation(method="copyTemplate", manager=Manager.TemplateManager) +@Implementation(method="copyTemplate", manager=Manager.TemplateManager, description="Copies a template from one zone to another.") public class CopyTemplateCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(CopyTemplateCmd.class.getName()); private static final String s_name = "copytemplateresponse"; diff --git a/server/src/com/cloud/api/commands/CreateDiskOfferingCmd.java b/server/src/com/cloud/api/commands/CreateDiskOfferingCmd.java index 4f5678b57b2..fdf13a9e5c9 100755 --- a/server/src/com/cloud/api/commands/CreateDiskOfferingCmd.java +++ b/server/src/com/cloud/api/commands/CreateDiskOfferingCmd.java @@ -28,7 +28,7 @@ import com.cloud.api.ServerApiException; import com.cloud.api.response.DiskOfferingResponse; import com.cloud.storage.DiskOfferingVO; -@Implementation(method="createDiskOffering", manager=Manager.ConfigManager) +@Implementation(method="createDiskOffering", manager=Manager.ConfigManager, description="Creates a disk offering.") public class CreateDiskOfferingCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(CreateDiskOfferingCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/CreateDomainCmd.java b/server/src/com/cloud/api/commands/CreateDomainCmd.java index 424cab2dd19..90aca37ff97 100644 --- a/server/src/com/cloud/api/commands/CreateDomainCmd.java +++ b/server/src/com/cloud/api/commands/CreateDomainCmd.java @@ -27,7 +27,7 @@ import com.cloud.api.ServerApiException; import com.cloud.api.response.DomainResponse; import com.cloud.domain.DomainVO; -@Implementation(method="createDomain") +@Implementation(method="createDomain", description="Creates a domain") public class CreateDomainCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(CreateDomainCmd.class.getName()); @@ -37,10 +37,10 @@ public class CreateDomainCmd extends BaseCmd { //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="name", type=CommandType.STRING, required=true) + @Parameter(name="name", type=CommandType.STRING, required=true, description="creates domain with this name") private String domainName; - @Parameter(name="parentdomainid", type=CommandType.LONG) + @Parameter(name="parentdomainid", type=CommandType.LONG, description="assigns new domain a parent domain by domain ID of the parent. If no parent domain is specied, the ROOT domain is assumed.") private Long parentDomainId; diff --git a/server/src/com/cloud/api/commands/CreateIPForwardingRuleCmd.java b/server/src/com/cloud/api/commands/CreateIPForwardingRuleCmd.java index e6ce31b619b..ed350c59259 100644 --- a/server/src/com/cloud/api/commands/CreateIPForwardingRuleCmd.java +++ b/server/src/com/cloud/api/commands/CreateIPForwardingRuleCmd.java @@ -29,7 +29,7 @@ import com.cloud.api.response.FirewallRuleResponse; import com.cloud.network.FirewallRuleVO; import com.cloud.uservm.UserVm; -@Implementation(method="createPortForwardingRule", manager=Manager.NetworkManager) +@Implementation(method="createPortForwardingRule", manager=Manager.NetworkManager, description="Creates a port forwarding rule") public class CreateIPForwardingRuleCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(CreateIPForwardingRuleCmd.class.getName()); @@ -39,19 +39,19 @@ public class CreateIPForwardingRuleCmd extends BaseCmd { //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="ipaddress", type=CommandType.STRING, required=true) + @Parameter(name="ipaddress", type=CommandType.STRING, required=true, description="the IP address of the port forwarding rule") private String ipAddress; - @Parameter(name="privateport", type=CommandType.STRING, required=true) + @Parameter(name="privateport", type=CommandType.STRING, required=true, description="the private port of the port forwarding rule") private String privatePort; - @Parameter(name="protocol", type=CommandType.STRING, required=true) + @Parameter(name="protocol", type=CommandType.STRING, required=true, description="the protocol for the port fowarding rule. Valid values are TCP or UDP.") private String protocol; - @Parameter(name="publicport", type=CommandType.STRING, required=true) + @Parameter(name="publicport", type=CommandType.STRING, required=true, description=" the public port of the port forwarding rule") private String publicPort; - @Parameter(name="virtualmachineid", type=CommandType.LONG, required=true) + @Parameter(name="virtualmachineid", type=CommandType.LONG, required=true, description="the ID of the virtual machine for the port forwarding rule") private Long virtualMachineId; diff --git a/server/src/com/cloud/api/commands/CreateLoadBalancerRuleCmd.java b/server/src/com/cloud/api/commands/CreateLoadBalancerRuleCmd.java index 77ced0057ec..f9569e008b4 100644 --- a/server/src/com/cloud/api/commands/CreateLoadBalancerRuleCmd.java +++ b/server/src/com/cloud/api/commands/CreateLoadBalancerRuleCmd.java @@ -28,7 +28,7 @@ import com.cloud.api.Parameter; import com.cloud.api.response.LoadBalancerResponse; import com.cloud.network.LoadBalancerVO; -@Implementation(method="createLoadBalancerRule", manager=Manager.NetworkManager) +@Implementation(method="createLoadBalancerRule", manager=Manager.NetworkManager, description="Creates a load balancer rule") public class CreateLoadBalancerRuleCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(CreateLoadBalancerRuleCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/CreatePodCmd.java b/server/src/com/cloud/api/commands/CreatePodCmd.java index e474dc1e478..3317b82d1b9 100644 --- a/server/src/com/cloud/api/commands/CreatePodCmd.java +++ b/server/src/com/cloud/api/commands/CreatePodCmd.java @@ -28,7 +28,7 @@ import com.cloud.api.Parameter; import com.cloud.api.response.PodResponse; import com.cloud.dc.HostPodVO; -@Implementation(method="createPod", manager=Manager.ConfigManager) +@Implementation(method="createPod", manager=Manager.ConfigManager, description="Creates a new Pod.") public class CreatePodCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(CreatePodCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/CreatePortForwardingServiceCmd.java b/server/src/com/cloud/api/commands/CreatePortForwardingServiceCmd.java index 1ab7b2f0f90..4362fd4eda5 100644 --- a/server/src/com/cloud/api/commands/CreatePortForwardingServiceCmd.java +++ b/server/src/com/cloud/api/commands/CreatePortForwardingServiceCmd.java @@ -27,7 +27,7 @@ import com.cloud.api.Parameter; import com.cloud.api.response.SecurityGroupResponse; import com.cloud.network.SecurityGroupVO; -@Implementation(method="createPortForwardingService") +@Implementation(method="createPortForwardingService", description="Creates a port forwarding service") public class CreatePortForwardingServiceCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(CreatePortForwardingServiceCmd.class.getName()); @@ -37,16 +37,16 @@ public class CreatePortForwardingServiceCmd extends BaseCmd { //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="account", type=CommandType.STRING) + @Parameter(name="account", type=CommandType.STRING, description="the account associated with the port forwarding service. Must be used with the domainId parameter.") private String accountName; - @Parameter(name="description", type=CommandType.STRING) + @Parameter(name="description", type=CommandType.STRING, description="an optional user generated description for the port forwarding service") private String description; - @Parameter(name="domainid", type=CommandType.LONG) + @Parameter(name="domainid", type=CommandType.LONG, description="the domain ID associated with the port forwarding service. If used with the account parameter, creates a new port forwarding service for the account in the specified domain ID.") private Long domainId; - @Parameter(name="name", type=CommandType.STRING, required=true) + @Parameter(name="name", type=CommandType.STRING, required=true, description="name of the port forwarding service") private String portForwardingServiceName; diff --git a/server/src/com/cloud/api/commands/CreatePortForwardingServiceRuleCmd.java b/server/src/com/cloud/api/commands/CreatePortForwardingServiceRuleCmd.java index f4739a077e8..88014bab082 100644 --- a/server/src/com/cloud/api/commands/CreatePortForwardingServiceRuleCmd.java +++ b/server/src/com/cloud/api/commands/CreatePortForwardingServiceRuleCmd.java @@ -30,7 +30,7 @@ import com.cloud.network.NetworkRuleConfigVO; import com.cloud.network.SecurityGroupVO; import com.cloud.user.Account; -@Implementation(createMethod="createPortForwardingServiceRule", method="applyPortForwardingServiceRule") +@Implementation(createMethod="createPortForwardingServiceRule", method="applyPortForwardingServiceRule", description="Creates a port forwarding service rule") public class CreatePortForwardingServiceRuleCmd extends BaseAsyncCreateCmd { public static final Logger s_logger = Logger.getLogger(CreatePortForwardingServiceRuleCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/CreateServiceOfferingCmd.java b/server/src/com/cloud/api/commands/CreateServiceOfferingCmd.java index 47c08248812..c176df8b63a 100644 --- a/server/src/com/cloud/api/commands/CreateServiceOfferingCmd.java +++ b/server/src/com/cloud/api/commands/CreateServiceOfferingCmd.java @@ -27,7 +27,7 @@ import com.cloud.api.Parameter; import com.cloud.api.response.ServiceOfferingResponse; import com.cloud.service.ServiceOfferingVO; -@Implementation(method="createServiceOffering", manager=Manager.ConfigManager) +@Implementation(method="createServiceOffering", manager=Manager.ConfigManager, description="Creates a service offering.") public class CreateServiceOfferingCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(CreateServiceOfferingCmd.class.getName()); private static final String _name = "createserviceofferingresponse"; diff --git a/server/src/com/cloud/api/commands/CreateSnapshotCmd.java b/server/src/com/cloud/api/commands/CreateSnapshotCmd.java index a8b3835cff6..95a2f8c1ca1 100644 --- a/server/src/com/cloud/api/commands/CreateSnapshotCmd.java +++ b/server/src/com/cloud/api/commands/CreateSnapshotCmd.java @@ -32,7 +32,7 @@ import com.cloud.storage.SnapshotVO; import com.cloud.storage.VolumeVO; import com.cloud.user.Account; -@Implementation(createMethod="createSnapshotDB", method="createSnapshot", manager=Manager.SnapshotManager) +@Implementation(createMethod="createSnapshotDB", method="createSnapshot", manager=Manager.SnapshotManager, description="Creates an instant snapshot of a volume.") public class CreateSnapshotCmd extends BaseAsyncCreateCmd { public static final Logger s_logger = Logger.getLogger(CreateSnapshotCmd.class.getName()); private static final String s_name = "createsnapshotresponse"; diff --git a/server/src/com/cloud/api/commands/CreateSnapshotPolicyCmd.java b/server/src/com/cloud/api/commands/CreateSnapshotPolicyCmd.java index e9cccd09590..db37c5b2658 100644 --- a/server/src/com/cloud/api/commands/CreateSnapshotPolicyCmd.java +++ b/server/src/com/cloud/api/commands/CreateSnapshotPolicyCmd.java @@ -27,7 +27,7 @@ import com.cloud.api.Parameter; import com.cloud.api.response.SnapshotPolicyResponse; import com.cloud.storage.SnapshotPolicyVO; -@Implementation(method="createPolicy", manager=Manager.SnapshotManager) +@Implementation(method="createPolicy", manager=Manager.SnapshotManager, description="Creates a snapshot policy for the account.") public class CreateSnapshotPolicyCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(CreateSnapshotPolicyCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/CreateStoragePoolCmd.java b/server/src/com/cloud/api/commands/CreateStoragePoolCmd.java index b5fbb923fd2..a780e6b002b 100644 --- a/server/src/com/cloud/api/commands/CreateStoragePoolCmd.java +++ b/server/src/com/cloud/api/commands/CreateStoragePoolCmd.java @@ -32,7 +32,7 @@ import com.cloud.storage.StoragePoolVO; import com.cloud.storage.StorageStats; @SuppressWarnings("rawtypes") -@Implementation(method="createPool", manager=Manager.StorageManager) +@Implementation(method="createPool", manager=Manager.StorageManager, description="Creates a storage pool.") public class CreateStoragePoolCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(CreateStoragePoolCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/CreateTemplateCmd.java b/server/src/com/cloud/api/commands/CreateTemplateCmd.java index 75ce3298814..faf4cf04a7c 100644 --- a/server/src/com/cloud/api/commands/CreateTemplateCmd.java +++ b/server/src/com/cloud/api/commands/CreateTemplateCmd.java @@ -36,7 +36,9 @@ import com.cloud.storage.VMTemplateVO; import com.cloud.storage.VolumeVO; import com.cloud.user.Account; -@Implementation(method="createPrivateTemplate", createMethod="createPrivateTemplateRecord", manager=Manager.UserVmManager) +@Implementation(method="createPrivateTemplate", createMethod="createPrivateTemplateRecord", manager=Manager.UserVmManager, 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.") public class CreateTemplateCmd extends BaseAsyncCreateCmd { public static final Logger s_logger = Logger.getLogger(CreateTemplateCmd.class.getName()); private static final String s_name = "createtemplateresponse"; diff --git a/server/src/com/cloud/api/commands/CreateUserCmd.java b/server/src/com/cloud/api/commands/CreateUserCmd.java index 21950466de6..a23fac3d7fe 100644 --- a/server/src/com/cloud/api/commands/CreateUserCmd.java +++ b/server/src/com/cloud/api/commands/CreateUserCmd.java @@ -27,7 +27,7 @@ import com.cloud.api.Parameter; import com.cloud.api.response.UserResponse; import com.cloud.user.UserAccount; -@Implementation(method="createUser") +@Implementation(method="createUser", description="Creates a user account") public class CreateUserCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(CreateUserCmd.class.getName()); @@ -37,31 +37,31 @@ public class CreateUserCmd extends BaseCmd { //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="account", type=CommandType.STRING) + @Parameter(name="account", type=CommandType.STRING, description="Creates the user under the specified account. If no account is specified, the username will be used as the account name.") private String accountName; - @Parameter(name="accounttype", type=CommandType.LONG, required=true) + @Parameter(name="accounttype", type=CommandType.LONG, required=true, description="Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin") private Long accountType; - @Parameter(name="domainid", type=CommandType.LONG) + @Parameter(name="domainid", type=CommandType.LONG, description="Creates the user under the specified domain.") private Long domainId; - @Parameter(name="email", type=CommandType.STRING, required=true) + @Parameter(name="email", type=CommandType.STRING, required=true, description="email") private String email; - @Parameter(name="firstname", type=CommandType.STRING, required=true) + @Parameter(name="firstname", type=CommandType.STRING, required=true, description="firstname") private String firstname; - @Parameter(name="lastname", type=CommandType.STRING, required=true) + @Parameter(name="lastname", type=CommandType.STRING, required=true, description="lastname") private String lastname; - @Parameter(name="password", type=CommandType.STRING, required=true) + @Parameter(name="password", type=CommandType.STRING, required=true, description="Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.") private String password; - @Parameter(name="timezone", type=CommandType.STRING) + @Parameter(name="timezone", type=CommandType.STRING, description="Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.") private String timezone; - @Parameter(name="username", type=CommandType.STRING, required=true) + @Parameter(name="username", type=CommandType.STRING, required=true, description="Unique username.") private String username; diff --git a/server/src/com/cloud/api/commands/CreateVlanIpRangeCmd.java b/server/src/com/cloud/api/commands/CreateVlanIpRangeCmd.java index 3cc953fa4f1..e1f96e1c9c1 100644 --- a/server/src/com/cloud/api/commands/CreateVlanIpRangeCmd.java +++ b/server/src/com/cloud/api/commands/CreateVlanIpRangeCmd.java @@ -28,7 +28,7 @@ import com.cloud.api.Parameter; import com.cloud.api.response.VlanIpRangeResponse; import com.cloud.dc.VlanVO; -@Implementation(method="createVlanAndPublicIpRange", manager=Manager.ConfigManager) +@Implementation(method="createVlanAndPublicIpRange", manager=Manager.ConfigManager, description="Creates a VLAN IP range.") public class CreateVlanIpRangeCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(CreateVlanIpRangeCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/CreateVolumeCmd.java b/server/src/com/cloud/api/commands/CreateVolumeCmd.java index b0b66bef186..5f93550bbac 100644 --- a/server/src/com/cloud/api/commands/CreateVolumeCmd.java +++ b/server/src/com/cloud/api/commands/CreateVolumeCmd.java @@ -32,7 +32,8 @@ import com.cloud.storage.VolumeVO; import com.cloud.user.Account; import com.cloud.user.UserContext; -@Implementation(createMethod="createVolumeDB", method="createVolume", manager=Manager.StorageManager) +@Implementation(createMethod="createVolumeDB", method="createVolume", manager=Manager.StorageManager, 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.") public class CreateVolumeCmd extends BaseAsyncCreateCmd { public static final Logger s_logger = Logger.getLogger(CreateVolumeCmd.class.getName()); private static final String s_name = "createvolumeresponse"; diff --git a/server/src/com/cloud/api/commands/CreateZoneCmd.java b/server/src/com/cloud/api/commands/CreateZoneCmd.java index cd7ffbbff65..64e559a53f3 100644 --- a/server/src/com/cloud/api/commands/CreateZoneCmd.java +++ b/server/src/com/cloud/api/commands/CreateZoneCmd.java @@ -27,7 +27,7 @@ import com.cloud.api.Parameter; import com.cloud.api.response.ZoneResponse; import com.cloud.dc.DataCenterVO; -@Implementation(method="createZone", manager=Manager.ConfigManager) +@Implementation(method="createZone", manager=Manager.ConfigManager, description="Creates a Zone.") public class CreateZoneCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(CreateZoneCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/DeleteDiskOfferingCmd.java b/server/src/com/cloud/api/commands/DeleteDiskOfferingCmd.java index 0a51b654960..3d6d14a484a 100644 --- a/server/src/com/cloud/api/commands/DeleteDiskOfferingCmd.java +++ b/server/src/com/cloud/api/commands/DeleteDiskOfferingCmd.java @@ -26,7 +26,7 @@ import com.cloud.api.Parameter; import com.cloud.api.ServerApiException; import com.cloud.api.response.SuccessResponse; -@Implementation(method="deleteDiskOffering", manager=Manager.ConfigManager) +@Implementation(method="deleteDiskOffering", manager=Manager.ConfigManager, description="Updates a disk offering.") public class DeleteDiskOfferingCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(DeleteDiskOfferingCmd.class.getName()); private static final String s_name = "deletediskofferingresponse"; diff --git a/server/src/com/cloud/api/commands/DeleteDomainCmd.java b/server/src/com/cloud/api/commands/DeleteDomainCmd.java index ae9a5950d2a..40bc5d3a3c4 100644 --- a/server/src/com/cloud/api/commands/DeleteDomainCmd.java +++ b/server/src/com/cloud/api/commands/DeleteDomainCmd.java @@ -28,7 +28,7 @@ import com.cloud.domain.DomainVO; import com.cloud.event.EventTypes; import com.cloud.user.Account; -@Implementation(method="deleteDomain") +@Implementation(method="deleteDomain", description="Deletes a specified domain") public class DeleteDomainCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(DeleteDomainCmd.class.getName()); private static final String s_name = "deletedomainresponse"; @@ -37,7 +37,7 @@ public class DeleteDomainCmd extends BaseAsyncCmd { //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="id", type=CommandType.LONG, required=true) + @Parameter(name="id", type=CommandType.LONG, required=true, description="ID of domain to delete") private Long id; @Parameter(name="cleanup", type=CommandType.BOOLEAN) diff --git a/server/src/com/cloud/api/commands/DeleteHostCmd.java b/server/src/com/cloud/api/commands/DeleteHostCmd.java index e3e07951a5d..9cd6739d9ec 100644 --- a/server/src/com/cloud/api/commands/DeleteHostCmd.java +++ b/server/src/com/cloud/api/commands/DeleteHostCmd.java @@ -28,7 +28,7 @@ import com.cloud.api.ServerApiException; import com.cloud.api.response.SuccessResponse; -@Implementation(method="deleteHost", manager=Manager.AgentManager) +@Implementation(method="deleteHost", manager=Manager.AgentManager, description="Deletes a host.") public class DeleteHostCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(DeleteHostCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/DeleteIPForwardingRuleCmd.java b/server/src/com/cloud/api/commands/DeleteIPForwardingRuleCmd.java index 513dd50a86c..1ebda3908a2 100644 --- a/server/src/com/cloud/api/commands/DeleteIPForwardingRuleCmd.java +++ b/server/src/com/cloud/api/commands/DeleteIPForwardingRuleCmd.java @@ -25,7 +25,7 @@ import com.cloud.api.Implementation; import com.cloud.api.Parameter; import com.cloud.api.response.SuccessResponse; -@Implementation(method="deleteIpForwardingRule", manager=Manager.NetworkManager) +@Implementation(method="deleteIpForwardingRule", manager=Manager.NetworkManager, description="Deletes a port forwarding rule") public class DeleteIPForwardingRuleCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(DeleteIPForwardingRuleCmd.class.getName()); private static final String s_name = "deleteportforwardingruleresponse"; @@ -34,7 +34,7 @@ public class DeleteIPForwardingRuleCmd extends BaseCmd { //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="id", type=CommandType.LONG, required=true) + @Parameter(name="id", type=CommandType.LONG, required=true, description="the ID of the port forwarding rule") private Long id; diff --git a/server/src/com/cloud/api/commands/DeleteIsoCmd.java b/server/src/com/cloud/api/commands/DeleteIsoCmd.java index 7904e7c30ec..2dcc39b8b59 100644 --- a/server/src/com/cloud/api/commands/DeleteIsoCmd.java +++ b/server/src/com/cloud/api/commands/DeleteIsoCmd.java @@ -26,7 +26,7 @@ import com.cloud.api.Parameter; import com.cloud.api.ServerApiException; import com.cloud.api.response.SuccessResponse; -@Implementation(method="deleteIso", manager=Manager.TemplateManager) +@Implementation(method="deleteIso", manager=Manager.TemplateManager, description="Deletes an ISO file.") public class DeleteIsoCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(DeleteIsoCmd.class.getName()); private static final String s_name = "deleteisosresponse"; diff --git a/server/src/com/cloud/api/commands/DeleteLoadBalancerRuleCmd.java b/server/src/com/cloud/api/commands/DeleteLoadBalancerRuleCmd.java index bbf44b2ddba..8ffd3033c1b 100644 --- a/server/src/com/cloud/api/commands/DeleteLoadBalancerRuleCmd.java +++ b/server/src/com/cloud/api/commands/DeleteLoadBalancerRuleCmd.java @@ -29,7 +29,7 @@ import com.cloud.event.EventTypes; import com.cloud.network.LoadBalancerVO; import com.cloud.user.Account; -@Implementation(method="deleteLoadBalancerRule", manager=Manager.NetworkManager) +@Implementation(method="deleteLoadBalancerRule", manager=Manager.NetworkManager, description="Deletes a load balancer rule.") public class DeleteLoadBalancerRuleCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(DeleteLoadBalancerRuleCmd.class.getName()); private static final String s_name = "deleteloadbalancerruleresponse"; diff --git a/server/src/com/cloud/api/commands/DeletePodCmd.java b/server/src/com/cloud/api/commands/DeletePodCmd.java index a94f85eea5f..e6ecc69cc57 100644 --- a/server/src/com/cloud/api/commands/DeletePodCmd.java +++ b/server/src/com/cloud/api/commands/DeletePodCmd.java @@ -27,7 +27,7 @@ import com.cloud.api.Parameter; import com.cloud.api.ServerApiException; import com.cloud.api.response.SuccessResponse; -@Implementation(method="deletePod", manager=Manager.ConfigManager) +@Implementation(method="deletePod", manager=Manager.ConfigManager, description="Deletes a Pod.") public class DeletePodCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(DeletePodCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/DeletePoolCmd.java b/server/src/com/cloud/api/commands/DeletePoolCmd.java index 25d012f4fe0..d8ffb206752 100644 --- a/server/src/com/cloud/api/commands/DeletePoolCmd.java +++ b/server/src/com/cloud/api/commands/DeletePoolCmd.java @@ -9,7 +9,7 @@ import com.cloud.api.Parameter; import com.cloud.api.ServerApiException; import com.cloud.api.response.SuccessResponse; -@Implementation(method="deletePool", manager=Manager.StorageManager) +@Implementation(method="deletePool", manager=Manager.StorageManager, description="Deletes a storage pool.") public class DeletePoolCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(DeletePoolCmd.class.getName()); private static final String s_name = "deletepoolresponse"; diff --git a/server/src/com/cloud/api/commands/DeletePortForwardingServiceCmd.java b/server/src/com/cloud/api/commands/DeletePortForwardingServiceCmd.java index 99efc44ac20..b2af8328d1f 100644 --- a/server/src/com/cloud/api/commands/DeletePortForwardingServiceCmd.java +++ b/server/src/com/cloud/api/commands/DeletePortForwardingServiceCmd.java @@ -32,7 +32,7 @@ import com.cloud.event.EventTypes; import com.cloud.network.SecurityGroupVO; import com.cloud.user.Account; -@Implementation(method="deleteSecurityGroup", manager=Manager.ManagementServer) +@Implementation(method="deleteSecurityGroup", manager=Manager.ManagementServer, description="Deletes a port forwarding service") public class DeletePortForwardingServiceCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(DeletePortForwardingServiceCmd.class.getName()); private static final String s_name = "deleteportforwardingserviceresponse"; diff --git a/server/src/com/cloud/api/commands/DeletePortForwardingServiceRuleCmd.java b/server/src/com/cloud/api/commands/DeletePortForwardingServiceRuleCmd.java index 8804f967cf2..2881c670459 100644 --- a/server/src/com/cloud/api/commands/DeletePortForwardingServiceRuleCmd.java +++ b/server/src/com/cloud/api/commands/DeletePortForwardingServiceRuleCmd.java @@ -31,7 +31,7 @@ import com.cloud.network.NetworkRuleConfigVO; import com.cloud.network.SecurityGroupVO; import com.cloud.user.Account; -@Implementation(method="deleteNetworkRuleConfig", manager=Manager.NetworkManager) +@Implementation(method="deleteNetworkRuleConfig", manager=Manager.NetworkManager, description="Deletes a port forwarding service rule") public class DeletePortForwardingServiceRuleCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(DeletePortForwardingServiceRuleCmd.class.getName()); @@ -41,7 +41,7 @@ public class DeletePortForwardingServiceRuleCmd extends BaseAsyncCmd { //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="id", type=CommandType.LONG, required=true) + @Parameter(name="id", type=CommandType.LONG, required=true, description="The ID of the port forwarding service rule") private Long id; ///////////////////////////////////////////////////// diff --git a/server/src/com/cloud/api/commands/DeleteServiceOfferingCmd.java b/server/src/com/cloud/api/commands/DeleteServiceOfferingCmd.java index 1d890557b71..3316c727076 100644 --- a/server/src/com/cloud/api/commands/DeleteServiceOfferingCmd.java +++ b/server/src/com/cloud/api/commands/DeleteServiceOfferingCmd.java @@ -26,7 +26,7 @@ import com.cloud.api.Implementation; import com.cloud.api.Parameter; import com.cloud.api.response.SuccessResponse; -@Implementation(method="deleteServiceOffering", manager=Manager.ConfigManager) +@Implementation(method="deleteServiceOffering", manager=Manager.ConfigManager, description="Deletes a service offering.") public class DeleteServiceOfferingCmd extends BaseCmd{ public static final Logger s_logger = Logger.getLogger(DeleteServiceOfferingCmd.class.getName()); private static final String s_name = "deleteserviceofferingresponse"; diff --git a/server/src/com/cloud/api/commands/DeleteSnapshotCmd.java b/server/src/com/cloud/api/commands/DeleteSnapshotCmd.java index f9ced14b109..511daa32970 100644 --- a/server/src/com/cloud/api/commands/DeleteSnapshotCmd.java +++ b/server/src/com/cloud/api/commands/DeleteSnapshotCmd.java @@ -30,7 +30,7 @@ import com.cloud.event.EventTypes; import com.cloud.storage.Snapshot; import com.cloud.user.Account; -@Implementation(method="deleteSnapshot", manager=Manager.SnapshotManager) +@Implementation(method="deleteSnapshot", manager=Manager.SnapshotManager, description="Deletes a snapshot of a disk volume.") public class DeleteSnapshotCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(DeleteSnapshotCmd.class.getName()); private static final String s_name = "deletesnapshotresponse"; diff --git a/server/src/com/cloud/api/commands/DeleteSnapshotPoliciesCmd.java b/server/src/com/cloud/api/commands/DeleteSnapshotPoliciesCmd.java index a38d913277c..cb8a25abfea 100644 --- a/server/src/com/cloud/api/commands/DeleteSnapshotPoliciesCmd.java +++ b/server/src/com/cloud/api/commands/DeleteSnapshotPoliciesCmd.java @@ -28,7 +28,7 @@ import com.cloud.api.Implementation; import com.cloud.api.Parameter; import com.cloud.api.response.SuccessResponse; -@Implementation(method="deleteSnapshotPolicies", manager=Manager.SnapshotManager) +@Implementation(method="deleteSnapshotPolicies", manager=Manager.SnapshotManager, description="Deletes snapshot policies for the account.") public class DeleteSnapshotPoliciesCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(DeleteSnapshotPoliciesCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/DeleteTemplateCmd.java b/server/src/com/cloud/api/commands/DeleteTemplateCmd.java index 031c5a0fbf0..de2c781b050 100644 --- a/server/src/com/cloud/api/commands/DeleteTemplateCmd.java +++ b/server/src/com/cloud/api/commands/DeleteTemplateCmd.java @@ -26,7 +26,7 @@ import com.cloud.api.Implementation; import com.cloud.api.Parameter; import com.cloud.api.response.SuccessResponse; -@Implementation(method="deleteTemplate", manager=Manager.TemplateManager) +@Implementation(method="deleteTemplate", manager=Manager.TemplateManager, description="Deletes a template from the system. All virtual machines using the deleted template will not be affected.") public class DeleteTemplateCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(DeleteTemplateCmd.class.getName()); private static final String s_name = "deletetemplateresponse"; diff --git a/server/src/com/cloud/api/commands/DeleteUserCmd.java b/server/src/com/cloud/api/commands/DeleteUserCmd.java index b5bc13f4c6b..8e943605007 100644 --- a/server/src/com/cloud/api/commands/DeleteUserCmd.java +++ b/server/src/com/cloud/api/commands/DeleteUserCmd.java @@ -29,7 +29,7 @@ import com.cloud.event.EventTypes; import com.cloud.user.Account; import com.cloud.user.UserContext; -@Implementation(method="deleteUser", manager=Manager.ManagementServer) +@Implementation(method="deleteUser", manager=Manager.ManagementServer, description="Deletes a user account") public class DeleteUserCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(DeleteUserCmd.class.getName()); private static final String s_name = "deleteuserresponse"; @@ -38,7 +38,7 @@ public class DeleteUserCmd extends BaseAsyncCmd { //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="id", type=CommandType.LONG, required=true) + @Parameter(name="id", type=CommandType.LONG, required=true, description="User id") private Long id; diff --git a/server/src/com/cloud/api/commands/DeleteVlanIpRangeCmd.java b/server/src/com/cloud/api/commands/DeleteVlanIpRangeCmd.java index 315f614a8eb..da020dc7a1a 100644 --- a/server/src/com/cloud/api/commands/DeleteVlanIpRangeCmd.java +++ b/server/src/com/cloud/api/commands/DeleteVlanIpRangeCmd.java @@ -26,7 +26,7 @@ import com.cloud.api.Implementation; import com.cloud.api.Parameter; import com.cloud.api.response.SuccessResponse; -@Implementation(method="deleteVlanIpRange", manager=Manager.ConfigManager) +@Implementation(method="deleteVlanIpRange", manager=Manager.ConfigManager, description="Creates a VLAN IP range.") public class DeleteVlanIpRangeCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(DeleteVlanIpRangeCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/DeleteVolumeCmd.java b/server/src/com/cloud/api/commands/DeleteVolumeCmd.java index d5975d5ddd7..1c21f3e01c8 100644 --- a/server/src/com/cloud/api/commands/DeleteVolumeCmd.java +++ b/server/src/com/cloud/api/commands/DeleteVolumeCmd.java @@ -26,7 +26,7 @@ import com.cloud.api.Implementation; import com.cloud.api.Parameter; import com.cloud.api.response.SuccessResponse; -@Implementation(method="deleteVolume", manager=Manager.StorageManager) +@Implementation(method="deleteVolume", manager=Manager.StorageManager, description="Deletes a detached disk volume.") public class DeleteVolumeCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(DeleteVolumeCmd.class.getName()); private static final String s_name = "deletevolumeresponse"; diff --git a/server/src/com/cloud/api/commands/DeleteZoneCmd.java b/server/src/com/cloud/api/commands/DeleteZoneCmd.java index 58da9f5389c..6fc3f3528ea 100644 --- a/server/src/com/cloud/api/commands/DeleteZoneCmd.java +++ b/server/src/com/cloud/api/commands/DeleteZoneCmd.java @@ -26,7 +26,7 @@ import com.cloud.api.Implementation; import com.cloud.api.Parameter; import com.cloud.api.response.SuccessResponse; -@Implementation(method="deleteZone", manager=Manager.ConfigManager) +@Implementation(method="deleteZone", manager=Manager.ConfigManager, description="Deletes a Zone.") public class DeleteZoneCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(DeleteZoneCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/DeployVMCmd.java b/server/src/com/cloud/api/commands/DeployVMCmd.java index ff87c49dafa..7389cae39ff 100644 --- a/server/src/com/cloud/api/commands/DeployVMCmd.java +++ b/server/src/com/cloud/api/commands/DeployVMCmd.java @@ -37,7 +37,7 @@ import com.cloud.user.UserContext; import com.cloud.uservm.UserVm; import com.cloud.vm.InstanceGroupVO; -@Implementation(method="deployVirtualMachine") +@Implementation(method="deployVirtualMachine", description="Creates and automatically starts a virtual machine based on a service offering, disk offering, and template.") public class DeployVMCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(DeployVMCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/DestroyVMCmd.java b/server/src/com/cloud/api/commands/DestroyVMCmd.java index 5a087e7c4b3..98496b83d77 100644 --- a/server/src/com/cloud/api/commands/DestroyVMCmd.java +++ b/server/src/com/cloud/api/commands/DestroyVMCmd.java @@ -29,7 +29,7 @@ import com.cloud.event.EventTypes; import com.cloud.user.Account; import com.cloud.uservm.UserVm; -@Implementation(method="destroyVm", manager=Manager.UserVmManager) +@Implementation(method="destroyVm", manager=Manager.UserVmManager, description="Destroys a virtual machine. Once destroyed, only the administrator can recover it.") public class DestroyVMCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(DestroyVMCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/DetachIsoCmd.java b/server/src/com/cloud/api/commands/DetachIsoCmd.java index e037846ad0e..115a5ebce71 100644 --- a/server/src/com/cloud/api/commands/DetachIsoCmd.java +++ b/server/src/com/cloud/api/commands/DetachIsoCmd.java @@ -29,7 +29,7 @@ import com.cloud.event.EventTypes; import com.cloud.user.Account; import com.cloud.uservm.UserVm; -@Implementation(method="detachIso", manager=Manager.TemplateManager) +@Implementation(method="detachIso", manager=Manager.TemplateManager, description="Detaches any ISO file (if any) currently attached to a virtual machine.") public class DetachIsoCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(DetachIsoCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/DetachVolumeCmd.java b/server/src/com/cloud/api/commands/DetachVolumeCmd.java index 6ff35af5d2b..8da640716b3 100644 --- a/server/src/com/cloud/api/commands/DetachVolumeCmd.java +++ b/server/src/com/cloud/api/commands/DetachVolumeCmd.java @@ -30,7 +30,7 @@ import com.cloud.storage.VolumeVO; import com.cloud.user.Account; import com.cloud.uservm.UserVm; -@Implementation(method="detachVolumeFromVM", manager=Manager.UserVmManager) +@Implementation(method="detachVolumeFromVM", manager=Manager.UserVmManager, description="Detaches a disk volume from a virtual machine.") public class DetachVolumeCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(DetachVolumeCmd.class.getName()); private static final String s_name = "detachvolumeresponse"; diff --git a/server/src/com/cloud/api/commands/DisableAccountCmd.java b/server/src/com/cloud/api/commands/DisableAccountCmd.java index 01ca937b06b..4fc1ecf242a 100644 --- a/server/src/com/cloud/api/commands/DisableAccountCmd.java +++ b/server/src/com/cloud/api/commands/DisableAccountCmd.java @@ -28,7 +28,7 @@ import com.cloud.event.EventTypes; import com.cloud.user.Account; import com.cloud.user.UserContext; -@Implementation(method="disableAccount", manager=Manager.ManagementServer) +@Implementation(method="disableAccount", manager=Manager.ManagementServer, description="Disables an account") public class DisableAccountCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(DisableAccountCmd.class.getName()); private static final String s_name = "disableaccountresponse"; @@ -37,10 +37,10 @@ public class DisableAccountCmd extends BaseAsyncCmd { //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="account", type=CommandType.STRING) + @Parameter(name="account", type=CommandType.STRING, description="Disables specified account.") private String accountName; - @Parameter(name="domainid", type=CommandType.LONG) + @Parameter(name="domainid", type=CommandType.LONG, description="Disables specified account in this domain.") private Long domainId; ///////////////////////////////////////////////////// diff --git a/server/src/com/cloud/api/commands/DisableUserCmd.java b/server/src/com/cloud/api/commands/DisableUserCmd.java index 54256718390..2366e540874 100644 --- a/server/src/com/cloud/api/commands/DisableUserCmd.java +++ b/server/src/com/cloud/api/commands/DisableUserCmd.java @@ -27,7 +27,7 @@ import com.cloud.event.EventTypes; import com.cloud.user.Account; import com.cloud.user.UserContext; -@Implementation(method="disableUser") +@Implementation(method="disableUser", description="Disables a user account") public class DisableUserCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(DisableUserCmd.class.getName()); private static final String s_name = "disableuserresponse"; @@ -36,7 +36,7 @@ public class DisableUserCmd extends BaseAsyncCmd { //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="id", type=CommandType.LONG, required=true) + @Parameter(name="id", type=CommandType.LONG, required=true, description="Disables user by user ID.") private Long id; ///////////////////////////////////////////////////// diff --git a/server/src/com/cloud/api/commands/DisassociateIPAddrCmd.java b/server/src/com/cloud/api/commands/DisassociateIPAddrCmd.java index dc431e3c01b..14d36e3d768 100644 --- a/server/src/com/cloud/api/commands/DisassociateIPAddrCmd.java +++ b/server/src/com/cloud/api/commands/DisassociateIPAddrCmd.java @@ -25,7 +25,7 @@ import com.cloud.api.Implementation; import com.cloud.api.Parameter; import com.cloud.api.response.SuccessResponse; -@Implementation(method="disassociateIpAddress", manager=Manager.NetworkManager) +@Implementation(method="disassociateIpAddress", manager=Manager.NetworkManager, description="Disassociates an ip address from the account.") public class DisassociateIPAddrCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(DisassociateIPAddrCmd.class.getName()); @@ -35,7 +35,7 @@ public class DisassociateIPAddrCmd extends BaseCmd { //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="ipaddress", type=CommandType.STRING, required=true) + @Parameter(name="ipaddress", type=CommandType.STRING, required=true, description="the public ip address to disassociate") private String ipAddress; ///////////////////////////////////////////////////// diff --git a/server/src/com/cloud/api/commands/EnableAccountCmd.java b/server/src/com/cloud/api/commands/EnableAccountCmd.java index ef3c04cee21..bca9d6f0daa 100644 --- a/server/src/com/cloud/api/commands/EnableAccountCmd.java +++ b/server/src/com/cloud/api/commands/EnableAccountCmd.java @@ -26,7 +26,7 @@ import com.cloud.api.Parameter; import com.cloud.api.ServerApiException; import com.cloud.api.response.SuccessResponse; -@Implementation(method="enableAccount", manager=Manager.ManagementServer) +@Implementation(method="enableAccount", manager=Manager.ManagementServer, description="Enables an account") public class EnableAccountCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(EnableAccountCmd.class.getName()); private static final String s_name = "enableaccountresponse"; @@ -35,10 +35,10 @@ public class EnableAccountCmd extends BaseCmd { //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="account", type=CommandType.STRING) + @Parameter(name="account", type=CommandType.STRING, description="Enables specified account.") private String accountName; - @Parameter(name="domainid", type=CommandType.LONG) + @Parameter(name="domainid", type=CommandType.LONG, description="Enables specified account in this domain.") private Long domainId; ///////////////////////////////////////////////////// diff --git a/server/src/com/cloud/api/commands/EnableUserCmd.java b/server/src/com/cloud/api/commands/EnableUserCmd.java index 4f4adf663b5..e2c07ca0790 100644 --- a/server/src/com/cloud/api/commands/EnableUserCmd.java +++ b/server/src/com/cloud/api/commands/EnableUserCmd.java @@ -27,7 +27,7 @@ import com.cloud.api.Parameter; import com.cloud.api.ServerApiException; import com.cloud.api.response.SuccessResponse; -@Implementation(method="enableUser", manager=Manager.ManagementServer) +@Implementation(method="enableUser", manager=Manager.ManagementServer, description="Enables a user account") public class EnableUserCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(EnableUserCmd.class.getName()); private static final String s_name = "enableuserresponse"; @@ -36,7 +36,7 @@ public class EnableUserCmd extends BaseCmd { //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="id", type=CommandType.LONG, required=true) + @Parameter(name="id", type=CommandType.LONG, required=true, description="Enables user by user ID.") private Long id; diff --git a/server/src/com/cloud/api/commands/GetCloudIdentifierCmd.java b/server/src/com/cloud/api/commands/GetCloudIdentifierCmd.java index 0eb4061d89e..07b8a58e7b5 100644 --- a/server/src/com/cloud/api/commands/GetCloudIdentifierCmd.java +++ b/server/src/com/cloud/api/commands/GetCloudIdentifierCmd.java @@ -29,7 +29,7 @@ import com.cloud.api.Parameter; import com.cloud.api.ServerApiException; import com.cloud.api.response.CloudIdentifierResponse; -@Implementation(method="getCloudIdentifierResponse", manager=Manager.ManagementServer) +@Implementation(method="getCloudIdentifierResponse", manager=Manager.ManagementServer, description="Retrieves a cloud identifier.") public class GetCloudIdentifierCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(GetCloudIdentifierCmd.class.getName()); private static final String s_name = "getcloudidentifierresponse"; diff --git a/server/src/com/cloud/api/commands/ListAccountsCmd.java b/server/src/com/cloud/api/commands/ListAccountsCmd.java index 959090467ee..16845177b91 100644 --- a/server/src/com/cloud/api/commands/ListAccountsCmd.java +++ b/server/src/com/cloud/api/commands/ListAccountsCmd.java @@ -40,7 +40,7 @@ import com.cloud.user.UserStatisticsVO; import com.cloud.uservm.UserVm; import com.cloud.vm.State; -@Implementation(method="searchForAccounts") +@Implementation(method="searchForAccounts", description="Lists accounts and provides detailed account information for listed accounts") public class ListAccountsCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListAccountsCmd.class.getName()); private static final String s_name = "listaccountsresponse"; @@ -49,25 +49,25 @@ public class ListAccountsCmd extends BaseListCmd { //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="account", type=CommandType.STRING) + @Parameter(name="account", type=CommandType.STRING, description="List account for a specified account. Must be used with the domainId parameter.") private String accountName; - @Parameter(name="accounttype", type=CommandType.LONG) + @Parameter(name="accounttype", type=CommandType.LONG, description="List accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).") private Long accountType; - @Parameter(name="domainid", type=CommandType.LONG) + @Parameter(name="domainid", type=CommandType.LONG, description="List all accounts in specified domain. If used with the account parameter, retrieves account information for specified account in specified domain.") private Long domainId; - @Parameter(name="id", type=CommandType.LONG) + @Parameter(name="id", type=CommandType.LONG, description="List account by account ID") private Long id; @Parameter(name="iscleanuprequired", type=CommandType.BOOLEAN) private Boolean cleanupRequired; - @Parameter(name="name", type=CommandType.STRING) + @Parameter(name="name", type=CommandType.STRING, description="List account by account name") private String searchName; - @Parameter(name="state", type=CommandType.STRING) + @Parameter(name="state", type=CommandType.STRING, description="List accounts by state. Valid states are enabled, disabled, and locked.") private String state; diff --git a/server/src/com/cloud/api/commands/ListAlertsCmd.java b/server/src/com/cloud/api/commands/ListAlertsCmd.java index 9e0a9073121..ab3f99c394a 100644 --- a/server/src/com/cloud/api/commands/ListAlertsCmd.java +++ b/server/src/com/cloud/api/commands/ListAlertsCmd.java @@ -29,7 +29,7 @@ import com.cloud.api.Parameter; import com.cloud.api.response.AlertResponse; import com.cloud.api.response.ListResponse; -@Implementation(method="searchForAlerts") +@Implementation(method="searchForAlerts", description="Lists all alerts.") public class ListAlertsCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListAlertsCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ListAsyncJobsCmd.java b/server/src/com/cloud/api/commands/ListAsyncJobsCmd.java index b7c0c6281e4..1d448ad1428 100644 --- a/server/src/com/cloud/api/commands/ListAsyncJobsCmd.java +++ b/server/src/com/cloud/api/commands/ListAsyncJobsCmd.java @@ -30,7 +30,7 @@ import com.cloud.api.response.ListResponse; import com.cloud.async.AsyncJobVO; import com.cloud.serializer.SerializerHelper; -@Implementation(method="searchForAsyncJobs") +@Implementation(method="searchForAsyncJobs", description="Lists all pending asynchronous jobs for the account.") public class ListAsyncJobsCmd extends BaseListCmd { private static final String s_name = "listasyncjobsresponse"; diff --git a/server/src/com/cloud/api/commands/ListCapacityCmd.java b/server/src/com/cloud/api/commands/ListCapacityCmd.java index d2b0c2010c0..f248cb42429 100644 --- a/server/src/com/cloud/api/commands/ListCapacityCmd.java +++ b/server/src/com/cloud/api/commands/ListCapacityCmd.java @@ -40,7 +40,7 @@ import com.cloud.server.Criteria; import com.cloud.storage.Storage.StoragePoolType; import com.cloud.storage.StoragePoolVO; -@Implementation(method="listCapacities") +@Implementation(method="listCapacities", description="Lists capacity.") public class ListCapacityCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListCapacityCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ListCfgsByCmd.java b/server/src/com/cloud/api/commands/ListCfgsByCmd.java index 566b4c89ef8..7e263512138 100644 --- a/server/src/com/cloud/api/commands/ListCfgsByCmd.java +++ b/server/src/com/cloud/api/commands/ListCfgsByCmd.java @@ -30,7 +30,7 @@ import com.cloud.api.response.ConfigurationResponse; import com.cloud.api.response.ListResponse; import com.cloud.configuration.ConfigurationVO; -@Implementation(method="searchForConfigurations") +@Implementation(method="searchForConfigurations", description="Lists all configurations.") public class ListCfgsByCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListCfgsByCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ListClustersCmd.java b/server/src/com/cloud/api/commands/ListClustersCmd.java index 5b1da66949f..06413b91643 100644 --- a/server/src/com/cloud/api/commands/ListClustersCmd.java +++ b/server/src/com/cloud/api/commands/ListClustersCmd.java @@ -33,7 +33,7 @@ import com.cloud.dc.ClusterVO; import com.cloud.dc.DataCenterVO; import com.cloud.dc.HostPodVO; -@Implementation(method="searchForClusters") +@Implementation(method="searchForClusters", description="Lists clusters.") public class ListClustersCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListServiceOfferingsCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ListDiskOfferingsCmd.java b/server/src/com/cloud/api/commands/ListDiskOfferingsCmd.java index 5d2d9b42973..069ca1c5ebb 100644 --- a/server/src/com/cloud/api/commands/ListDiskOfferingsCmd.java +++ b/server/src/com/cloud/api/commands/ListDiskOfferingsCmd.java @@ -31,7 +31,7 @@ import com.cloud.api.response.ListResponse; import com.cloud.domain.DomainVO; import com.cloud.storage.DiskOfferingVO; -@Implementation(method="searchForDiskOfferings") +@Implementation(method="searchForDiskOfferings", description="Lists all available disk offerings.") public class ListDiskOfferingsCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListDiskOfferingsCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ListDomainChildrenCmd.java b/server/src/com/cloud/api/commands/ListDomainChildrenCmd.java index 03635bb26c0..d6e635b21cf 100644 --- a/server/src/com/cloud/api/commands/ListDomainChildrenCmd.java +++ b/server/src/com/cloud/api/commands/ListDomainChildrenCmd.java @@ -30,7 +30,7 @@ import com.cloud.api.response.DomainResponse; import com.cloud.api.response.ListResponse; import com.cloud.domain.DomainVO; -@Implementation(method="searchForDomainChildren") +@Implementation(method="searchForDomainChildren", description="Lists all children domains belonging to a specified domain") public class ListDomainChildrenCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListDomainChildrenCmd.class.getName()); @@ -40,13 +40,13 @@ public class ListDomainChildrenCmd extends BaseListCmd { //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="id", type=CommandType.LONG) + @Parameter(name="id", type=CommandType.LONG, description="list children domain by parent domain ID.") private Long id; - @Parameter(name="isrecursive", type=CommandType.BOOLEAN) + @Parameter(name="isrecursive", type=CommandType.BOOLEAN, 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="name", type=CommandType.STRING) + @Parameter(name="name", type=CommandType.STRING, description="list children domain by parent domain name.") private String domainName; ///////////////////////////////////////////////////// diff --git a/server/src/com/cloud/api/commands/ListDomainsCmd.java b/server/src/com/cloud/api/commands/ListDomainsCmd.java index 3269898bce8..ca49e587762 100644 --- a/server/src/com/cloud/api/commands/ListDomainsCmd.java +++ b/server/src/com/cloud/api/commands/ListDomainsCmd.java @@ -30,7 +30,7 @@ import com.cloud.api.response.DomainResponse; import com.cloud.api.response.ListResponse; import com.cloud.domain.DomainVO; -@Implementation(method="searchForDomains") +@Implementation(method="searchForDomains", description="Lists domains and provides detailed information for listed domains") public class ListDomainsCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListDomainsCmd.class.getName()); @@ -40,13 +40,13 @@ public class ListDomainsCmd extends BaseListCmd { //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="id", type=CommandType.LONG) + @Parameter(name="id", type=CommandType.LONG, description="List domain by domain ID.") private Long id; - @Parameter(name="level", type=CommandType.INTEGER) + @Parameter(name="level", type=CommandType.INTEGER, description="List domains by domain level.") private Integer level; - @Parameter(name="name", type=CommandType.STRING) + @Parameter(name="name", type=CommandType.STRING, description="List domain by domain name.") private String domainName; ///////////////////////////////////////////////////// diff --git a/server/src/com/cloud/api/commands/ListEventsCmd.java b/server/src/com/cloud/api/commands/ListEventsCmd.java index 1ca2816af86..76bc22b58ed 100644 --- a/server/src/com/cloud/api/commands/ListEventsCmd.java +++ b/server/src/com/cloud/api/commands/ListEventsCmd.java @@ -32,7 +32,7 @@ import com.cloud.api.response.ListResponse; import com.cloud.event.EventVO; import com.cloud.user.User; -@Implementation(method="searchForEvents") +@Implementation(method="searchForEvents", description="A command to list events.") public class ListEventsCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListEventsCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ListGuestOsCategoriesCmd.java b/server/src/com/cloud/api/commands/ListGuestOsCategoriesCmd.java index 00170f45ff4..3ecee1ac19a 100644 --- a/server/src/com/cloud/api/commands/ListGuestOsCategoriesCmd.java +++ b/server/src/com/cloud/api/commands/ListGuestOsCategoriesCmd.java @@ -30,7 +30,7 @@ import com.cloud.api.response.GuestOSCategoryResponse; import com.cloud.api.response.ListResponse; import com.cloud.storage.GuestOSCategoryVO; -@Implementation(method="listGuestOSCategoriesByCriteria") +@Implementation(method="listGuestOSCategoriesByCriteria", description="Lists all supported OS categories for this cloud.") public class ListGuestOsCategoriesCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListIsosCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ListGuestOsCmd.java b/server/src/com/cloud/api/commands/ListGuestOsCmd.java index 58793bd2f69..114bae5bcb6 100644 --- a/server/src/com/cloud/api/commands/ListGuestOsCmd.java +++ b/server/src/com/cloud/api/commands/ListGuestOsCmd.java @@ -30,7 +30,7 @@ import com.cloud.api.response.GuestOSResponse; import com.cloud.api.response.ListResponse; import com.cloud.storage.GuestOSVO; -@Implementation(method="listGuestOSByCriteria") +@Implementation(method="listGuestOSByCriteria", description="Lists all supported OS types for this cloud.") public class ListGuestOsCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListIsosCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ListHostsCmd.java b/server/src/com/cloud/api/commands/ListHostsCmd.java index c070590cd13..a454f2c59c4 100644 --- a/server/src/com/cloud/api/commands/ListHostsCmd.java +++ b/server/src/com/cloud/api/commands/ListHostsCmd.java @@ -42,7 +42,7 @@ import com.cloud.offering.ServiceOffering; import com.cloud.storage.GuestOSCategoryVO; import com.cloud.vm.UserVmVO; -@Implementation(method="searchForServers") +@Implementation(method="searchForServers", description="Lists hosts.") public class ListHostsCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListHostsCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ListIsosCmd.java b/server/src/com/cloud/api/commands/ListIsosCmd.java index 099a8d972de..7837aa0c7ea 100644 --- a/server/src/com/cloud/api/commands/ListIsosCmd.java +++ b/server/src/com/cloud/api/commands/ListIsosCmd.java @@ -42,7 +42,7 @@ import com.cloud.storage.dao.VMTemplateDao.TemplateFilter; import com.cloud.user.Account; import com.cloud.user.UserContext; -@Implementation(method="listTemplates") +@Implementation(method="listTemplates", description="Lists all available ISO files.") public class ListIsosCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListIsosCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ListLoadBalancerRuleInstancesCmd.java b/server/src/com/cloud/api/commands/ListLoadBalancerRuleInstancesCmd.java index dae5568650f..1a757b0bafb 100644 --- a/server/src/com/cloud/api/commands/ListLoadBalancerRuleInstancesCmd.java +++ b/server/src/com/cloud/api/commands/ListLoadBalancerRuleInstancesCmd.java @@ -31,7 +31,7 @@ import com.cloud.api.response.UserVmResponse; import com.cloud.user.Account; import com.cloud.vm.UserVmVO; -@Implementation(method="listLoadBalancerInstances") +@Implementation(method="listLoadBalancerInstances", description="List all virtual machine instances that are assigned to a load balancer rule.") public class ListLoadBalancerRuleInstancesCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger (ListLoadBalancerRuleInstancesCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ListLoadBalancerRulesCmd.java b/server/src/com/cloud/api/commands/ListLoadBalancerRulesCmd.java index 8791033ee02..9e8c9ecfb35 100644 --- a/server/src/com/cloud/api/commands/ListLoadBalancerRulesCmd.java +++ b/server/src/com/cloud/api/commands/ListLoadBalancerRulesCmd.java @@ -32,7 +32,7 @@ import com.cloud.api.response.LoadBalancerResponse; import com.cloud.network.LoadBalancerVO; import com.cloud.user.Account; -@Implementation(method="searchForLoadBalancers") +@Implementation(method="searchForLoadBalancers", description="Lists load balancer rules.") public class ListLoadBalancerRulesCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger (ListLoadBalancerRulesCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ListPodsByCmd.java b/server/src/com/cloud/api/commands/ListPodsByCmd.java index c167ed83bb4..b0d945a871f 100644 --- a/server/src/com/cloud/api/commands/ListPodsByCmd.java +++ b/server/src/com/cloud/api/commands/ListPodsByCmd.java @@ -31,7 +31,7 @@ import com.cloud.api.response.PodResponse; import com.cloud.dc.HostPodVO; import com.cloud.test.PodZoneConfig; -@Implementation(method="searchForPods") +@Implementation(method="searchForPods", description="Lists all Pods.") public class ListPodsByCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListPodsByCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ListPortForwardingRulesCmd.java b/server/src/com/cloud/api/commands/ListPortForwardingRulesCmd.java index 44b49f4962a..105955deb34 100644 --- a/server/src/com/cloud/api/commands/ListPortForwardingRulesCmd.java +++ b/server/src/com/cloud/api/commands/ListPortForwardingRulesCmd.java @@ -36,7 +36,7 @@ import com.cloud.network.IPAddressVO; import com.cloud.server.Criteria; import com.cloud.vm.UserVmVO; -@Implementation(method="listPortForwardingRules", manager=Manager.NetworkManager) +@Implementation(method="listPortForwardingRules", manager=Manager.NetworkManager, description="Lists all port forwarding rules for an IP address.") public class ListPortForwardingRulesCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListPortForwardingRulesCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ListPortForwardingServiceRulesCmd.java b/server/src/com/cloud/api/commands/ListPortForwardingServiceRulesCmd.java index 17393a29b5a..9ab025bc804 100644 --- a/server/src/com/cloud/api/commands/ListPortForwardingServiceRulesCmd.java +++ b/server/src/com/cloud/api/commands/ListPortForwardingServiceRulesCmd.java @@ -31,7 +31,7 @@ import com.cloud.api.response.PortForwardingServiceRuleResponse; import com.cloud.async.AsyncJobVO; import com.cloud.network.NetworkRuleConfigVO; -@Implementation(method="searchForNetworkRules") +@Implementation(method="searchForNetworkRules", description="List port forwarding service rules") public class ListPortForwardingServiceRulesCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListPortForwardingServiceRulesCmd.class.getName()); @@ -41,16 +41,16 @@ public class ListPortForwardingServiceRulesCmd extends BaseListCmd { //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="account", type=CommandType.STRING) + @Parameter(name="account", type=CommandType.STRING, description="the account associated with the port forwarding service rule. Must be used with the domainId parameter.") private String accountName; - @Parameter(name="domainid", type=CommandType.LONG) + @Parameter(name="domainid", type=CommandType.LONG, description="the domainId associated with the port forwarding service rule. If used with the account parameter, returns a list of port forwarding service rules for an account for the specified domain ID.") private Long domainId; - @Parameter(name="id", type=CommandType.LONG) + @Parameter(name="id", type=CommandType.LONG, description="the ID of the port forwarding service rule") private Long id; - @Parameter(name="portforwardingserviceid", type=CommandType.LONG) + @Parameter(name="portforwardingserviceid", type=CommandType.LONG, description="the ID of the port forwarding service the rule is being created for") private Long portForwardingServiceId; ///////////////////////////////////////////////////// diff --git a/server/src/com/cloud/api/commands/ListPortForwardingServicesByVmCmd.java b/server/src/com/cloud/api/commands/ListPortForwardingServicesByVmCmd.java index 947cd9c82da..52527bee8fb 100644 --- a/server/src/com/cloud/api/commands/ListPortForwardingServicesByVmCmd.java +++ b/server/src/com/cloud/api/commands/ListPortForwardingServicesByVmCmd.java @@ -33,7 +33,7 @@ import com.cloud.api.response.SecurityGroupResponse; import com.cloud.network.SecurityGroupVO; import com.cloud.user.Account; -@Implementation(method="searchForSecurityGroupsByVM") +@Implementation(method="searchForSecurityGroupsByVM", description="Lists all port forwarding services applied to a virtual machine given the public ip address") public class ListPortForwardingServicesByVmCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListPortForwardingServicesByVmCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ListPortForwardingServicesCmd.java b/server/src/com/cloud/api/commands/ListPortForwardingServicesCmd.java index 558530d5302..6737ba08150 100644 --- a/server/src/com/cloud/api/commands/ListPortForwardingServicesCmd.java +++ b/server/src/com/cloud/api/commands/ListPortForwardingServicesCmd.java @@ -32,7 +32,7 @@ import com.cloud.api.response.SecurityGroupResponse; import com.cloud.network.SecurityGroupVO; import com.cloud.user.Account; -@Implementation(method="searchForSecurityGroups") +@Implementation(method="searchForSecurityGroups", description="Lists all available port forwarding services") public class ListPortForwardingServicesCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListPortForwardingServicesCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ListPublicIpAddressesCmd.java b/server/src/com/cloud/api/commands/ListPublicIpAddressesCmd.java index e2d06acc521..511f1c1eb6f 100644 --- a/server/src/com/cloud/api/commands/ListPublicIpAddressesCmd.java +++ b/server/src/com/cloud/api/commands/ListPublicIpAddressesCmd.java @@ -35,7 +35,7 @@ import com.cloud.network.IPAddressVO; import com.cloud.user.Account; import com.cloud.user.UserContext; -@Implementation(method="searchForIPAddresses") +@Implementation(method="searchForIPAddresses", description="Lists all public ip addresses") public class ListPublicIpAddressesCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListPublicIpAddressesCmd.class.getName()); @@ -45,25 +45,25 @@ public class ListPublicIpAddressesCmd extends BaseListCmd { //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="account", type=CommandType.STRING) + @Parameter(name="account", type=CommandType.STRING, description="lists all public IP addresses by account. Must be used with the domainId parameter.") private String accountName; - @Parameter(name="allocatedonly", type=CommandType.BOOLEAN) + @Parameter(name="allocatedonly", type=CommandType.BOOLEAN, description="limits search results to allocated public IP addresses") private Boolean allocatedOnly; - @Parameter(name="domainid", type=CommandType.LONG) + @Parameter(name="domainid", type=CommandType.LONG, description="lists all public IP addresses by domain ID. If used with the account parameter, lists all public IP addresses by account for specified domain.") private Long domainId; - @Parameter(name="forvirtualnetwork", type=CommandType.BOOLEAN) + @Parameter(name="forvirtualnetwork", type=CommandType.BOOLEAN, description="the virtual network for the IP address") private Boolean forVirtualNetwork; - @Parameter(name="ipaddress", type=CommandType.STRING) + @Parameter(name="ipaddress", type=CommandType.STRING, description="lists the specified IP address") private String ipAddress; - @Parameter(name="vlanid", type=CommandType.LONG) + @Parameter(name="vlanid", type=CommandType.LONG, description="lists all public IP addresses by VLAN ID") private Long vlanId; - @Parameter(name="zoneid", type=CommandType.LONG) + @Parameter(name="zoneid", type=CommandType.LONG, description="lists all public IP addresses by Zone ID") private Long zoneId; ///////////////////////////////////////////////////// diff --git a/server/src/com/cloud/api/commands/ListResourceLimitsCmd.java b/server/src/com/cloud/api/commands/ListResourceLimitsCmd.java index c2c4df3f34d..a5f392b3d1d 100644 --- a/server/src/com/cloud/api/commands/ListResourceLimitsCmd.java +++ b/server/src/com/cloud/api/commands/ListResourceLimitsCmd.java @@ -33,7 +33,7 @@ import com.cloud.api.response.ResourceLimitResponse; import com.cloud.configuration.ResourceLimitVO; import com.cloud.user.Account; -@Implementation(method="searchForLimits", manager=Manager.AccountManager) +@Implementation(method="searchForLimits", manager=Manager.AccountManager, description="Lists resource limits.") public class ListResourceLimitsCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListResourceLimitsCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ListRoutersCmd.java b/server/src/com/cloud/api/commands/ListRoutersCmd.java index 0246e119b64..bf222491539 100644 --- a/server/src/com/cloud/api/commands/ListRoutersCmd.java +++ b/server/src/com/cloud/api/commands/ListRoutersCmd.java @@ -33,7 +33,7 @@ import com.cloud.async.AsyncJobVO; import com.cloud.user.Account; import com.cloud.vm.DomainRouterVO; -@Implementation(method="searchForRouters") +@Implementation(method="searchForRouters", description="List routers.") public class ListRoutersCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListRoutersCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ListServiceOfferingsCmd.java b/server/src/com/cloud/api/commands/ListServiceOfferingsCmd.java index 74dcb749e1a..3b6e98323f5 100644 --- a/server/src/com/cloud/api/commands/ListServiceOfferingsCmd.java +++ b/server/src/com/cloud/api/commands/ListServiceOfferingsCmd.java @@ -30,7 +30,7 @@ import com.cloud.api.response.ServiceOfferingResponse; import com.cloud.offering.NetworkOffering.GuestIpType; import com.cloud.service.ServiceOfferingVO; -@Implementation(method="searchForServiceOfferings") +@Implementation(method="searchForServiceOfferings", description="Lists all available service offerings.") public class ListServiceOfferingsCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListServiceOfferingsCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ListSnapshotPoliciesCmd.java b/server/src/com/cloud/api/commands/ListSnapshotPoliciesCmd.java index 49597568c14..9e36be5565c 100644 --- a/server/src/com/cloud/api/commands/ListSnapshotPoliciesCmd.java +++ b/server/src/com/cloud/api/commands/ListSnapshotPoliciesCmd.java @@ -31,7 +31,7 @@ import com.cloud.api.response.ListResponse; import com.cloud.api.response.SnapshotPolicyResponse; import com.cloud.storage.SnapshotPolicyVO; -@Implementation(method="listPoliciesforVolume", manager=Manager.SnapshotManager) +@Implementation(method="listPoliciesforVolume", manager=Manager.SnapshotManager, description="Lists snapshot policies.") public class ListSnapshotPoliciesCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListSnapshotPoliciesCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ListSnapshotsCmd.java b/server/src/com/cloud/api/commands/ListSnapshotsCmd.java index 2426e127749..b331b922f5a 100644 --- a/server/src/com/cloud/api/commands/ListSnapshotsCmd.java +++ b/server/src/com/cloud/api/commands/ListSnapshotsCmd.java @@ -35,7 +35,7 @@ import com.cloud.storage.SnapshotVO; import com.cloud.storage.VolumeVO; import com.cloud.user.Account; -@Implementation(method="listSnapshots") +@Implementation(method="listSnapshots", description="Lists all available snapshots for the account.") public class ListSnapshotsCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListSnapshotsCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ListStoragePoolsCmd.java b/server/src/com/cloud/api/commands/ListStoragePoolsCmd.java index 3006a550ede..9acd9f2a009 100644 --- a/server/src/com/cloud/api/commands/ListStoragePoolsCmd.java +++ b/server/src/com/cloud/api/commands/ListStoragePoolsCmd.java @@ -33,7 +33,7 @@ import com.cloud.dc.ClusterVO; import com.cloud.storage.StoragePoolVO; import com.cloud.storage.StorageStats; -@Implementation(method="searchForStoragePools") +@Implementation(method="searchForStoragePools", description="Lists storage pools.") public class ListStoragePoolsCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListStoragePoolsCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ListSystemVMsCmd.java b/server/src/com/cloud/api/commands/ListSystemVMsCmd.java index 4de76065c30..2e17d3d4d87 100644 --- a/server/src/com/cloud/api/commands/ListSystemVMsCmd.java +++ b/server/src/com/cloud/api/commands/ListSystemVMsCmd.java @@ -34,7 +34,7 @@ import com.cloud.vm.SecondaryStorageVmVO; import com.cloud.vm.SystemVm; import com.cloud.vm.VMInstanceVO; -@Implementation(method="searchForSystemVm") +@Implementation(method="searchForSystemVm", description="List system virtual machines.") public class ListSystemVMsCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListSystemVMsCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ListTemplateOrIsoPermissionsCmd.java b/server/src/com/cloud/api/commands/ListTemplateOrIsoPermissionsCmd.java index a877aa63ac9..f56015093f1 100644 --- a/server/src/com/cloud/api/commands/ListTemplateOrIsoPermissionsCmd.java +++ b/server/src/com/cloud/api/commands/ListTemplateOrIsoPermissionsCmd.java @@ -30,7 +30,7 @@ import com.cloud.storage.VMTemplateVO; import com.cloud.user.Account; import com.cloud.user.UserContext; -@Implementation(method="listTemplatePermissions") +@Implementation(method="listTemplatePermissions", description="List template visibility and all accounts that have permissions to view this template.") public class ListTemplateOrIsoPermissionsCmd extends BaseListCmd { public Logger s_logger = getLogger(); protected String s_name = getResponseName(); diff --git a/server/src/com/cloud/api/commands/ListTemplatesCmd.java b/server/src/com/cloud/api/commands/ListTemplatesCmd.java index 181fdc89cc3..8c56a45eb24 100644 --- a/server/src/com/cloud/api/commands/ListTemplatesCmd.java +++ b/server/src/com/cloud/api/commands/ListTemplatesCmd.java @@ -41,7 +41,7 @@ import com.cloud.storage.template.TemplateConstants; import com.cloud.user.Account; import com.cloud.user.UserContext; -@Implementation(method="listTemplates") +@Implementation(method="listTemplates", description="List all public, private, and privileged templates.") public class ListTemplatesCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListTemplatesCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ListUsersCmd.java b/server/src/com/cloud/api/commands/ListUsersCmd.java index c28a4696267..89787faf229 100644 --- a/server/src/com/cloud/api/commands/ListUsersCmd.java +++ b/server/src/com/cloud/api/commands/ListUsersCmd.java @@ -31,7 +31,7 @@ import com.cloud.api.response.ListResponse; import com.cloud.api.response.UserResponse; import com.cloud.user.UserAccountVO; -@Implementation(method="searchForUsers") +@Implementation(method="searchForUsers", description="Lists user accounts") public class ListUsersCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListUsersCmd.class.getName()); @@ -41,22 +41,22 @@ public class ListUsersCmd extends BaseListCmd { //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="account", type=CommandType.STRING) + @Parameter(name="account", type=CommandType.STRING, description="List user by account. Must be used with the domainId parameter.") private String accountName; - @Parameter(name="accounttype", type=CommandType.LONG) + @Parameter(name="accounttype", type=CommandType.LONG, description="List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.") private Long accountType; - @Parameter(name="domainid", type=CommandType.LONG) + @Parameter(name="domainid", type=CommandType.LONG, description="List all users in a domain. If used with the account parameter, lists an account in a specific domain.") private Long domainId; - @Parameter(name="id", type=CommandType.LONG) + @Parameter(name="id", type=CommandType.LONG, description="List user by ID.") private Long id; - @Parameter(name="state", type=CommandType.STRING) + @Parameter(name="state", type=CommandType.STRING, description="List users by state of the user account.") private String state; - @Parameter(name="username", type=CommandType.STRING) + @Parameter(name="username", type=CommandType.STRING, description="List user by the username") private String username; ///////////////////////////////////////////////////// diff --git a/server/src/com/cloud/api/commands/ListVMsCmd.java b/server/src/com/cloud/api/commands/ListVMsCmd.java index e9a2004b8af..6831901dca0 100644 --- a/server/src/com/cloud/api/commands/ListVMsCmd.java +++ b/server/src/com/cloud/api/commands/ListVMsCmd.java @@ -38,7 +38,7 @@ import com.cloud.vm.InstanceGroupVO; import com.cloud.vm.UserVmVO; import com.cloud.vm.VmStats; -@Implementation(method="searchForUserVMs") +@Implementation(method="searchForUserVMs", description="List the virtual machines owned by the account.") public class ListVMsCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListVMsCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ListVlanIpRangesCmd.java b/server/src/com/cloud/api/commands/ListVlanIpRangesCmd.java index 44e5120ef02..f0971c74718 100644 --- a/server/src/com/cloud/api/commands/ListVlanIpRangesCmd.java +++ b/server/src/com/cloud/api/commands/ListVlanIpRangesCmd.java @@ -33,7 +33,7 @@ import com.cloud.dc.Vlan.VlanType; import com.cloud.dc.VlanVO; import com.cloud.user.Account; -@Implementation(method="searchForVlans") +@Implementation(method="searchForVlans", description="Lists all VLAN IP ranges.") public class ListVlanIpRangesCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListVlanIpRangesCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ListVolumesCmd.java b/server/src/com/cloud/api/commands/ListVolumesCmd.java index 7394a135d5e..289fb3372c1 100755 --- a/server/src/com/cloud/api/commands/ListVolumesCmd.java +++ b/server/src/com/cloud/api/commands/ListVolumesCmd.java @@ -37,7 +37,7 @@ import com.cloud.storage.VolumeVO; import com.cloud.user.Account; import com.cloud.vm.VMInstanceVO; -@Implementation(method="searchForVolumes") +@Implementation(method="searchForVolumes", description="Lists all volumes.") public class ListVolumesCmd extends BaseListCmd { public static final Logger s_logger = Logger.getLogger(ListVolumesCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/LockAccountCmd.java b/server/src/com/cloud/api/commands/LockAccountCmd.java index 0f9573c4b8d..fc88cd1e8bd 100644 --- a/server/src/com/cloud/api/commands/LockAccountCmd.java +++ b/server/src/com/cloud/api/commands/LockAccountCmd.java @@ -25,7 +25,7 @@ import com.cloud.api.Implementation; import com.cloud.api.Parameter; import com.cloud.api.response.SuccessResponse; -@Implementation(method="lockAccount", manager=Manager.ManagementServer) +@Implementation(method="lockAccount", manager=Manager.ManagementServer, description="Locks an account") public class LockAccountCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(LockAccountCmd.class.getName()); @@ -35,10 +35,10 @@ public class LockAccountCmd extends BaseCmd { //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="account", type=CommandType.STRING, required=true) + @Parameter(name="account", type=CommandType.STRING, required=true, description="Locks the specified account.") private String accountName; - @Parameter(name="domainid", type=CommandType.LONG, required=true) + @Parameter(name="domainid", type=CommandType.LONG, required=true, description="Locks the specified account on this domain.") private Long domainId; ///////////////////////////////////////////////////// diff --git a/server/src/com/cloud/api/commands/LockUserCmd.java b/server/src/com/cloud/api/commands/LockUserCmd.java index 8c2c097a512..9bd5b4ef65b 100644 --- a/server/src/com/cloud/api/commands/LockUserCmd.java +++ b/server/src/com/cloud/api/commands/LockUserCmd.java @@ -25,7 +25,7 @@ import com.cloud.api.Implementation; import com.cloud.api.Parameter; import com.cloud.api.response.SuccessResponse; -@Implementation(method="lockUser", manager=Manager.ManagementServer) +@Implementation(method="lockUser", manager=Manager.ManagementServer, description="Locks a user account") public class LockUserCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(LockUserCmd.class.getName()); @@ -35,7 +35,7 @@ public class LockUserCmd extends BaseCmd { //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="id", type=CommandType.LONG, required=true) + @Parameter(name="id", type=CommandType.LONG, required=true, description="Locks user by user ID.") private Long id; ///////////////////////////////////////////////////// diff --git a/server/src/com/cloud/api/commands/PrepareForMaintenanceCmd.java b/server/src/com/cloud/api/commands/PrepareForMaintenanceCmd.java index c5a0e025612..c05be6a3974 100644 --- a/server/src/com/cloud/api/commands/PrepareForMaintenanceCmd.java +++ b/server/src/com/cloud/api/commands/PrepareForMaintenanceCmd.java @@ -28,7 +28,7 @@ import com.cloud.event.EventTypes; import com.cloud.user.Account; import com.cloud.user.UserContext; -@Implementation(method="maintain", manager=Manager.AgentManager) +@Implementation(method="maintain", manager=Manager.AgentManager, description="Prepares a host for maintenance.") public class PrepareForMaintenanceCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(PrepareForMaintenanceCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/QueryAsyncJobResultCmd.java b/server/src/com/cloud/api/commands/QueryAsyncJobResultCmd.java index 5c60a18639d..0091896273e 100644 --- a/server/src/com/cloud/api/commands/QueryAsyncJobResultCmd.java +++ b/server/src/com/cloud/api/commands/QueryAsyncJobResultCmd.java @@ -30,7 +30,7 @@ import com.cloud.api.response.AsyncJobResponse; import com.cloud.async.AsyncJobResult; import com.cloud.serializer.SerializerHelper; -@Implementation(method="queryAsyncJobResult") +@Implementation(method="queryAsyncJobResult", description="Retrieves the current status of asynchronous job.") public class QueryAsyncJobResultCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(QueryAsyncJobResultCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/RebootRouterCmd.java b/server/src/com/cloud/api/commands/RebootRouterCmd.java index 00e9b713889..90df17b5a4d 100644 --- a/server/src/com/cloud/api/commands/RebootRouterCmd.java +++ b/server/src/com/cloud/api/commands/RebootRouterCmd.java @@ -32,7 +32,7 @@ import com.cloud.event.EventTypes; import com.cloud.user.Account; import com.cloud.vm.DomainRouterVO; -@Implementation(method="rebootRouter", manager=Manager.NetworkManager) +@Implementation(method="rebootRouter", manager=Manager.NetworkManager, description="Starts a router.") public class RebootRouterCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(RebootRouterCmd.class.getName()); private static final String s_name = "rebootrouterresponse"; diff --git a/server/src/com/cloud/api/commands/RebootSystemVmCmd.java b/server/src/com/cloud/api/commands/RebootSystemVmCmd.java index 8c6edfe0e77..265b23c8da6 100644 --- a/server/src/com/cloud/api/commands/RebootSystemVmCmd.java +++ b/server/src/com/cloud/api/commands/RebootSystemVmCmd.java @@ -29,7 +29,7 @@ import com.cloud.event.EventTypes; import com.cloud.user.Account; import com.cloud.user.UserContext; -@Implementation(method="rebootSystemVM", manager=Manager.ManagementServer) +@Implementation(method="rebootSystemVM", manager=Manager.ManagementServer, description="Reboots a system VM.") public class RebootSystemVmCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(RebootSystemVmCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/RebootVMCmd.java b/server/src/com/cloud/api/commands/RebootVMCmd.java index aa4660bd88c..9633c5eaf95 100644 --- a/server/src/com/cloud/api/commands/RebootVMCmd.java +++ b/server/src/com/cloud/api/commands/RebootVMCmd.java @@ -29,7 +29,7 @@ import com.cloud.event.EventTypes; import com.cloud.user.Account; import com.cloud.uservm.UserVm; -@Implementation(method="rebootVirtualMachine", manager=Manager.UserVmManager) +@Implementation(method="rebootVirtualMachine", manager=Manager.UserVmManager, description="Reboots a virtual machine.") public class RebootVMCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(RebootVMCmd.class.getName()); private static final String s_name = "rebootvirtualmachineresponse"; diff --git a/server/src/com/cloud/api/commands/ReconnectHostCmd.java b/server/src/com/cloud/api/commands/ReconnectHostCmd.java index 5ccd89c61f0..690e1ac7b3d 100644 --- a/server/src/com/cloud/api/commands/ReconnectHostCmd.java +++ b/server/src/com/cloud/api/commands/ReconnectHostCmd.java @@ -44,7 +44,7 @@ import com.cloud.user.Account; import com.cloud.user.UserContext; import com.cloud.vm.UserVmVO; -@Implementation(method="reconnectHost", manager=Manager.AgentManager) +@Implementation(method="reconnectHost", manager=Manager.AgentManager, description="Reconnects a host.") public class ReconnectHostCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(ReconnectHostCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/RecoverVMCmd.java b/server/src/com/cloud/api/commands/RecoverVMCmd.java index f10288eb6d0..80e02066094 100644 --- a/server/src/com/cloud/api/commands/RecoverVMCmd.java +++ b/server/src/com/cloud/api/commands/RecoverVMCmd.java @@ -26,7 +26,7 @@ import com.cloud.api.Implementation; import com.cloud.api.Parameter; import com.cloud.api.response.SuccessResponse; -@Implementation(method="recoverVirtualMachine", manager=Manager.UserVmManager) +@Implementation(method="recoverVirtualMachine", manager=Manager.UserVmManager, description="Recovers a virtual machine.") public class RecoverVMCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(RecoverVMCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/RegisterCmd.java b/server/src/com/cloud/api/commands/RegisterCmd.java index 0c2bdf2414a..1b2a25e3c04 100644 --- a/server/src/com/cloud/api/commands/RegisterCmd.java +++ b/server/src/com/cloud/api/commands/RegisterCmd.java @@ -26,7 +26,7 @@ import com.cloud.api.Implementation; import com.cloud.api.Parameter; import com.cloud.api.response.RegisterResponse; -@Implementation(method="createApiKeyAndSecretKey", manager=Manager.ManagementServer) +@Implementation(method="createApiKeyAndSecretKey", manager=Manager.ManagementServer, description="This command allows a user to register for the developer API, returning a secret key and an API key. This request is made through the integration API port, so it is a privileged command and must be made on behalf of a user. It is up to the implementer just how the username and password are entered, and then how that translates to an integration API request. Both secret key and API key should be returned to the user") public class RegisterCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(RegisterCmd.class.getName()); @@ -36,7 +36,7 @@ public class RegisterCmd extends BaseCmd { //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="id", type=CommandType.LONG, required=true) + @Parameter(name="id", type=CommandType.LONG, required=true, description="User id") private Long id; ///////////////////////////////////////////////////// diff --git a/server/src/com/cloud/api/commands/RegisterIsoCmd.java b/server/src/com/cloud/api/commands/RegisterIsoCmd.java index 97aa763bd1d..e3a78973d36 100644 --- a/server/src/com/cloud/api/commands/RegisterIsoCmd.java +++ b/server/src/com/cloud/api/commands/RegisterIsoCmd.java @@ -35,7 +35,7 @@ import com.cloud.storage.VMTemplateStorageResourceAssoc.Status; import com.cloud.storage.VMTemplateVO; import com.cloud.user.Account; -@Implementation(method="registerIso", manager=Manager.TemplateManager) +@Implementation(method="registerIso", manager=Manager.TemplateManager, description="Registers an existing ISO into the Cloud.com Cloud.") public class RegisterIsoCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(RegisterIsoCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/RegisterTemplateCmd.java b/server/src/com/cloud/api/commands/RegisterTemplateCmd.java index 48bea1ff0a5..61487fdd593 100644 --- a/server/src/com/cloud/api/commands/RegisterTemplateCmd.java +++ b/server/src/com/cloud/api/commands/RegisterTemplateCmd.java @@ -36,7 +36,7 @@ import com.cloud.storage.VMTemplateStorageResourceAssoc.Status; import com.cloud.storage.VMTemplateVO; import com.cloud.user.Account; -@Implementation(method="registerTemplate", manager=Manager.TemplateManager) +@Implementation(method="registerTemplate", manager=Manager.TemplateManager, description="Registers an existing template into the Cloud.com cloud. ") public class RegisterTemplateCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(RegisterTemplateCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/RemoveFromLoadBalancerRuleCmd.java b/server/src/com/cloud/api/commands/RemoveFromLoadBalancerRuleCmd.java index a5745a19110..848174416f7 100644 --- a/server/src/com/cloud/api/commands/RemoveFromLoadBalancerRuleCmd.java +++ b/server/src/com/cloud/api/commands/RemoveFromLoadBalancerRuleCmd.java @@ -33,7 +33,7 @@ import com.cloud.network.LoadBalancerVO; import com.cloud.user.Account; import com.cloud.utils.StringUtils; -@Implementation(method="removeFromLoadBalancer", manager=Manager.NetworkManager) +@Implementation(method="removeFromLoadBalancer", manager=Manager.NetworkManager, description="Removes a virtual machine or a list of virtual machines from a load balancer rule.") public class RemoveFromLoadBalancerRuleCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(RemoveFromLoadBalancerRuleCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/RemovePortForwardingServiceCmd.java b/server/src/com/cloud/api/commands/RemovePortForwardingServiceCmd.java index 7fd40f88ef6..5fb91c44959 100644 --- a/server/src/com/cloud/api/commands/RemovePortForwardingServiceCmd.java +++ b/server/src/com/cloud/api/commands/RemovePortForwardingServiceCmd.java @@ -29,7 +29,7 @@ import com.cloud.event.EventTypes; import com.cloud.network.SecurityGroupVO; import com.cloud.user.Account; -@Implementation(method="removeSecurityGroup", manager=Manager.ManagementServer) +@Implementation(method="removeSecurityGroup", manager=Manager.ManagementServer, description="Removes a port forwarding service from a virtual machine") public class RemovePortForwardingServiceCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(RemovePortForwardingServiceCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/ResetVMPasswordCmd.java b/server/src/com/cloud/api/commands/ResetVMPasswordCmd.java index 8cdaf2fdfdd..3886df07699 100644 --- a/server/src/com/cloud/api/commands/ResetVMPasswordCmd.java +++ b/server/src/com/cloud/api/commands/ResetVMPasswordCmd.java @@ -35,7 +35,9 @@ import com.cloud.user.UserContext; import com.cloud.uservm.UserVm; import com.cloud.vm.InstanceGroupVO; -@Implementation(method="resetVMPassword", manager=Manager.UserVmManager) +@Implementation(method="resetVMPassword", manager=Manager.UserVmManager, description="Resets the password for virtual machine. " + + "The virtual machine must be in a \"Stopped\" state and the template must already " + + "support this feature for this command to take effect. [async]") public class ResetVMPasswordCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(ResetVMPasswordCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/StartRouterCmd.java b/server/src/com/cloud/api/commands/StartRouterCmd.java index a93e7067c21..6c2bf2aa3ab 100644 --- a/server/src/com/cloud/api/commands/StartRouterCmd.java +++ b/server/src/com/cloud/api/commands/StartRouterCmd.java @@ -32,7 +32,7 @@ import com.cloud.uservm.UserVm; import com.cloud.vm.DomainRouterVO; -@Implementation(method="startRouter", manager=Manager.NetworkManager) +@Implementation(method="startRouter", manager=Manager.NetworkManager, description="Starts a router.") public class StartRouterCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(StartRouterCmd.class.getName()); private static final String s_name = "startrouterresponse"; diff --git a/server/src/com/cloud/api/commands/StartSystemVMCmd.java b/server/src/com/cloud/api/commands/StartSystemVMCmd.java index 6e38ba59424..7eaeacbdff1 100644 --- a/server/src/com/cloud/api/commands/StartSystemVMCmd.java +++ b/server/src/com/cloud/api/commands/StartSystemVMCmd.java @@ -33,7 +33,7 @@ import com.cloud.vm.ConsoleProxyVO; import com.cloud.vm.SecondaryStorageVmVO; import com.cloud.vm.VMInstanceVO; -@Implementation(method="startSystemVM", manager=Manager.ManagementServer) +@Implementation(method="startSystemVM", manager=Manager.ManagementServer, description="Starts a system virtual machine.") public class StartSystemVMCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(StartSystemVMCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/StartVMCmd.java b/server/src/com/cloud/api/commands/StartVMCmd.java index 58628c046aa..fa98d9f6b8f 100644 --- a/server/src/com/cloud/api/commands/StartVMCmd.java +++ b/server/src/com/cloud/api/commands/StartVMCmd.java @@ -34,7 +34,7 @@ import com.cloud.user.Account; import com.cloud.uservm.UserVm; import com.cloud.vm.InstanceGroupVO; -@Implementation(method="startVirtualMachine", manager=Manager.UserVmManager) +@Implementation(method="startVirtualMachine", manager=Manager.UserVmManager, description="Starts a virtual machine.") public class StartVMCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(StartVMCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/StopRouterCmd.java b/server/src/com/cloud/api/commands/StopRouterCmd.java index 0b68a0029c2..16d859a4a4a 100644 --- a/server/src/com/cloud/api/commands/StopRouterCmd.java +++ b/server/src/com/cloud/api/commands/StopRouterCmd.java @@ -32,7 +32,7 @@ import com.cloud.uservm.UserVm; import com.cloud.vm.DomainRouterVO; -@Implementation(method="stopRouter", manager=Manager.NetworkManager) +@Implementation(method="stopRouter", manager=Manager.NetworkManager, description="Stops a router.") public class StopRouterCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(StopRouterCmd.class.getName()); private static final String s_name = "stoprouterresponse"; diff --git a/server/src/com/cloud/api/commands/StopSystemVmCmd.java b/server/src/com/cloud/api/commands/StopSystemVmCmd.java index 6f7e66271ef..fd34f24601f 100644 --- a/server/src/com/cloud/api/commands/StopSystemVmCmd.java +++ b/server/src/com/cloud/api/commands/StopSystemVmCmd.java @@ -33,7 +33,7 @@ import com.cloud.vm.ConsoleProxyVO; import com.cloud.vm.SecondaryStorageVmVO; import com.cloud.vm.VMInstanceVO; -@Implementation(method="stopSystemVM", manager=Manager.ManagementServer) +@Implementation(method="stopSystemVM", manager=Manager.ManagementServer, description="Stops a system VM.") public class StopSystemVmCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(StopSystemVmCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/StopVMCmd.java b/server/src/com/cloud/api/commands/StopVMCmd.java index 0ac7c6b7d98..644b0fdefa9 100644 --- a/server/src/com/cloud/api/commands/StopVMCmd.java +++ b/server/src/com/cloud/api/commands/StopVMCmd.java @@ -29,7 +29,7 @@ import com.cloud.event.EventTypes; import com.cloud.user.Account; import com.cloud.uservm.UserVm; -@Implementation(method="stopVirtualMachine", manager=Manager.UserVmManager) +@Implementation(method="stopVirtualMachine", manager=Manager.UserVmManager, description="Stops a virtual machine.") public class StopVMCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(StopVMCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/UpdateAccountCmd.java b/server/src/com/cloud/api/commands/UpdateAccountCmd.java index 83f4dac21eb..a3e6998f52d 100644 --- a/server/src/com/cloud/api/commands/UpdateAccountCmd.java +++ b/server/src/com/cloud/api/commands/UpdateAccountCmd.java @@ -26,7 +26,7 @@ import com.cloud.api.Parameter; import com.cloud.api.ServerApiException; import com.cloud.api.response.SuccessResponse; -@Implementation(method="updateAccount", manager=Manager.ManagementServer) +@Implementation(method="updateAccount", manager=Manager.ManagementServer, description="Updates account information for the authenticated user") public class UpdateAccountCmd extends BaseCmd{ public static final Logger s_logger = Logger.getLogger(UpdateAccountCmd.class.getName()); private static final String s_name = "updateaccountresponse"; @@ -35,13 +35,13 @@ public class UpdateAccountCmd extends BaseCmd{ //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="account", type=CommandType.STRING, required=true) + @Parameter(name="account", type=CommandType.STRING, required=true, description="the current account name") private String accountName; - @Parameter(name="domainid", type=CommandType.LONG, required=true) + @Parameter(name="domainid", type=CommandType.LONG, required=true, description="the ID of the domain where the account exists") private Long domainId; - @Parameter(name="newname", type=CommandType.STRING, required=true) + @Parameter(name="newname", type=CommandType.STRING, required=true, description="new name for the account") private String newName; ///////////////////////////////////////////////////// diff --git a/server/src/com/cloud/api/commands/UpdateCfgCmd.java b/server/src/com/cloud/api/commands/UpdateCfgCmd.java index 68534392a99..f244c457119 100644 --- a/server/src/com/cloud/api/commands/UpdateCfgCmd.java +++ b/server/src/com/cloud/api/commands/UpdateCfgCmd.java @@ -27,7 +27,7 @@ import com.cloud.api.Parameter; import com.cloud.api.ServerApiException; import com.cloud.api.response.SuccessResponse; -@Implementation(method="updateConfiguration", manager=Manager.ConfigManager) +@Implementation(method="updateConfiguration", manager=Manager.ConfigManager, description="Updates a configuration.") public class UpdateCfgCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(UpdateCfgCmd.class.getName()); private static final String s_name = "updateconfigurationresponse"; diff --git a/server/src/com/cloud/api/commands/UpdateDiskOfferingCmd.java b/server/src/com/cloud/api/commands/UpdateDiskOfferingCmd.java index 1b7db788d3a..306395e04cb 100644 --- a/server/src/com/cloud/api/commands/UpdateDiskOfferingCmd.java +++ b/server/src/com/cloud/api/commands/UpdateDiskOfferingCmd.java @@ -28,7 +28,7 @@ import com.cloud.api.ServerApiException; import com.cloud.api.response.DiskOfferingResponse; import com.cloud.storage.DiskOfferingVO; -@Implementation(method="updateDiskOffering", manager=Manager.ConfigManager) +@Implementation(method="updateDiskOffering", manager=Manager.ConfigManager, description="Updates a disk offering.") public class UpdateDiskOfferingCmd extends BaseCmd{ public static final Logger s_logger = Logger.getLogger(UpdateDiskOfferingCmd.class.getName()); private static final String s_name = "updatediskofferingresponse"; diff --git a/server/src/com/cloud/api/commands/UpdateDomainCmd.java b/server/src/com/cloud/api/commands/UpdateDomainCmd.java index 235229641d5..21cdf7b125c 100644 --- a/server/src/com/cloud/api/commands/UpdateDomainCmd.java +++ b/server/src/com/cloud/api/commands/UpdateDomainCmd.java @@ -26,7 +26,7 @@ import com.cloud.api.Parameter; import com.cloud.api.ServerApiException; import com.cloud.api.response.SuccessResponse; -@Implementation(method="updateDomain", manager=Manager.ManagementServer) +@Implementation(method="updateDomain", manager=Manager.ManagementServer, description="Updates a domain with a new name") public class UpdateDomainCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(UpdateDomainCmd.class.getName()); private static final String s_name = "updatedomainresponse"; @@ -35,10 +35,10 @@ public class UpdateDomainCmd extends BaseCmd { //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="id", type=CommandType.LONG, required=true) + @Parameter(name="id", type=CommandType.LONG, required=true, description="ID of domain to update") private Long id; - @Parameter(name="name", type=CommandType.STRING) + @Parameter(name="name", type=CommandType.STRING, description="updates domain with this name") private String domainName; ///////////////////////////////////////////////////// diff --git a/server/src/com/cloud/api/commands/UpdateHostCmd.java b/server/src/com/cloud/api/commands/UpdateHostCmd.java index 6948900ffce..31aea6efd94 100644 --- a/server/src/com/cloud/api/commands/UpdateHostCmd.java +++ b/server/src/com/cloud/api/commands/UpdateHostCmd.java @@ -42,7 +42,7 @@ import com.cloud.offering.ServiceOffering; import com.cloud.storage.GuestOSCategoryVO; import com.cloud.vm.UserVmVO; -@Implementation(method="updateHost", manager=Manager.AgentManager) +@Implementation(method="updateHost", manager=Manager.AgentManager, description="Updates a host.") public class UpdateHostCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(UpdateHostCmd.class.getName()); private static final String s_name = "updatehostresponse"; diff --git a/server/src/com/cloud/api/commands/UpdateIPForwardingRuleCmd.java b/server/src/com/cloud/api/commands/UpdateIPForwardingRuleCmd.java index e56274d77a6..7f7b10ef76d 100644 --- a/server/src/com/cloud/api/commands/UpdateIPForwardingRuleCmd.java +++ b/server/src/com/cloud/api/commands/UpdateIPForwardingRuleCmd.java @@ -14,7 +14,7 @@ import com.cloud.network.IPAddressVO; import com.cloud.user.Account; import com.cloud.uservm.UserVm; -@Implementation(method="updatePortForwardingRule", manager=Manager.ManagementServer) +@Implementation(method="updatePortForwardingRule", manager=Manager.ManagementServer, description="Updates a port forwarding rule. Only the private port and the virtual machine can be updated.") public class UpdateIPForwardingRuleCmd extends BaseAsyncCmd { public static final Logger s_logger = Logger.getLogger(UpdateIPForwardingRuleCmd.class.getName()); private static final String s_name = "updateportforwardingruleresponse"; @@ -23,22 +23,22 @@ public class UpdateIPForwardingRuleCmd extends BaseAsyncCmd { //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="privateip", type=CommandType.STRING) + @Parameter(name="privateip", type=CommandType.STRING, description="the private IP address of the port forwarding rule") private String privateIp; - @Parameter(name="privateport", type=CommandType.STRING, required=true) + @Parameter(name="privateport", type=CommandType.STRING, required=true, description="the private port of the port forwarding rule") private String privatePort; - @Parameter(name="protocol", type=CommandType.STRING, required=true) + @Parameter(name="protocol", type=CommandType.STRING, required=true, description="the protocol for the port fowarding rule. Valid values are TCP or UDP.") private String protocol; - @Parameter(name="publicip", type=CommandType.STRING, required=true) + @Parameter(name="publicip", type=CommandType.STRING, required=true, description="the public IP address of the port forwarding rule") private String publicIp; - @Parameter(name="publicport", type=CommandType.STRING, required=true) + @Parameter(name="publicport", type=CommandType.STRING, required=true, description="the public port of the port forwarding rule") private String publicPort; - @Parameter(name="virtualmachineid", type=CommandType.LONG) + @Parameter(name="virtualmachineid", type=CommandType.LONG, description="the ID of the virtual machine for the port forwarding rule") private Long virtualMachineId; ///////////////////////////////////////////////////// diff --git a/server/src/com/cloud/api/commands/UpdateIsoCmd.java b/server/src/com/cloud/api/commands/UpdateIsoCmd.java index 1abb1632e53..42143a51d7f 100755 --- a/server/src/com/cloud/api/commands/UpdateIsoCmd.java +++ b/server/src/com/cloud/api/commands/UpdateIsoCmd.java @@ -26,7 +26,7 @@ import com.cloud.api.ServerApiException; import com.cloud.api.response.TemplateResponse; import com.cloud.storage.VMTemplateVO; -@Implementation(method="updateTemplate", manager=Manager.ManagementServer) +@Implementation(method="updateTemplate", manager=Manager.ManagementServer, description="Updates an ISO file.") public class UpdateIsoCmd extends UpdateTemplateOrIsoCmd { public static final Logger s_logger = Logger.getLogger(UpdateIsoCmd.class.getName()); private static final String s_name = "updateisoresponse"; diff --git a/server/src/com/cloud/api/commands/UpdatePodCmd.java b/server/src/com/cloud/api/commands/UpdatePodCmd.java index 70381fe0866..fc46b07e675 100644 --- a/server/src/com/cloud/api/commands/UpdatePodCmd.java +++ b/server/src/com/cloud/api/commands/UpdatePodCmd.java @@ -26,7 +26,7 @@ import com.cloud.api.Implementation; import com.cloud.api.Parameter; import com.cloud.api.response.SuccessResponse; -@Implementation(method="editPod", manager=Manager.ConfigManager) +@Implementation(method="editPod", manager=Manager.ConfigManager, description="Updates a Pod.") public class UpdatePodCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(UpdatePodCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/UpdateResourceLimitCmd.java b/server/src/com/cloud/api/commands/UpdateResourceLimitCmd.java index d6dbed8edff..b2b99271d63 100644 --- a/server/src/com/cloud/api/commands/UpdateResourceLimitCmd.java +++ b/server/src/com/cloud/api/commands/UpdateResourceLimitCmd.java @@ -29,7 +29,7 @@ import com.cloud.api.response.ResourceLimitResponse; import com.cloud.configuration.ResourceLimitVO; import com.cloud.user.Account; -@Implementation(method="updateResourceLimit", manager=Manager.AccountManager) +@Implementation(method="updateResourceLimit", manager=Manager.AccountManager, description="Updates resource limits for an account or domain.") public class UpdateResourceLimitCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(UpdateResourceLimitCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/UpdateServiceOfferingCmd.java b/server/src/com/cloud/api/commands/UpdateServiceOfferingCmd.java index adc0f4a11fe..8fd03d926b0 100644 --- a/server/src/com/cloud/api/commands/UpdateServiceOfferingCmd.java +++ b/server/src/com/cloud/api/commands/UpdateServiceOfferingCmd.java @@ -27,7 +27,7 @@ import com.cloud.api.response.ServiceOfferingResponse; import com.cloud.offering.NetworkOffering.GuestIpType; import com.cloud.service.ServiceOfferingVO; -@Implementation(method="updateServiceOffering", manager=Manager.ConfigManager) +@Implementation(method="updateServiceOffering", manager=Manager.ConfigManager, description="Updates a service offering.") public class UpdateServiceOfferingCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(UpdateServiceOfferingCmd.class.getName()); private static final String s_name = "updateserviceofferingresponse"; diff --git a/server/src/com/cloud/api/commands/UpdateStoragePoolCmd.java b/server/src/com/cloud/api/commands/UpdateStoragePoolCmd.java index 3b81951e84d..90f6ec0f3d0 100644 --- a/server/src/com/cloud/api/commands/UpdateStoragePoolCmd.java +++ b/server/src/com/cloud/api/commands/UpdateStoragePoolCmd.java @@ -30,7 +30,7 @@ import com.cloud.dc.ClusterVO; import com.cloud.storage.StoragePoolVO; import com.cloud.storage.StorageStats; -@Implementation(method="updateStoragePool", manager=Manager.StorageManager) +@Implementation(method="updateStoragePool", manager=Manager.StorageManager, description="Updates a storage pool.") public class UpdateStoragePoolCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(UpdateStoragePoolCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/UpdateTemplateCmd.java b/server/src/com/cloud/api/commands/UpdateTemplateCmd.java index e3dca860794..1a9db9ff2a9 100644 --- a/server/src/com/cloud/api/commands/UpdateTemplateCmd.java +++ b/server/src/com/cloud/api/commands/UpdateTemplateCmd.java @@ -26,7 +26,7 @@ import com.cloud.api.ServerApiException; import com.cloud.api.response.TemplateResponse; import com.cloud.storage.VMTemplateVO; -@Implementation(method="updateTemplate", manager=Manager.ManagementServer) +@Implementation(method="updateTemplate", manager=Manager.ManagementServer, description="Updates attributes of a template.") public class UpdateTemplateCmd extends UpdateTemplateOrIsoCmd { public static final Logger s_logger = Logger.getLogger(UpdateTemplateCmd.class.getName()); private static final String s_name = "updatetemplateresponse"; diff --git a/server/src/com/cloud/api/commands/UpdateTemplatePermissionsCmd.java b/server/src/com/cloud/api/commands/UpdateTemplatePermissionsCmd.java index bbce3a4bfa0..ef1789f4f52 100644 --- a/server/src/com/cloud/api/commands/UpdateTemplatePermissionsCmd.java +++ b/server/src/com/cloud/api/commands/UpdateTemplatePermissionsCmd.java @@ -23,7 +23,11 @@ import org.apache.log4j.Logger; import com.cloud.api.BaseCmd.Manager; import com.cloud.api.Implementation; -@Implementation(method="updateTemplatePermissions", manager=Manager.ManagementServer) +@Implementation(method="updateTemplatePermissions", manager=Manager.ManagementServer, 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 priviledged template is a private template with account permissions added. " + + "Only accounts specified under the template permissions are visible to them.") public class UpdateTemplatePermissionsCmd extends UpdateTemplateOrIsoPermissionsCmd { protected String getResponseName() { return "updatetemplatepermissionsresponse"; diff --git a/server/src/com/cloud/api/commands/UpdateUserCmd.java b/server/src/com/cloud/api/commands/UpdateUserCmd.java index 4890a8ccbd8..3f4592f86a4 100644 --- a/server/src/com/cloud/api/commands/UpdateUserCmd.java +++ b/server/src/com/cloud/api/commands/UpdateUserCmd.java @@ -24,10 +24,9 @@ import com.cloud.api.BaseCmd; import com.cloud.api.BaseCmd.Manager; import com.cloud.api.Implementation; import com.cloud.api.Parameter; -import com.cloud.api.ResponseObject; import com.cloud.api.response.SuccessResponse; -@Implementation(method="updateUser", manager=Manager.ManagementServer) +@Implementation(method="updateUser", manager=Manager.ManagementServer, description="Updates a user account") public class UpdateUserCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(UpdateUserCmd.class.getName()); @@ -37,31 +36,31 @@ public class UpdateUserCmd extends BaseCmd { //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name="apikey", type=CommandType.STRING) + @Parameter(name="apikey", type=CommandType.STRING, description="The API key for the user.") private String apiKey; - @Parameter(name="email", type=CommandType.STRING) + @Parameter(name="email", type=CommandType.STRING, description="email") private String email; - @Parameter(name="firstname", type=CommandType.STRING) + @Parameter(name="firstname", type=CommandType.STRING, description="first name") private String firstname; - @Parameter(name="id", type=CommandType.LONG, required=true) + @Parameter(name="id", type=CommandType.LONG, required=true, description="User id") private Long id; - @Parameter(name="lastname", type=CommandType.STRING) + @Parameter(name="lastname", type=CommandType.STRING, description="last name") private String lastname; - @Parameter(name="password", type=CommandType.STRING) + @Parameter(name="password", type=CommandType.STRING, description="Hashed password (default is MD5). If you wish to use any other hasing algorithm, you would need to write a custom authentication adapter") private String password; - @Parameter(name="secretkey", type=CommandType.STRING) + @Parameter(name="secretkey", type=CommandType.STRING, description="The secret key for the user.") private String secretKey; - @Parameter(name="timezone", type=CommandType.STRING) + @Parameter(name="timezone", type=CommandType.STRING, description="Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.") private String timezone; - @Parameter(name="username", type=CommandType.STRING) + @Parameter(name="username", type=CommandType.STRING, description="Unique username") private String username; ///////////////////////////////////////////////////// diff --git a/server/src/com/cloud/api/commands/UpdateVMCmd.java b/server/src/com/cloud/api/commands/UpdateVMCmd.java index 858372ab60f..527dbda5cb2 100644 --- a/server/src/com/cloud/api/commands/UpdateVMCmd.java +++ b/server/src/com/cloud/api/commands/UpdateVMCmd.java @@ -25,7 +25,7 @@ import com.cloud.api.Implementation; import com.cloud.api.Parameter; import com.cloud.api.response.SuccessResponse; -@Implementation(method="updateVirtualMachine", manager=Manager.UserVmManager) +@Implementation(method="updateVirtualMachine", manager=Manager.UserVmManager, description="Updates parameters of a virtual machine.") public class UpdateVMCmd extends BaseCmd{ public static final Logger s_logger = Logger.getLogger(UpdateVMCmd.class.getName()); private static final String s_name = "updatevirtualmachineresponse"; diff --git a/server/src/com/cloud/api/commands/UpdateZoneCmd.java b/server/src/com/cloud/api/commands/UpdateZoneCmd.java index 4dd0e930cdf..ec3cdec46d9 100644 --- a/server/src/com/cloud/api/commands/UpdateZoneCmd.java +++ b/server/src/com/cloud/api/commands/UpdateZoneCmd.java @@ -28,7 +28,7 @@ import com.cloud.api.ServerApiException; import com.cloud.api.response.ZoneResponse; import com.cloud.dc.DataCenterVO; -@Implementation(method="updateZone", manager=Manager.ConfigManager) +@Implementation(method="updateZone", manager=Manager.ConfigManager, description="Updates a Zone.") public class UpdateZoneCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(UpdateZoneCmd.class.getName()); diff --git a/server/src/com/cloud/api/commands/UpgradeVMCmd.java b/server/src/com/cloud/api/commands/UpgradeVMCmd.java index afdff352de1..04658819ad4 100644 --- a/server/src/com/cloud/api/commands/UpgradeVMCmd.java +++ b/server/src/com/cloud/api/commands/UpgradeVMCmd.java @@ -33,7 +33,9 @@ import com.cloud.user.Account; import com.cloud.vm.UserVmVO; import com.cloud.vm.VmStats; -@Implementation(method="upgradeVirtualMachine", manager=Manager.UserVmManager) +@Implementation(method="upgradeVirtualMachine", manager=Manager.UserVmManager, description="Changes the service offering for a virtual machine. " + + "The virtual machine must be in a \"Stopped\" state for " + + "this command to take effect.") public class UpgradeVMCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(UpgradeVMCmd.class.getName()); private static final String s_name = "changeserviceforvirtualmachineresponse"; diff --git a/server/src/com/cloud/api/doc/ApiXmlDocWriter.java b/server/src/com/cloud/api/doc/ApiXmlDocWriter.java index e3e49a4143e..697354e8bf9 100644 --- a/server/src/com/cloud/api/doc/ApiXmlDocWriter.java +++ b/server/src/com/cloud/api/doc/ApiXmlDocWriter.java @@ -116,6 +116,8 @@ public class ApiXmlDocWriter { String commandDescription = impl.description(); if (commandDescription != null) apiCommand.setDescription(commandDescription); + else + s_logger.warn("Command " + apiCommand.getName() + " misses description"); //Get request parameters Field[] fields = clas.getDeclaredFields(); @@ -140,6 +142,9 @@ public class ApiXmlDocWriter { reqArg.setRequired(parameterAnnotation.required()); if (!parameterAnnotation.description().isEmpty()) reqArg.setDescription(parameterAnnotation.description()); + else + s_logger.warn("Description is missing for the parameter " + parameterAnnotation.name() + " of the command " + apiCommand.getName() ); + request.add(reqArg); } }