THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
Page History
...
Document History
Glossary
Feature Specifications
New and modified Platform API
This feature will add the following new Platform API commands (User API).
...
In addition, the following API will be modified in a backward compatible manner, to allow a collection of NICs to be specified when deploying a new virtual machine, and clarify which NICs will be returned as a result of a list virtual machines command:
- deployVirtualMachine
- listVirtualMachines
Parameter profiles for the new and modified commands are described below (see Web Service API).
...
| Code Block |
|---|
command=deployVirtualMachine&networkids=net1,net2&securitygroupsids=sg1,sg2 |
This command would result in two NICs being created, each of which would have security groups sg1 and sg2 associated with it.
Multiple IP address support
A NIC may have one or more IP addresses, one of which is designated as the primary address of the NIC. To be consistent with the existing API the caller may specify which IP addresses to use for the NIC, or may choose to allow CloudStack to automatically allocate IP addresses (see createNic command).
Use cases
put the relevant use case/stories to explain how the feature is going to be used/work
Architecture and Design description
The feature allows the IaaS user great freedom in creating virtual machines and attaching them to networks.
One scenario would allow an IaaS user to construct a long lived service at a defined network identity by creating a NIC and associating it with a virtual machine. During the life of the service it may be that an update of the virtual machine is required (e.g. to apply security patches). In this case the old virtual machine can be destroyed but the NIC retained. When the new (patched) virtual machine is created it can be associated with the existing NIC and so continue to implement the service.
Architecture and Design description
The internal architecture of CloudStack already has much of the plumbing in place to support the proposed API changes.
This section will be updated with Architecture and Design description as the required changes are identified.
Web Services APIs
The principle is that any changes to the existing API are required to be backward compatible – i.e. they should not break any existing clients of the API.
...
createNic
This command requests that a NIC be created and attached to a specified network in the system.
Request Parameters
Parameter Name | Description | Required |
networkid | The Id of the network that the NIC will be attached to | true |
securitygroupids | Comma separated list of security group ids to be associated with the NIC | false |
ipaddress | Primary IP address of the NIC. If not specified CS will automatically allocate a primary IP address from the network range | false |
secondaryipaddresses | Comma separated list of secondary IP addresses to be associated with the NIC. Cannot be used in conjunction with secondaryipaddresscount parameter | false |
secondaryipaddresscount | Number of secondary IP addresses required on the NIC – the addresses will be automatically allocated by CloudStack. Cannot be used in conjunction with secondaryipaddresses parameter | false |
account | The account owning the NIC | false |
domainid | The id of the domain in which the NIC should reside. If account is used, domainid must also be used. | false |
projectid | The project in which to deploy the NIC |
Response Parameters
Parameter Name | Description |
nic | The NIC that has been created (see data objects) |
attachNic
This command requests that a NIC be attached to a specified virtual machine. A NIC may be attached to at most one virtual machine.
Request Parameters
Parameter Name | Description | Required |
id | The id of the NIC | true |
virtualmachineid | The Id of the virtual machine that the NIC will be attached to | true |
Response Parameters
Parameter Name | Description |
nic | The NIC that has been attached (see data objects) |
detachNic
This command requests that a NIC be detached from the specified virtual machine. The command will be rejected if this is the only NIC attached to the specified virtual machine.
Request Parameters
Parameter Name | Description | Required |
id | The id of the NIC | true |
virtualmachineid | The Id of the virtual machine that the NIC will be attached to | true |
Response Parameters
Parameter Name | Description |
nic | The NIC that has been detached (see data objects) |
listNics
This command requests a list of NICs.
Request Parameters
Parameter Name | Description | Required |
id | The Id of the NIC | false |
account | The account owning the NIC | false |
domainid | The id of the domain in which the NIC should reside. If account is used, domainid must also be used. | false |
projectid | List only NICs from this project | |
isrecursive | ||
listall | ||
virtualmachineid | List NICs for the specified virtual machine | |
zoneid | List NICs in the specified zone |
Response Parameters
Parameter | Description |
List<nic> | List of NIC that match the search criteria (see data objects) |
deleteNic
This command requests that a NIC be deleted. The command will be rejected if the NIC is attached to a virtual machine
Request Parameters
Parameter Name | Description | Required |
id | The id of the NIC | true |
Response Parameters
Parameter | Description |
displaytext | Any text associated with success or failure |
success | True if the operation succeeded |
API Data Objects
The NIC object is described separately as it is returned from multiple commands.
NIC
Attribute | Description |
id | Id of the NIC |
*securitygroup | List of security groups associated with the NIC |
broadcasturi | URI |
gateway | string |
ipaddress | Primary IP address of the NIC |
*secondaryipaddress | List of secondary IP addresses for the NIC |
isdefault | Indicates if this the default NIC |
isolationuri | URI |
macaddress | string |
netmask | string |
networkid | string |
traffictype | string |
type | string |
Existing API
The principle is that any changes to the existing API are required to be backward compatible – i.e. they should not break any existing clients of the API.
deployVirtualMachine
deployVirtualMachine
This command is modified to take an optional extra parameter that allows the caller to specify a collection of NICs to attach to the virtual machine. This parameter cannot be used with any of the legacy mechanisms for attaching a virtual machine to a network. In addition, if the the caller does specify a collection of NICs then she may not also specify security groups for the virtual machine.This command is modified to take an optional extra parameter:
Request Parameters
Parameter Name | Description | Required |
nicids | Comma separated list of NICs to attach to the virtual machine. The first NIC in the list will be designated as the default NIC. Cannot be used in conjunction with secuirtygroupnames, secutirygroupids, ipaddress, iptonetworklist or networkids parameters. | false |
listVirtualMachines
This commands request object is unchanged.
Response Parameters
The The syntax of the response object is unchangedalso unchanged, but the description is changed.
Response Parameters
Parameter | Description |
securitygroups | The set of security groups associated with the virtual machine's NICs is returned (i.e. only one instance of a security group is returned even if it is associated with more than one NIC). |
|
|
NIC
The NIC data object is described here as a separate entity as it is returned as part of a number of responses.
Attribute | Description |
id | Id of the NIC |
securitygroup(*) | List of security groups associated with the NIC |
broadcasturi | URI |
gateway | string |
ipaddress | Primary IP address of the NIC |
secondaryipaddress(*) | List of secondary IP addresses for the NIC |
isdefault | Indicates if this the default NIC |
isolationuri | URI |
macaddress | string |
netmask | string |
networkid | string |
traffictype | string |
type | string |
UI flow
TBD UI flow
Appendix
Appendix A:
Appendix B:
Overview
Content Tools
Apps