etan39
/
cloudstack
mirror of https://github.com/apache/cloudstack.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixed Api doc for create/listNetworks

This commit is contained in:
alena 2011-03-04 15:10:20 -08:00
parent 6b6577d5e9
commit 3db6d9cad4
3 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
api/src/com/cloud/api/commands/CreateNetworkCmd.java
View File

@ -51,22 +51,22 @@ public class CreateNetworkCmd extends BaseCmd {
@Parameter(name=ApiConstants.NETWORK_OFFERING_ID, type=CommandType.LONG, required=true, description="the network offering id")
private Long networkOfferingId;
@Parameter(name=ApiConstants.ZONE_ID, type=CommandType.LONG, required=true, description="the Zone ID for the Vlan ip range")
@Parameter(name=ApiConstants.ZONE_ID, type=CommandType.LONG, required=true, description="the Zone ID for the network")
private Long zoneId;
@Parameter(name=ApiConstants.GATEWAY, type=CommandType.STRING, description="the gateway of the VLAN IP range")
@Parameter(name=ApiConstants.GATEWAY, type=CommandType.STRING, description="the gateway of the network")
private String gateway;
@Parameter(name=ApiConstants.NETMASK, type=CommandType.STRING, description="the netmask of the VLAN IP range")
@Parameter(name=ApiConstants.NETMASK, type=CommandType.STRING, description="the netmask of the network")
private String netmask;
@Parameter(name=ApiConstants.START_IP, type=CommandType.STRING, description="the beginning IP address in the VLAN IP range")
@Parameter(name=ApiConstants.START_IP, type=CommandType.STRING, description="the beginning IP address in the network IP range")
private String startIp;
@Parameter(name=ApiConstants.END_IP, type=CommandType.STRING, description="the ending IP address in the VLAN IP range")
@Parameter(name=ApiConstants.END_IP, type=CommandType.STRING, description="the ending IP address in the network IP range. If not specified, will be defaulted to startIP")
private String endIp;
@Parameter(name=ApiConstants.VLAN, type=CommandType.STRING, description="the ID or VID of the VLAN. Default is an \"untagged\" VLAN.")
@Parameter(name=ApiConstants.VLAN, type=CommandType.STRING, description="the ID or VID of the network")
private String vlan;
@Parameter(name=ApiConstants.ACCOUNT, type=CommandType.STRING, description="account who will own the network")
@ -75,7 +75,7 @@ public class CreateNetworkCmd extends BaseCmd {
@Parameter(name=ApiConstants.DOMAIN_ID, type=CommandType.LONG, description="domain ID of the account owning a network")
private Long domainId;
@Parameter(name=ApiConstants.IS_SHARED, type=CommandType.BOOLEAN, description="true is network offering supports vlans")
@Parameter(name=ApiConstants.IS_SHARED, type=CommandType.BOOLEAN, description="true is network is shared across accounts in the Zone")
private Boolean isShared;
@Parameter(name=ApiConstants.IS_DEFAULT, type=CommandType.BOOLEAN, description="true if network is default, false otherwise")

2
api/src/com/cloud/api/commands/ListNetworksCmd.java
View File

@ -58,7 +58,7 @@ public class ListNetworksCmd extends BaseListCmd {
@Parameter(name=ApiConstants.IS_SYSTEM, type=CommandType.BOOLEAN, description="true if network is system, false otherwise")
private Boolean isSystem;
@Parameter(name=ApiConstants.IS_SHARED, type=CommandType.BOOLEAN, description="true if network is shared, false otherwise")
@Parameter(name=ApiConstants.IS_SHARED, type=CommandType.BOOLEAN, description="true if network is shared across accounts in the Zone, false otherwise")
private Boolean isShared;
@Parameter(name=ApiConstants.IS_DEFAULT, type=CommandType.BOOLEAN, description="true if network is default, false otherwise")

10
api/src/com/cloud/api/response/NetworkResponse.java
View File

@ -65,10 +65,10 @@ public class NetworkResponse extends BaseResponse{
@SerializedName("broadcasturi") @Param(description="broadcast uri of the network")
private String broadcastUri;
@SerializedName("dns1") @Param(description="the first dns for the network")
@SerializedName("dns1") @Param(description="the first DNS for the network")
private String dns1;
@SerializedName("dns2") @Param(description="the second dns for the network")
@SerializedName("dns2") @Param(description="the second DNS for the network")
private String dns2;
@SerializedName("type") @Param(description="the type of the network")
@ -77,13 +77,13 @@ public class NetworkResponse extends BaseResponse{
@SerializedName("vlan") @Param(description="the vlan of the network")
private String vlan;
@SerializedName(ApiConstants.ACCOUNT) @Param(description="the account associated with the network")
@SerializedName(ApiConstants.ACCOUNT) @Param(description="the owner of the network")
private String accountName;
@SerializedName(ApiConstants.DOMAIN_ID) @Param(description="the domain id associated with the network")
@SerializedName(ApiConstants.DOMAIN_ID) @Param(description="the domain id of the network owner")
private Long domainId;
@SerializedName(ApiConstants.DOMAIN) @Param(description="the domain associated with the network")
@SerializedName(ApiConstants.DOMAIN) @Param(description="the domain name of the network owner")
private String domain;
@SerializedName("isdefault") @Param(description="true if network is default, false otherwise")