All Superinterfaces:: Maskable, ResultLimitable, Service

Enclosing class:: Component

@ApiService("SoftLayer_Network_Component")
public static interface Component.Service
extends Service

See Also:: SoftLayer_Network_Component

Method Summary

Modifier and Type	Method	Description
`List<Vlan>`	`addNetworkVlanTrunks(List<Vlan> networkVlans)`	Add VLANs as trunks to a network component.
`Component.ServiceAsync`	`asAsync()`	Get an async version of this service
`List<Vlan>`	`clearNetworkVlanTrunks()`	This method will remove all VLANs trunked to this network component.
`Request`	`getActiveCommand()`	Reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command currently executing by the server's remote management card.
`Interface`	`getComponentInterface()`	[DEPRECATED] A hardware switch's interface to the bandwidth pod.
`Graph`	`getCustomBandwidthDataByDate(Graph graphData)`	Retrieve bandwidth graph by date.
`Component`	`getDownlinkComponent()`	The network component linking this object to a child device
`Mode`	`getDuplexMode()`	The duplex mode of a network component.
`Hardware`	`getHardware()`	The hardware that a network component resides in.
`Boolean`	`getHighAvailabilityFirewallFlag()`
`List<IpAddress>`	`getIpAddressBindings()`	The records of all IP addresses bound to a network component.
`List<IpAddress>`	`getIpAddresses()`
`Request`	`getLastCommand()`	Last reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command issued to the server's remote management card.
`Object`	`getMetricTrackingObject()`	The metric tracking object for this network component.
`Firewall`	`getNetworkComponentFirewall()`	The upstream network component firewall.
`Group`	`getNetworkComponentGroup()`	A network component's associated group.
`List<Hardware>`	`getNetworkHardware()`	All network devices in SoftLayer's network hierarchy that this device is connected to.
`Vlan`	`getNetworkVlan()`	The VLAN that a network component's subnet is associated with.
`List<Trunk>`	`getNetworkVlanTrunks()`	The VLANs that are trunked to this network component.
`Component`	`getObject()`
`Statistic`	`getPortStatistics()`	DEPRECATED - This operation will cease to function after April 4th, 2016 and will be removed from v3.2 Retrieve various network statistics.
`IpAddress`	`getPrimaryIpAddressRecord()`	The primary IPv4 Address record for a network component.
`Subnet`	`getPrimarySubnet()`	The subnet of the primary IP address assigned to this network component.
`IpAddress`	`getPrimaryVersion6IpAddressRecord()`	The primary IPv6 Address record for a network component.
`List<Request>`	`getRecentCommands()`	The last five reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) commands issued to the server's remote management card.
`Boolean`	`getRedundancyCapableFlag()`	Indicates whether the network component is participating in a group of two or more components capable of being operationally redundant, if enabled.
`Boolean`	`getRedundancyEnabledFlag()`	Indicates whether the network component is participating in a group of two or more components which is actively providing link redundancy.
`List<User>`	`getRemoteManagementUsers()`	User(s) credentials to issue commands and/or interact with the server's remote management card.
`Hardware`	`getRouter()`	A network component's routers.
`Boolean`	`getStorageNetworkFlag()`	Whether a network component's primary ip address is from a storage network subnet or not.
`List<Subnet>`	`getSubnets()`	A network component's subnets.
`Component`	`getUplinkComponent()`	The network component linking this object to parent
`Mode`	`getUplinkDuplexMode()`	The duplex mode of the uplink network component linking to this object
`List<Vlan>`	`removeNetworkVlanTrunks(List<Vlan> networkVlans)`	Remove one or more VLANs currently attached to the uplinkComponent of this networkComponent.
`void`	`setMask(Component.Mask mask)`
`Component.Mask`	`withMask()`	Use the existing mask on this service or create it if not present
`Component.Mask`	`withNewMask()`	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Details
- asAsync
  
  Component.ServiceAsync asAsync()
  
  Description copied from interface: Service
  
  Get an async version of this service
  
  Specified by:
  
  asAsync in interface Service
- withNewMask
  
  Component.Mask withNewMask()
  
  Description copied from interface: Maskable
  
  Overwrite the existing mask on this service with a new one and return it
  
  Specified by:
  
  withNewMask in interface Maskable
- withMask
  
  Component.Mask withMask()
  
  Description copied from interface: Maskable
  
  Use the existing mask on this service or create it if not present
  
  Specified by:
  
  withMask in interface Maskable
- setMask
  
  void setMask(Component.Mask mask)
- addNetworkVlanTrunks
  
  @ApiMethod(instanceRequired=true) List<Vlan> addNetworkVlanTrunks(List<Vlan> networkVlans)
  
  Add VLANs as trunks to a network component. The VLANs given must be assigned to your account, and on the router to which this network component is connected. The current native VLAN (networkVlanId/networkVlan) cannot be added as a trunk. This method should be called on a network component attached directly to customer assigned hardware, though all trunking operations will occur on the uplinkComponent. A current list of VLAN trunks for a network component on a customer server can be found at 'uplinkComponent->networkVlanTrunks'.
  
  This method returns an array of SoftLayer_Network_Vlans which were added as trunks. Any requested trunks which are already trunked will be silently ignored, and will not be returned.
  
  Configuration of network hardware is done asynchronously, do not depend on the return of this call as an indication that the newly trunked VLANs will be accessible.
  
  See Also:
  
  SoftLayer_Network_Component::addNetworkVlanTrunks
