11.5. Sub-collections

11.5.1. Network VNIC Profile Sub-Collection

VNIC (Virtual Network Interface Controller) profiles, also referred to as virtual machine interface profiles, are customized profiles applied to users and groups to limit network bandwidth. Each vnicprofile contains the following elements:

Table 11.2. Elements for vnic profiles

Element Type Description
name string The unique identifier for the profile.
description string A plain text description of the profile.
network string The unique identifier of the logical network to which the profile applies.
port_mirroring Boolean: true or false The default is false.

Example 11.6. An XML representation of the network's vnicprofile sub-collection

<vnic_profile href= "/api/vnicprofiles/f9c2f9f1-3ae2-4100-a9a5-285ebb755c0d" id="f9c2f9f1-3ae2-4100-a9a5-285ebb755c0d">
	<name>Peanuts</name>
	<description>shelled</description>
	<network href= "/api/networks/00000000-0000-0000-0000-000000000009" id="00000000-0000-0000-0000-000000000009"/>
	<port_mirroring>false</port_mirroring>
	</vnic_profile>
</vnic_profiles>

11.5.2. Network Labels Sub-Collection

Network labels are plain text, human-readable labels that allow you to automate the association of logical networks with physical host network interfaces. Each label contains the following elements:

Table 11.3. Elements for labels

Element Type Description
network string The href and id of the networks to which the label is attached.

Example 11.7. An XML representation of the network's labels sub-collection

<labels>
  <label href="/api/networks/00000000-0000-0000-0000-000000000000/labels/eth0" id="eth0">
    <network href="/api/networks/00000000-0000-0000-0000-000000000000"
      id="00000000-0000-0000-0000-000000000000"/>
  </label>
</labels>

11.5.3. Methods

11.5.3.1. Attach Label to Logical Network Action

You can attach labels to a logical network to automate the association of that logical network with physical host network interfaces to which the same label has been attached.

Example 11.8. Action to attach a label to a logical network

POST /api/networks/00000000-0000-0000-0000-000000000000/labels/ HTTP/1.1
Accept: application/xml
Content-type: application/xml

<label id="Label_001" />

11.5.3.2. Removing a Label From a Logical Network

Removal of a label from a logical network requires a DELETE request.

Example 11.9. Removing a label from a logical network

DELETE /api/networks/00000000-0000-0000-0000-000000000000/labels/[label_id] HTTP/1.1

HTTP/1.1 204 No Content