SoftLayer Virtual Guest Network Component (type)

From SoftLayer Development Network Wiki

This page refers to the SoftLayer_Virtual_Guest_Network_Component data type. For information on the SoftLayer_Virtual_Guest_Network_Component service please see SoftLayer_Virtual_Guest_Network_Component.

Contents 1 Overview 2 Local Properties 2.1 createDate 2.2 guestId 2.3 id 2.4 macAddress 2.5 maxSpeed 2.6 modifyDate 2.7 name 2.8 networkId 2.9 port 2.10 speed 2.11 status 2.12 uuid 3 Relational Properties 3.1 guest 3.2 ipAddressBindings 3.3 networkComponentFirewall 3.4 networkVlan 3.5 primaryIpAddress 3.6 primarySubnet 3.7 subnets 4 Count Properties 4.1 ipAddressBindingCount 4.2 subnetCount

Overview

The virtual guest network component data type presents the structure in which all computing instance network components are presented. Internally, the structure supports various virtualization platforms with no change to external interaction.

A guest, also known as a virtual server or CloudLayer Computing Instance, represents an allocation of resources on a virtual host.

Warning! Even though our API is object based, XML-RPC can only return data as array values. The SOAP implementation treats data as object properties.

Local Properties

createDate

The date a computing instance's network component was created.

• Type: dateTime

---

guestId

The unique ID of the computing instance that this network component belongs to.

• Type: integer
• Length: 10 digits

---

id

A computing instance's network component's unique ID.

• Type: integer

---

macAddress

A computing instance network component's unique MAC address.

• Type: string
• Length: 20 characters

---

maxSpeed

A computing instance network component's maximum allowed speed, measured in Mbit per second. maxSpeed is determined by the capabilities of the network interface and the port speed purchased on your SoftLayer computing instance.

• Type: integer
• Length: 5 digits

---

modifyDate

The date a computing instance's network component was last modified.

• Type: dateTime

---

name

A computing instance network component's short name. This is usually eth. Use this in conjunction with the port property to identify a network component. For instance, the "eth0" interface on a server has the network component name "eth" and port 0.

• Type: string
• Length: 20 characters

---

networkId

A computing instance's network component's network ID

• Type: integer
• Length: 10 digits

---

port

A computing instance network component's port number. Most computing instances have more than one network interface. The port property separates these interfaces. Use this in conjunction with the name property to identify a network component. For instance, the "eth0" interface on a server has the network component name "eth" and port 0.

• Type: integer
• Length: 10 digits

---

speed

A computing instance network component's speed, measured in Mbit per second.

• Type: integer
• Length: 5 digits

---

status

A computing instance network component's status. This can take one of four possible values: "ACTIVE", "DISABLE" "USER_OFF". "ACTIVE" network components are enabled and in use on a cloud instance. "DISABLE" status components have been administratively disabled by SoftLayer accounting or abuse. "USER_OFF" components have been administratively disabled by you, the user. You should never see a network interface in MACWAIT state. If you happen to see one please contact SoftLayer support.

• Type: string
• Length: 12 characters

---

uuid

A computing instance's network component's unique ID on a virtualization platform.

• Type: string
• Length: 36 characters

Relational Properties

guest

The computing instance that this network component exists on.
guest can be queried by object mask.
guest must be a unique value.

• Type: SoftLayer_Virtual_Guest

---

ipAddressBindings

The records of all IP addresses bound to a computing instance's network component.
ipAddressBindings can be queried by object mask.

• Type: SoftLayer_Virtual_Guest_Network_Component_IpAddressArray

---

networkComponentFirewall

The upstream network component firewall.
networkComponentFirewall can be queried by object mask.
networkComponentFirewall must be a unique value.

• Type: SoftLayer_Network_Component_Firewall

---

networkVlan

The VLAN that a computing instance network component's subnet is associated with.
networkVlan can be queried by object mask.
networkVlan must be a unique value.

• Type: SoftLayer_Network_Vlan

---

primaryIpAddress

A computing instance network component's primary IP address.
primaryIpAddress must be a unique value.

• Type: string

---

primarySubnet

A network component's subnet for its primary IP address
primarySubnet can be queried by object mask.
primarySubnet must be a unique value.

• Type: SoftLayer_Network_Subnet

---

subnets

A network component's subnets. A subnet is a group of IP addresses
subnets can be queried by object mask.

• Type: SoftLayer_Network_SubnetArray

Count Properties

ipAddressBindingCount

A count of the records of all IP addresses bound to a computing instance's network component.
ipAddressBindingCount must be a unique value.

• Type: unsigned long

---

subnetCount

A count of a network component's subnets. A subnet is a group of IP addresses
subnetCount must be a unique value.

• Type: unsigned long