- clearNetworkVlanTrunks
  
  @ApiMethod(instanceRequired=true) List<Vlan> clearNetworkVlanTrunks()
  
  This method will remove all VLANs trunked to this network component. The native VLAN (networkVlanId/networkVlan) will remain active, and cannot be removed via the API. Returns a list of SoftLayer_Network_Vlan objects for which the trunks were removed.
  
  See Also:
  
  SoftLayer_Network_Component::clearNetworkVlanTrunks
- getCustomBandwidthDataByDate
  
  @ApiMethod(instanceRequired=true) Graph getCustomBandwidthDataByDate(Graph graphData)
  
  Retrieve bandwidth graph by date.
  
  See Also:
  
  SoftLayer_Network_Component::getCustomBandwidthDataByDate
- getObject
  
  @ApiMethod(instanceRequired=true) Component getObject()
  
  See Also:
  
  SoftLayer_Network_Component::getObject
- getPortStatistics
  
  @ApiMethod(instanceRequired=true) Statistic getPortStatistics()
  
  **DEPRECATED - This operation will cease to function after April 4th, 2016 and will be removed from v3.2**
  Retrieve various network statistics. The network statistics are retrieved from the network device using snmpget. Below is a list of statistics retrieved:
  * Administrative Status
  * Operational Status
  * Maximum Transmission Unit
  * In Octets
  * Out Octets
  * In Unicast Packets
  * Out Unicast Packets
  * In Multicast Packets
  * Out Multicast Packets
  
  See Also:
  
  SoftLayer_Network_Component::getPortStatistics
- removeNetworkVlanTrunks
  
  @ApiMethod(instanceRequired=true) List<Vlan> removeNetworkVlanTrunks(List<Vlan> networkVlans)
  
  Remove one or more VLANs currently attached to the uplinkComponent of this networkComponent. The VLANs given must be assigned to your account, and on the router the network component is connected to. If any VLANs not currently trunked are given, they will be silently ignored.
  
  This method should be called on a network component attached directly to customer assigned hardware, though all trunking operations will occur on the uplinkComponent. A current list of VLAN trunks for a network component on a customer server can be found at 'uplinkComponent->networkVlanTrunks'.
  
  Configuration of network hardware is done asynchronously, do not depend on the return of this call as an indication that the removed VLANs will be inaccessible.
  
  See Also:
  
  SoftLayer_Network_Component::removeNetworkVlanTrunks
- getActiveCommand
  
  @ApiMethod(instanceRequired=true) Request getActiveCommand()
  
  Reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command currently executing by the server's remote management card.
  
  See Also:
  
  SoftLayer_Network_Component::getActiveCommand
- getDownlinkComponent
  
  @ApiMethod(instanceRequired=true) Component getDownlinkComponent()
  
  The network component linking this object to a child device
  
  See Also:
  
  SoftLayer_Network_Component::getDownlinkComponent
- getDuplexMode
  
  @ApiMethod(instanceRequired=true) Mode getDuplexMode()
  
  The duplex mode of a network component.
  
  See Also:
  
  SoftLayer_Network_Component::getDuplexMode
- getHardware
  
  @ApiMethod(instanceRequired=true) Hardware getHardware()
  
  The hardware that a network component resides in.
  
  See Also:
  
  SoftLayer_Network_Component::getHardware
- getHighAvailabilityFirewallFlag
  
  @ApiMethod(instanceRequired=true) Boolean getHighAvailabilityFirewallFlag()
  
  See Also:
  
  SoftLayer_Network_Component::getHighAvailabilityFirewallFlag
- getComponentInterface
  
  @ApiMethod(instanceRequired=true) Interface getComponentInterface()
  
  [DEPRECATED] A hardware switch's interface to the bandwidth pod.
  
  See Also:
  
  SoftLayer_Network_Component::getComponentInterface
- getIpAddressBindings
  
  @ApiMethod(instanceRequired=true) List<IpAddress> getIpAddressBindings()
  
  The records of all IP addresses bound to a network component.
  
  See Also:
  
  SoftLayer_Network_Component::getIpAddressBindings
- getIpAddresses
  
  @ApiMethod(instanceRequired=true) List<IpAddress> getIpAddresses()
  
  See Also:
  
  SoftLayer_Network_Component::getIpAddresses
- getLastCommand
  
  @ApiMethod(instanceRequired=true) Request getLastCommand()
  
  Last reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command issued to the server's remote management card.
  
  See Also:
  
  SoftLayer_Network_Component::getLastCommand
