apache/cloudstack
1
0
Fork 0
mirror of https://github.com/apache/cloudstack.git synced 2025-10-26 08:42:29 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added descriptions for Api commands and corresponding requrest parameters

Browse Source
This commit is contained in:
alena 2010-10-07 14:45:08 -07:00
parent fbb5a109cc
commit e7b478f43d
129 changed files with 231 additions and 216 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
server/src/com/cloud/api/BaseListCmd.java
View File

@ -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

2
server/src/com/cloud/api/commands/AddHostCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/AddSecondaryStorageCmd.java
View File

@ -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";

2
server/src/com/cloud/api/commands/AssignPortForwardingServiceCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/AssignToLoadBalancerRuleCmd.java
View File

@ -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());

8
server/src/com/cloud/api/commands/AssociateIPAddrCmd.java
View File

@ -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;

2
server/src/com/cloud/api/commands/AttachIsoCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/AttachVolumeCmd.java
View File

@ -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";

2
server/src/com/cloud/api/commands/CancelMaintenanceCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/CopyIsoCmd.java
View File

@ -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";

2
server/src/com/cloud/api/commands/CopyTemplateCmd.java
View File

@ -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";

2
server/src/com/cloud/api/commands/CreateDiskOfferingCmd.java
View File

@ -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());

6
server/src/com/cloud/api/commands/CreateDomainCmd.java
View File

@ -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;

12
server/src/com/cloud/api/commands/CreateIPForwardingRuleCmd.java
View File

@ -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;

2
server/src/com/cloud/api/commands/CreateLoadBalancerRuleCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/CreatePodCmd.java
View File

@ -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());

10
server/src/com/cloud/api/commands/CreatePortForwardingServiceCmd.java
View File

@ -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;

2
server/src/com/cloud/api/commands/CreatePortForwardingServiceRuleCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/CreateServiceOfferingCmd.java
View File

@ -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";

2
server/src/com/cloud/api/commands/CreateSnapshotCmd.java
View File

@ -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";

2
server/src/com/cloud/api/commands/CreateSnapshotPolicyCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/CreateStoragePoolCmd.java
View File

@ -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());

4
server/src/com/cloud/api/commands/CreateTemplateCmd.java
View File

@ -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";

20
server/src/com/cloud/api/commands/CreateUserCmd.java
View File

@ -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;

2
server/src/com/cloud/api/commands/CreateVlanIpRangeCmd.java
View File

@ -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());

3
server/src/com/cloud/api/commands/CreateVolumeCmd.java
View File

@ -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";

2
server/src/com/cloud/api/commands/CreateZoneCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/DeleteDiskOfferingCmd.java
View File

@ -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";

4
server/src/com/cloud/api/commands/DeleteDomainCmd.java
View File

@ -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)

2
server/src/com/cloud/api/commands/DeleteHostCmd.java
View File

@ -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());

4
server/src/com/cloud/api/commands/DeleteIPForwardingRuleCmd.java
View File

@ -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;

2
server/src/com/cloud/api/commands/DeleteIsoCmd.java
View File

@ -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";

2
server/src/com/cloud/api/commands/DeleteLoadBalancerRuleCmd.java
View File

@ -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";

2
server/src/com/cloud/api/commands/DeletePodCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/DeletePoolCmd.java
View File

@ -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";

2
server/src/com/cloud/api/commands/DeletePortForwardingServiceCmd.java
View File

@ -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";

4
server/src/com/cloud/api/commands/DeletePortForwardingServiceRuleCmd.java
View File

@ -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;
/////////////////////////////////////////////////////

2
server/src/com/cloud/api/commands/DeleteServiceOfferingCmd.java
View File

@ -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";

2
server/src/com/cloud/api/commands/DeleteSnapshotCmd.java
View File

@ -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";

2
server/src/com/cloud/api/commands/DeleteSnapshotPoliciesCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/DeleteTemplateCmd.java
View File

@ -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";

4
server/src/com/cloud/api/commands/DeleteUserCmd.java
View File

@ -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;

2
server/src/com/cloud/api/commands/DeleteVlanIpRangeCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/DeleteVolumeCmd.java
View File

