Class Component
java.lang.Object
com.softlayer.api.Type
com.softlayer.api.service.Entity
com.softlayer.api.service.network.Component
- Direct Known Subclasses:
RemoteManagement
@ApiType("SoftLayer_Network_Component") public class Component extends Entity
Every piece of hardware running in SoftLayer's datacenters connected to the public, private, or management networks (where applicable) have a corresponding network component. These network components are modeled by the SoftLayer_Network_Component data type. These data types reflect the servers' local ethernet and remote management interfaces.
- See Also:
- SoftLayer_Network_Component
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Component.Mask
static interface
Component.Service
static interface
Component.ServiceAsync
-
Field Summary
Fields Modifier and Type Field Description protected Request
activeCommand
Reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command currently executing by the server's remote management card.protected Interface
componentInterface
[DEPRECATED] A hardware switch's interface to the bandwidth pod.protected Component
downlinkComponent
The network component linking this object to a child deviceprotected Mode
duplexMode
The duplex mode of a network component.protected String
duplexModeId
A network component's Duplex mode.protected boolean
duplexModeIdSpecified
protected Hardware
hardware
The hardware that a network component resides in.protected Long
hardwareId
The internal identifier of the hardware that a network component belongs to.protected boolean
hardwareIdSpecified
protected Boolean
highAvailabilityFirewallFlag
protected Long
id
A network component's internal identifier.protected boolean
idSpecified
protected Long
ipAddressBindingCount
A count of the records of all IP addresses bound to a network component.protected List<IpAddress>
ipAddressBindings
The records of all IP addresses bound to a network component.protected Long
ipAddressCount
A count ofprotected List<IpAddress>
ipAddresses
protected String
ipmiIpAddress
The IP address of an IPMI-based management network component.protected boolean
ipmiIpAddressSpecified
protected String
ipmiMacAddress
The MAC address of an IPMI-based management network component.protected boolean
ipmiMacAddressSpecified
protected Request
lastCommand
Last reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command issued to the server's remote management card.protected String
macAddress
A network component's unique MAC address.protected boolean
macAddressSpecified
protected Long
maxSpeed
A network component's maximum allowed speed, measured in Mbit per second.protected boolean
maxSpeedSpecified
protected Object
metricTrackingObject
The metric tracking object for this network component.protected GregorianCalendar
modifyDate
The date a network component was last modified.protected boolean
modifyDateSpecified
protected String
name
A network component's short name.protected boolean
nameSpecified
protected Firewall
networkComponentFirewall
The upstream network component firewall.protected Group
networkComponentGroup
A network component's associated group.protected List<Hardware>
networkHardware
All network devices in SoftLayer's network hierarchy that this device is connected to.protected Long
networkHardwareCount
A count of all network devices in SoftLayer's network hierarchy that this device is connected to.protected Vlan
networkVlan
The VLAN that a network component's subnet is associated with.protected Long
networkVlanId
The unique internal id of the network VLAN that the port belongs to.protected boolean
networkVlanIdSpecified
protected Long
networkVlanTrunkCount
A count of the VLANs that are trunked to this network component.protected List<Trunk>
networkVlanTrunks
The VLANs that are trunked to this network component.protected Long
port
A network component's port number.protected boolean
portSpecified
protected String
primaryIpAddress
A network component's primary IP address.protected IpAddress
primaryIpAddressRecord
The primary IPv4 Address record for a network component.protected boolean
primaryIpAddressSpecified
protected Subnet
primarySubnet
The subnet of the primary IP address assigned to this network component.protected IpAddress
primaryVersion6IpAddressRecord
The primary IPv6 Address record for a network component.protected Long
recentCommandCount
A count of the last five reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) commands issued to the server's remote management card.protected List<Request>
recentCommands
The last five reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) commands issued to the server's remote management card.protected Boolean
redundancyCapableFlag
Indicates whether the network component is participating in a group of two or more components capable of being operationally redundant, if enabled.protected Boolean
redundancyEnabledFlag
Indicates whether the network component is participating in a group of two or more components which is actively providing link redundancy.protected Long
remoteManagementUserCount
A count of user(s) credentials to issue commands and/or interact with the server's remote management card.protected List<User>
remoteManagementUsers
User(s) credentials to issue commands and/or interact with the server's remote management card.protected Hardware
router
A network component's routers.protected Long
speed
A network component's speed, measured in Mbit per second.protected boolean
speedSpecified
protected String
status
A network component's status.protected boolean
statusSpecified
protected Boolean
storageNetworkFlag
Whether a network component's primary ip address is from a storage network subnet or not.protected Long
subnetCount
A count of a network component's subnets.protected List<Subnet>
subnets
A network component's subnets.protected Component
uplinkComponent
The network component linking this object to parentprotected Mode
uplinkDuplexMode
The duplex mode of the uplink network component linking to this object -
Constructor Summary
Constructors Constructor Description Component()
-
Method Summary
-
Field Details
-
activeCommand
Reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command currently executing by the server's remote management card. -
downlinkComponent
The network component linking this object to a child device -
duplexMode
The duplex mode of a network component. -
hardware
The hardware that a network component resides in. -
highAvailabilityFirewallFlag
-
componentInterface
[DEPRECATED] A hardware switch's interface to the bandwidth pod. -
ipAddressBindings
The records of all IP addresses bound to a network component. -
ipAddresses
-
lastCommand
Last reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command issued to the server's remote management card. -
metricTrackingObject
The metric tracking object for this network component. -
networkComponentFirewall
The upstream network component firewall. -
networkComponentGroup
A network component's associated group. -
networkHardware
All network devices in SoftLayer's network hierarchy that this device is connected to. -
networkVlan
The VLAN that a network component's subnet is associated with. -
networkVlanTrunks
The VLANs that are trunked to this network component. -
primaryIpAddressRecord
The primary IPv4 Address record for a network component. -
primarySubnet
The subnet of the primary IP address assigned to this network component. -
primaryVersion6IpAddressRecord
The primary IPv6 Address record for a network component. -
recentCommands
The last five reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) commands issued to the server's remote management card. -
redundancyCapableFlag
Indicates whether the network component is participating in a group of two or more components capable of being operationally redundant, if enabled. -
redundancyEnabledFlag
Indicates whether the network component is participating in a group of two or more components which is actively providing link redundancy. -
remoteManagementUsers
User(s) credentials to issue commands and/or interact with the server's remote management card. -
router
A network component's routers. -
storageNetworkFlag
Whether a network component's primary ip address is from a storage network subnet or not. [Deprecated] -
subnets
A network component's subnets. A subnet is a group of IP addresses -
uplinkComponent
The network component linking this object to parent -
uplinkDuplexMode
The duplex mode of the uplink network component linking to this object -
duplexModeId
A network component's Duplex mode. -
duplexModeIdSpecified
protected boolean duplexModeIdSpecified -
hardwareId
The internal identifier of the hardware that a network component belongs to. -
hardwareIdSpecified
protected boolean hardwareIdSpecified -
id
A network component's internal identifier. -
idSpecified
protected boolean idSpecified -
ipmiIpAddress
The IP address of an IPMI-based management network component. -
ipmiIpAddressSpecified
protected boolean ipmiIpAddressSpecified -
ipmiMacAddress
The MAC address of an IPMI-based management network component. -
ipmiMacAddressSpecified
protected boolean ipmiMacAddressSpecified -
macAddress
A network component's unique MAC address. IPMI-based management network interfaces may not have a MAC address. -
macAddressSpecified
protected boolean macAddressSpecified -
maxSpeed
A 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 server. -
maxSpeedSpecified
protected boolean maxSpeedSpecified -
modifyDate
The date a network component was last modified. -
modifyDateSpecified
protected boolean modifyDateSpecified -
name
A network component's short name. For most servers this is the string "eth" for ethernet ports or "mgmt" for remote management ports. 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. -
nameSpecified
protected boolean nameSpecified -
networkVlanId
The unique internal id of the network VLAN that the port belongs to. -
networkVlanIdSpecified
protected boolean networkVlanIdSpecified -
port
A network component's port number. Most hardware has 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. -
portSpecified
protected boolean portSpecified -
primaryIpAddress
A network component's primary IP address. IPMI-based management network interfaces may not have an IP address. -
primaryIpAddressSpecified
protected boolean primaryIpAddressSpecified -
speed
A network component's speed, measured in Mbit per second. -
speedSpecified
protected boolean speedSpecified -
status
A network component's status. This can take one of four possible values: "ACTIVE", "DISABLE", "USER_OFF", or "MACWAIT". "ACTIVE" network components are enabled and in use on a servers. "DISABLE" status components have been administratively disabled by SoftLayer accounting or abuse. "USER_OFF" components have been administratively disabled by you, the user. "MACWAIT" components only exist on network components that have not been provisioned. You should never see a network interface in MACWAIT state. If you happen to see one please contact SoftLayer support. -
statusSpecified
protected boolean statusSpecified -
ipAddressBindingCount
A count of the records of all IP addresses bound to a network component. -
ipAddressCount
A count of -
networkHardwareCount
A count of all network devices in SoftLayer's network hierarchy that this device is connected to. -
networkVlanTrunkCount
A count of the VLANs that are trunked to this network component. -
recentCommandCount
A count of the last five reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) commands issued to the server's remote management card. -
remoteManagementUserCount
A count of user(s) credentials to issue commands and/or interact with the server's remote management card. -
subnetCount
A count of a network component's subnets. A subnet is a group of IP addresses
-
-
Constructor Details
-
Component
public Component()
-
-
Method Details
-
getActiveCommand
-
setActiveCommand
-
getDownlinkComponent
-
setDownlinkComponent
-
getDuplexMode
-
setDuplexMode
-
getHardware
-
setHardware
-
getHighAvailabilityFirewallFlag
-
setHighAvailabilityFirewallFlag
-
getComponentInterface
-
setComponentInterface
-
getIpAddressBindings
-
getIpAddresses
-
getLastCommand
-
setLastCommand
-
getMetricTrackingObject
-
setMetricTrackingObject
-
getNetworkComponentFirewall
-
setNetworkComponentFirewall
-
getNetworkComponentGroup
-
setNetworkComponentGroup
-
getNetworkHardware
-
getNetworkVlan
-
setNetworkVlan
-
getNetworkVlanTrunks
-
getPrimaryIpAddressRecord
-
setPrimaryIpAddressRecord
-
getPrimarySubnet
-
setPrimarySubnet
-
getPrimaryVersion6IpAddressRecord
-
setPrimaryVersion6IpAddressRecord
-
getRecentCommands
-
getRedundancyCapableFlag
-
setRedundancyCapableFlag
-
getRedundancyEnabledFlag
-
setRedundancyEnabledFlag
-
getRemoteManagementUsers
-
getRouter
-
setRouter
-
getStorageNetworkFlag
-
setStorageNetworkFlag
-
getSubnets
-
getUplinkComponent
-
setUplinkComponent
-
getUplinkDuplexMode
-
setUplinkDuplexMode
-
getDuplexModeId
-
setDuplexModeId
-
isDuplexModeIdSpecified
public boolean isDuplexModeIdSpecified() -
unsetDuplexModeId
public void unsetDuplexModeId() -
getHardwareId
-
setHardwareId
-
isHardwareIdSpecified
public boolean isHardwareIdSpecified() -
unsetHardwareId
public void unsetHardwareId() -
getId
-
setId
-
isIdSpecified
public boolean isIdSpecified() -
unsetId
public void unsetId() -
getIpmiIpAddress
-
setIpmiIpAddress
-
isIpmiIpAddressSpecified
public boolean isIpmiIpAddressSpecified() -
unsetIpmiIpAddress
public void unsetIpmiIpAddress() -
getIpmiMacAddress
-
setIpmiMacAddress
-
isIpmiMacAddressSpecified
public boolean isIpmiMacAddressSpecified() -
unsetIpmiMacAddress
public void unsetIpmiMacAddress() -
getMacAddress
-
setMacAddress
-
isMacAddressSpecified
public boolean isMacAddressSpecified() -
unsetMacAddress
public void unsetMacAddress() -
getMaxSpeed
-
setMaxSpeed
-
isMaxSpeedSpecified
public boolean isMaxSpeedSpecified() -
unsetMaxSpeed
public void unsetMaxSpeed() -
getModifyDate
-
setModifyDate
-
isModifyDateSpecified
public boolean isModifyDateSpecified() -
unsetModifyDate
public void unsetModifyDate() -
getName
-
setName
-
isNameSpecified
public boolean isNameSpecified() -
unsetName
public void unsetName() -
getNetworkVlanId
-
setNetworkVlanId
-
isNetworkVlanIdSpecified
public boolean isNetworkVlanIdSpecified() -
unsetNetworkVlanId
public void unsetNetworkVlanId() -
getPort
-
setPort
-
isPortSpecified
public boolean isPortSpecified() -
unsetPort
public void unsetPort() -
getPrimaryIpAddress
-
setPrimaryIpAddress
-
isPrimaryIpAddressSpecified
public boolean isPrimaryIpAddressSpecified() -
unsetPrimaryIpAddress
public void unsetPrimaryIpAddress() -
getSpeed
-
setSpeed
-
isSpeedSpecified
public boolean isSpeedSpecified() -
unsetSpeed
public void unsetSpeed() -
getStatus
-
setStatus
-
isStatusSpecified
public boolean isStatusSpecified() -
unsetStatus
public void unsetStatus() -
getIpAddressBindingCount
-
setIpAddressBindingCount
-
getIpAddressCount
-
setIpAddressCount
-
getNetworkHardwareCount
-
setNetworkHardwareCount
-
getNetworkVlanTrunkCount
-
setNetworkVlanTrunkCount
-
getRecentCommandCount
-
setRecentCommandCount
-
getRemoteManagementUserCount
-
setRemoteManagementUserCount
-
getSubnetCount
-
setSubnetCount
-
asService
-
service
-
service
-