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
  • Field Details

    • activeCommand

      @ApiProperty protected Request activeCommand
      Reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command currently executing by the server's remote management card.
    • downlinkComponent

      @ApiProperty protected Component downlinkComponent
      The network component linking this object to a child device
    • duplexMode

      @ApiProperty protected Mode duplexMode
      The duplex mode of a network component.
    • hardware

      @ApiProperty protected Hardware hardware
      The hardware that a network component resides in.
    • highAvailabilityFirewallFlag

      @ApiProperty protected Boolean highAvailabilityFirewallFlag
    • componentInterface

      @ApiProperty("interface") protected Interface componentInterface
      [DEPRECATED] A hardware switch's interface to the bandwidth pod.
    • ipAddressBindings

      @ApiProperty protected List<IpAddress> ipAddressBindings
      The records of all IP addresses bound to a network component.
    • ipAddresses

      @ApiProperty protected List<IpAddress> ipAddresses
    • lastCommand

      @ApiProperty protected Request lastCommand
      Last reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command issued to the server's remote management card.
    • metricTrackingObject

      @ApiProperty protected Object metricTrackingObject
      The metric tracking object for this network component.
    • networkComponentFirewall

      @ApiProperty protected Firewall networkComponentFirewall
      The upstream network component firewall.
    • networkComponentGroup

      @ApiProperty protected Group networkComponentGroup
      A network component's associated group.
    • networkHardware

      @ApiProperty protected List<Hardware> networkHardware
      All network devices in SoftLayer's network hierarchy that this device is connected to.
    • networkVlan

      @ApiProperty protected Vlan networkVlan
      The VLAN that a network component's subnet is associated with.
    • networkVlanTrunks

      @ApiProperty protected List<Trunk> networkVlanTrunks
      The VLANs that are trunked to this network component.
    • primaryIpAddressRecord

      @ApiProperty protected IpAddress primaryIpAddressRecord
      The primary IPv4 Address record for a network component.
    • primarySubnet

      @ApiProperty protected Subnet primarySubnet
      The subnet of the primary IP address assigned to this network component.
    • primaryVersion6IpAddressRecord

      @ApiProperty protected IpAddress primaryVersion6IpAddressRecord
      The primary IPv6 Address record for a network component.
    • recentCommands

      @ApiProperty 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.
    • redundancyCapableFlag

      @ApiProperty 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.
    • redundancyEnabledFlag

      @ApiProperty protected Boolean redundancyEnabledFlag
      Indicates whether the network component is participating in a group of two or more components which is actively providing link redundancy.
    • remoteManagementUsers

      @ApiProperty protected List<User> remoteManagementUsers
      User(s) credentials to issue commands and/or interact with the server's remote management card.
    • router

      @ApiProperty protected Hardware router
      A network component's routers.
    • storageNetworkFlag

      @ApiProperty protected Boolean storageNetworkFlag
      Whether a network component's primary ip address is from a storage network subnet or not. [Deprecated]
    • subnets

      @ApiProperty protected List<Subnet> subnets
      A network component's subnets. A subnet is a group of IP addresses
    • uplinkComponent

      @ApiProperty protected Component uplinkComponent
      The network component linking this object to parent
    • uplinkDuplexMode

      @ApiProperty protected Mode uplinkDuplexMode
      The duplex mode of the uplink network component linking to this object
    • duplexModeId

      @ApiProperty(canBeNullOrNotSet=true) protected String duplexModeId
      A network component's Duplex mode.
    • duplexModeIdSpecified

      protected boolean duplexModeIdSpecified
    • hardwareId

      @ApiProperty(canBeNullOrNotSet=true) protected Long hardwareId
      The internal identifier of the hardware that a network component belongs to.
    • hardwareIdSpecified

      protected boolean hardwareIdSpecified
    • id

      @ApiProperty(canBeNullOrNotSet=true) protected Long id
      A network component's internal identifier.
    • idSpecified

      protected boolean idSpecified
    • ipmiIpAddress

      @ApiProperty(canBeNullOrNotSet=true) protected String ipmiIpAddress
      The IP address of an IPMI-based management network component.
    • ipmiIpAddressSpecified

      protected boolean ipmiIpAddressSpecified
    • ipmiMacAddress

      @ApiProperty(canBeNullOrNotSet=true) protected String ipmiMacAddress
      The MAC address of an IPMI-based management network component.
    • ipmiMacAddressSpecified

      protected boolean ipmiMacAddressSpecified
    • macAddress

      @ApiProperty(canBeNullOrNotSet=true) protected String macAddress
      A network component's unique MAC address. IPMI-based management network interfaces may not have a MAC address.
    • macAddressSpecified

      protected boolean macAddressSpecified
    • maxSpeed

      @ApiProperty(canBeNullOrNotSet=true) protected Long 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

      @ApiProperty(canBeNullOrNotSet=true) protected GregorianCalendar modifyDate
      The date a network component was last modified.
    • modifyDateSpecified

      protected boolean modifyDateSpecified
    • name

      @ApiProperty(canBeNullOrNotSet=true) protected String 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

      @ApiProperty(canBeNullOrNotSet=true) protected Long networkVlanId
      The unique internal id of the network VLAN that the port belongs to.
    • networkVlanIdSpecified

      protected boolean networkVlanIdSpecified
    • port

      @ApiProperty(canBeNullOrNotSet=true) protected Long 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

      @ApiProperty(canBeNullOrNotSet=true) protected String primaryIpAddress
      A network component's primary IP address. IPMI-based management network interfaces may not have an IP address.
    • primaryIpAddressSpecified

      protected boolean primaryIpAddressSpecified
    • speed

      @ApiProperty(canBeNullOrNotSet=true) protected Long speed
      A network component's speed, measured in Mbit per second.
    • speedSpecified

      protected boolean speedSpecified
    • status

      @ApiProperty(canBeNullOrNotSet=true) protected String 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

      @ApiProperty protected Long ipAddressBindingCount
      A count of the records of all IP addresses bound to a network component.
    • ipAddressCount

      @ApiProperty protected Long ipAddressCount
      A count of
    • networkHardwareCount

      @ApiProperty protected Long networkHardwareCount
      A count of all network devices in SoftLayer's network hierarchy that this device is connected to.
    • networkVlanTrunkCount

      @ApiProperty protected Long networkVlanTrunkCount
      A count of the VLANs that are trunked to this network component.
    • recentCommandCount

      @ApiProperty 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.
    • remoteManagementUserCount

      @ApiProperty protected Long remoteManagementUserCount
      A count of user(s) credentials to issue commands and/or interact with the server's remote management card.
    • subnetCount

      @ApiProperty protected Long 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

      public Request getActiveCommand()
    • setActiveCommand

      public void setActiveCommand​(Request activeCommand)
    • getDownlinkComponent

      public Component getDownlinkComponent()
    • setDownlinkComponent

      public void setDownlinkComponent​(Component downlinkComponent)
    • getDuplexMode

      public Mode getDuplexMode()
    • setDuplexMode

      public void setDuplexMode​(Mode duplexMode)
    • getHardware

      public Hardware getHardware()
    • setHardware

      public void setHardware​(Hardware hardware)
    • getHighAvailabilityFirewallFlag

      public Boolean getHighAvailabilityFirewallFlag()
    • setHighAvailabilityFirewallFlag

      public void setHighAvailabilityFirewallFlag​(Boolean highAvailabilityFirewallFlag)
    • getComponentInterface

      public Interface getComponentInterface()
    • setComponentInterface

      public void setComponentInterface​(Interface componentInterface)
    • getIpAddressBindings

      public List<IpAddress> getIpAddressBindings()
    • getIpAddresses

      public List<IpAddress> getIpAddresses()
    • getLastCommand

      public Request getLastCommand()
    • setLastCommand

      public void setLastCommand​(Request lastCommand)
    • getMetricTrackingObject

      public Object getMetricTrackingObject()
    • setMetricTrackingObject

      public void setMetricTrackingObject​(Object metricTrackingObject)
    • getNetworkComponentFirewall

      public Firewall getNetworkComponentFirewall()
    • setNetworkComponentFirewall

      public void setNetworkComponentFirewall​(Firewall networkComponentFirewall)
    • getNetworkComponentGroup

      public Group getNetworkComponentGroup()
    • setNetworkComponentGroup

      public void setNetworkComponentGroup​(Group networkComponentGroup)
    • getNetworkHardware

      public List<Hardware> getNetworkHardware()
    • getNetworkVlan

      public Vlan getNetworkVlan()
    • setNetworkVlan

      public void setNetworkVlan​(Vlan networkVlan)
    • getNetworkVlanTrunks

      public List<Trunk> getNetworkVlanTrunks()
    • getPrimaryIpAddressRecord

      public IpAddress getPrimaryIpAddressRecord()
    • setPrimaryIpAddressRecord

      public void setPrimaryIpAddressRecord​(IpAddress primaryIpAddressRecord)
    • getPrimarySubnet

      public Subnet getPrimarySubnet()
    • setPrimarySubnet

      public void setPrimarySubnet​(Subnet primarySubnet)
    • getPrimaryVersion6IpAddressRecord

      public IpAddress getPrimaryVersion6IpAddressRecord()
    • setPrimaryVersion6IpAddressRecord

      public void setPrimaryVersion6IpAddressRecord​(IpAddress primaryVersion6IpAddressRecord)
    • getRecentCommands

      public List<Request> getRecentCommands()
    • getRedundancyCapableFlag

      public Boolean getRedundancyCapableFlag()
    • setRedundancyCapableFlag

      public void setRedundancyCapableFlag​(Boolean redundancyCapableFlag)
    • getRedundancyEnabledFlag

      public Boolean getRedundancyEnabledFlag()
    • setRedundancyEnabledFlag

      public void setRedundancyEnabledFlag​(Boolean redundancyEnabledFlag)
    • getRemoteManagementUsers

      public List<User> getRemoteManagementUsers()
    • getRouter

      public Hardware getRouter()
    • setRouter

      public void setRouter​(Hardware router)
    • getStorageNetworkFlag

      public Boolean getStorageNetworkFlag()
    • setStorageNetworkFlag

      public void setStorageNetworkFlag​(Boolean storageNetworkFlag)
    • getSubnets

      public List<Subnet> getSubnets()
    • getUplinkComponent

      public Component getUplinkComponent()
    • setUplinkComponent

      public void setUplinkComponent​(Component uplinkComponent)
    • getUplinkDuplexMode

      public Mode getUplinkDuplexMode()
    • setUplinkDuplexMode

      public void setUplinkDuplexMode​(Mode uplinkDuplexMode)
    • getDuplexModeId

      public String getDuplexModeId()
    • setDuplexModeId

      public void setDuplexModeId​(String duplexModeId)
    • isDuplexModeIdSpecified

      public boolean isDuplexModeIdSpecified()
    • unsetDuplexModeId

      public void unsetDuplexModeId()
    • getHardwareId

      public Long getHardwareId()
    • setHardwareId

      public void setHardwareId​(Long hardwareId)
    • isHardwareIdSpecified

      public boolean isHardwareIdSpecified()
    • unsetHardwareId

      public void unsetHardwareId()
    • getId

      public Long getId()
    • setId

      public void setId​(Long id)
    • isIdSpecified

      public boolean isIdSpecified()
    • unsetId

      public void unsetId()
    • getIpmiIpAddress

      public String getIpmiIpAddress()
    • setIpmiIpAddress

      public void setIpmiIpAddress​(String ipmiIpAddress)
    • isIpmiIpAddressSpecified

      public boolean isIpmiIpAddressSpecified()
    • unsetIpmiIpAddress

      public void unsetIpmiIpAddress()
    • getIpmiMacAddress

      public String getIpmiMacAddress()
    • setIpmiMacAddress

      public void setIpmiMacAddress​(String ipmiMacAddress)
    • isIpmiMacAddressSpecified

      public boolean isIpmiMacAddressSpecified()
    • unsetIpmiMacAddress

      public void unsetIpmiMacAddress()
    • getMacAddress

      public String getMacAddress()
    • setMacAddress

      public void setMacAddress​(String macAddress)
    • isMacAddressSpecified

      public boolean isMacAddressSpecified()
    • unsetMacAddress

      public void unsetMacAddress()
    • getMaxSpeed

      public Long getMaxSpeed()
    • setMaxSpeed

      public void setMaxSpeed​(Long maxSpeed)
    • isMaxSpeedSpecified

      public boolean isMaxSpeedSpecified()
    • unsetMaxSpeed

      public void unsetMaxSpeed()
    • getModifyDate

      public GregorianCalendar getModifyDate()
    • setModifyDate

      public void setModifyDate​(GregorianCalendar modifyDate)
    • isModifyDateSpecified

      public boolean isModifyDateSpecified()
    • unsetModifyDate

      public void unsetModifyDate()
    • getName

      public String getName()
    • setName

      public void setName​(String name)
    • isNameSpecified

      public boolean isNameSpecified()
    • unsetName

      public void unsetName()
    • getNetworkVlanId

      public Long getNetworkVlanId()
    • setNetworkVlanId

      public void setNetworkVlanId​(Long networkVlanId)
    • isNetworkVlanIdSpecified

      public boolean isNetworkVlanIdSpecified()
    • unsetNetworkVlanId

      public void unsetNetworkVlanId()
    • getPort

      public Long getPort()
    • setPort

      public void setPort​(Long port)
    • isPortSpecified

      public boolean isPortSpecified()
    • unsetPort

      public void unsetPort()
    • getPrimaryIpAddress

      public String getPrimaryIpAddress()
    • setPrimaryIpAddress

      public void setPrimaryIpAddress​(String primaryIpAddress)
    • isPrimaryIpAddressSpecified

      public boolean isPrimaryIpAddressSpecified()
    • unsetPrimaryIpAddress

      public void unsetPrimaryIpAddress()
    • getSpeed

      public Long getSpeed()
    • setSpeed

      public void setSpeed​(Long speed)
    • isSpeedSpecified

      public boolean isSpeedSpecified()
    • unsetSpeed

      public void unsetSpeed()
    • getStatus

      public String getStatus()
    • setStatus

      public void setStatus​(String status)
    • isStatusSpecified

      public boolean isStatusSpecified()
    • unsetStatus

      public void unsetStatus()
    • getIpAddressBindingCount

      public Long getIpAddressBindingCount()
    • setIpAddressBindingCount

      public void setIpAddressBindingCount​(Long ipAddressBindingCount)
    • getIpAddressCount

      public Long getIpAddressCount()
    • setIpAddressCount

      public void setIpAddressCount​(Long ipAddressCount)
    • getNetworkHardwareCount

      public Long getNetworkHardwareCount()
    • setNetworkHardwareCount

      public void setNetworkHardwareCount​(Long networkHardwareCount)
    • getNetworkVlanTrunkCount

      public Long getNetworkVlanTrunkCount()
    • setNetworkVlanTrunkCount

      public void setNetworkVlanTrunkCount​(Long networkVlanTrunkCount)
    • getRecentCommandCount

      public Long getRecentCommandCount()
    • setRecentCommandCount

      public void setRecentCommandCount​(Long recentCommandCount)
    • getRemoteManagementUserCount

      public Long getRemoteManagementUserCount()
    • setRemoteManagementUserCount

      public void setRemoteManagementUserCount​(Long remoteManagementUserCount)
    • getSubnetCount

      public Long getSubnetCount()
    • setSubnetCount

      public void setSubnetCount​(Long subnetCount)
    • asService

      public Component.Service asService​(ApiClient client)
    • service

      public static Component.Service service​(ApiClient client)
    • service

      public static Component.Service service​(ApiClient client, Long id)