SoftLayer_Virtual_Guest_Network_Component


SoftLayer_Virtual_Guest_Network_Component

Description

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, represents an allocation of resources on a virtual host.

Local


createDate

The date a computing instance’s network component was created.
Type: dateTime


guestId

The unique ID of the SoftLayer_Virtual_Guest that this network component belongs to.
Type: integer


id

A computing instance’s network component’s unique ID.
Type: integer


macAddress

A computing instance network component’s unique MAC address.
Type: string


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


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


networkId

A computing instance’s network component’s SoftLayer_Virtual_Network ID
Type: integer


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


speed

A computing instance network component’s speed, measured in Mbit per second.
Type: integer


status

A computing instance network component’s status. This can be one of four possible values: “ACTIVE”, “DISABLED”, “INACTIVE”, or “ABUSE_DISCONNECT”. “ACTIVE” network components are enabled and in use on a cloud instance. “ABUSE_DISCONNECT” status components have been administratively disabled by SoftLayer accounting or abuse. “DISABLED” 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


uuid

A computing instance’s network component’s unique ID on a virtualization platform.
Type: string

Relational


guest

The computing instance that this network component exists on.
Type: SoftLayer_Virtual_Guest


ipAddressBindings

The records of all IP addresses bound to a computing instance’s network component.
Type: SoftLayer_Virtual_Guest_Network_Component_IpAddress[]


networkComponentFirewall

The upstream network component firewall.
Type: SoftLayer_Network_Component_Firewall


networkVlan

The VLAN that a computing instance network component’s subnet is associated with.
Type: SoftLayer_Network_Vlan


primaryIpAddress

A computing instance network component’s primary IP address.
Type: string


primarySubnet

A network component’s subnet for its primary IP address
Type: SoftLayer_Network_Subnet


primaryVersion6IpAddressRecord

A network component’s primary IPv6 IP address record.
Type: SoftLayer_Network_Subnet_IpAddress


router

A network component’s routers.
Type: SoftLayer_Hardware_Router


securityGroupBindings

The bindings associating security groups to this network component
Type: SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding[]


subnets

A network component’s subnets. A subnet is a group of IP addresses
Type: SoftLayer_Network_Subnet[]

Count


ipAddressBindingCount

A count of the records of all IP addresses bound to a computing instance’s network component.
Type: unsigned long


securityGroupBindingCount

A count of the bindings associating security groups to this network component
Type: unsigned long


subnetCount

A count of a network component’s subnets. A subnet is a group of IP addresses
Type: unsigned long



© SoftLayer 2020
Built with Hugo