Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Bug Reference

Wiki MarkupThe Jira issue associated with this design spec \[[TBD]\]spec.

Branch

TBD

Introduction

Wiki Markup
This design proposes to expose a virtual NIC as a first class object in the CloudStack API. The pattern follows that of the Amazon Elastic Network Interface \[1\].

...

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

false

Response Parameters

Parameter Name

Description

nic

The NIC that has been created (see data objects)

...

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

false

isrecursive


false

listall


false

virtualmachineid

List NICs for the specified virtual machine

false

zoneid

List NICs in the specified zone

false

Response Parameters

Parameter

Description

List<nic>

List of NIC that match the search criteria (see data objects)

...