@ -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";

2
server/src/com/cloud/api/commands/DeleteZoneCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/DeployVMCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/DestroyVMCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/DetachIsoCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/DetachVolumeCmd.java
View File

@ -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";

6
server/src/com/cloud/api/commands/DisableAccountCmd.java
View File

@ -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;
/////////////////////////////////////////////////////

4
server/src/com/cloud/api/commands/DisableUserCmd.java
View File

@ -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;
/////////////////////////////////////////////////////

4
server/src/com/cloud/api/commands/DisassociateIPAddrCmd.java
View File

@ -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;
/////////////////////////////////////////////////////

6
server/src/com/cloud/api/commands/EnableAccountCmd.java
View File

@ -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;
/////////////////////////////////////////////////////

4
server/src/com/cloud/api/commands/EnableUserCmd.java
View File

@ -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;

2
server/src/com/cloud/api/commands/GetCloudIdentifierCmd.java
View File

@ -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";

14
server/src/com/cloud/api/commands/ListAccountsCmd.java
View File

@ -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;

2
server/src/com/cloud/api/commands/ListAlertsCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/ListAsyncJobsCmd.java
View File

@ -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";

2
server/src/com/cloud/api/commands/ListCapacityCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/ListCfgsByCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/ListClustersCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/ListDiskOfferingsCmd.java
View File

@ -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());

8
server/src/com/cloud/api/commands/ListDomainChildrenCmd.java
View File

@ -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;
/////////////////////////////////////////////////////

8
server/src/com/cloud/api/commands/ListDomainsCmd.java
View File

@ -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;
/////////////////////////////////////////////////////

2
server/src/com/cloud/api/commands/ListEventsCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/ListGuestOsCategoriesCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/ListGuestOsCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/ListHostsCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/ListIsosCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/ListLoadBalancerRuleInstancesCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/ListLoadBalancerRulesCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/ListPodsByCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/ListPortForwardingRulesCmd.java
View File

@ -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());

10
server/src/com/cloud/api/commands/ListPortForwardingServiceRulesCmd.java
View File

@ -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;
/////////////////////////////////////////////////////

2
server/src/com/cloud/api/commands/ListPortForwardingServicesByVmCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/ListPortForwardingServicesCmd.java
View File

@ -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());

16
server/src/com/cloud/api/commands/ListPublicIpAddressesCmd.java
View File

@ -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;
/////////////////////////////////////////////////////

2
server/src/com/cloud/api/commands/ListResourceLimitsCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/ListRoutersCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/ListServiceOfferingsCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/ListSnapshotPoliciesCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/ListSnapshotsCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/ListStoragePoolsCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/ListSystemVMsCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/ListTemplateOrIsoPermissionsCmd.java
View File

@ -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();

2
server/src/com/cloud/api/commands/ListTemplatesCmd.java
View File

@ -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());

14
server/src/com/cloud/api/commands/ListUsersCmd.java
View File

@ -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;
/////////////////////////////////////////////////////

2
server/src/com/cloud/api/commands/ListVMsCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/ListVlanIpRangesCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/ListVolumesCmd.java
View File

@ -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());

6
server/src/com/cloud/api/commands/LockAccountCmd.java
View File

@ -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;
/////////////////////////////////////////////////////

4
server/src/com/cloud/api/commands/LockUserCmd.java
View File

@ -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;
/////////////////////////////////////////////////////

2
server/src/com/cloud/api/commands/PrepareForMaintenanceCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/QueryAsyncJobResultCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/RebootRouterCmd.java
View File

@ -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";

2
server/src/com/cloud/api/commands/RebootSystemVmCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/RebootVMCmd.java
View File

@ -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";

2
server/src/com/cloud/api/commands/ReconnectHostCmd.java
View File

@ -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());

2
server/src/com/cloud/api/commands/RecoverVMCmd.java
View File

@ -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());

4
server/src/com/cloud/api/commands/RegisterCmd.java
View File

@ -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;
/////////////////////////////////////////////////////

Some files were not shown because too many files have changed in this diff Show More