- getMetricTrackingObject
  
  @ApiMethod(instanceRequired=true) Object getMetricTrackingObject()
  
  The metric tracking object for this network component.
  
  See Also:
  
  SoftLayer_Network_Component::getMetricTrackingObject
- getNetworkComponentFirewall
  
  @ApiMethod(instanceRequired=true) Firewall getNetworkComponentFirewall()
  
  The upstream network component firewall.
  
  See Also:
  
  SoftLayer_Network_Component::getNetworkComponentFirewall
- getNetworkComponentGroup
  
  @ApiMethod(instanceRequired=true) Group getNetworkComponentGroup()
  
  A network component's associated group.
  
  See Also:
  
  SoftLayer_Network_Component::getNetworkComponentGroup
- getNetworkHardware
  
  @ApiMethod(instanceRequired=true) List<Hardware> getNetworkHardware()
  
  All network devices in SoftLayer's network hierarchy that this device is connected to.
  
  See Also:
  
  SoftLayer_Network_Component::getNetworkHardware
- getNetworkVlan
  
  @ApiMethod(instanceRequired=true) Vlan getNetworkVlan()
  
  The VLAN that a network component's subnet is associated with.
  
  See Also:
  
  SoftLayer_Network_Component::getNetworkVlan
- getNetworkVlanTrunks
  
  @ApiMethod(instanceRequired=true) List<Trunk> getNetworkVlanTrunks()
  
  The VLANs that are trunked to this network component.
  
  See Also:
  
  SoftLayer_Network_Component::getNetworkVlanTrunks
- getPrimaryIpAddressRecord
  
  @ApiMethod(instanceRequired=true) IpAddress getPrimaryIpAddressRecord()
  
  The primary IPv4 Address record for a network component.
  
  See Also:
  
  SoftLayer_Network_Component::getPrimaryIpAddressRecord
- getPrimarySubnet
  
  @ApiMethod(instanceRequired=true) Subnet getPrimarySubnet()
  
  The subnet of the primary IP address assigned to this network component.
  
  See Also:
  
  SoftLayer_Network_Component::getPrimarySubnet
- getPrimaryVersion6IpAddressRecord
  
  @ApiMethod(instanceRequired=true) IpAddress getPrimaryVersion6IpAddressRecord()
  
  The primary IPv6 Address record for a network component.
  
  See Also:
  
  SoftLayer_Network_Component::getPrimaryVersion6IpAddressRecord
- getRecentCommands
  
  @ApiMethod(instanceRequired=true) List<Request> getRecentCommands()
  
  The last five reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) commands issued to the server's remote management card.
  
  See Also:
  
  SoftLayer_Network_Component::getRecentCommands
- getRedundancyCapableFlag
  
  @ApiMethod(instanceRequired=true) Boolean getRedundancyCapableFlag()
  
  Indicates whether the network component is participating in a group of two or more components capable of being operationally redundant, if enabled.
  
  See Also:
  
  SoftLayer_Network_Component::getRedundancyCapableFlag
- getRedundancyEnabledFlag
  
  @ApiMethod(instanceRequired=true) Boolean getRedundancyEnabledFlag()
  
  Indicates whether the network component is participating in a group of two or more components which is actively providing link redundancy.
  
  See Also:
  
  SoftLayer_Network_Component::getRedundancyEnabledFlag
- getRemoteManagementUsers
  
  @ApiMethod(instanceRequired=true) List<User> getRemoteManagementUsers()
  
  User(s) credentials to issue commands and/or interact with the server's remote management card.
  
  See Also:
  
  SoftLayer_Network_Component::getRemoteManagementUsers
- getRouter
  
  @ApiMethod(instanceRequired=true) Hardware getRouter()
  
  A network component's routers.
  
  See Also:
  
  SoftLayer_Network_Component::getRouter
- getStorageNetworkFlag
  
  @ApiMethod(instanceRequired=true) Boolean getStorageNetworkFlag()
  
  Whether a network component's primary ip address is from a storage network subnet or not. [Deprecated]
  
  See Also:
  
  SoftLayer_Network_Component::getStorageNetworkFlag
- getSubnets
  
  @ApiMethod(instanceRequired=true) List<Subnet> getSubnets()
  
  A network component's subnets. A subnet is a group of IP addresses
  
  See Also:
  
  SoftLayer_Network_Component::getSubnets
- getUplinkComponent
  
  @ApiMethod(instanceRequired=true) Component getUplinkComponent()
  
  The network component linking this object to parent
  
  See Also:
  
  SoftLayer_Network_Component::getUplinkComponent
- getUplinkDuplexMode
  
  @ApiMethod(instanceRequired=true) Mode getUplinkDuplexMode()
  
  The duplex mode of the uplink network component linking to this object
  
  See Also:
  
  SoftLayer_Network_Component::getUplinkDuplexMode

Interface Component.Service

Method Summary

Methods inherited from interface com.softlayer.api.Maskable

Methods inherited from interface com.softlayer.api.ResultLimitable

Method Details