All Superinterfaces:

Maskable, ResultLimitable, Service

All Known Subinterfaces:

Router.Service, SecurityModule.Service, SecurityModule750.Service, Server.Service

Enclosing class:

Hardware
```
@ApiService("SoftLayer_Hardware")
public static interface Hardware.Service
extends Service
```
Every SoftLayer hardware is defined in the SoftLayer_Hardware service. SoftLayer hardware has network components, software, monitoring services such as network monitoring, and hardware components such as hard drives. The SoftLayer_Hardware service is a convenient way to obtain general information about your SoftLayer hardware. Use the data returned by these methods with other API services to get more detailed information about your services and to make changes to your servers and services.

See Also:

SoftLayer_Hardware

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Boolean`	`allowAccessToNetworkStorage(Storage networkStorageTemplateObject)`	This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.
`Boolean`	`allowAccessToNetworkStorageList(List<Storage> networkStorageTemplateObjects)`	This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.
`Hardware.ServiceAsync`	`asAsync()`	Get an async version of this service
`Group`	`captureImage(Template captureTemplate)`	Captures an Image of the hard disk on the physical machine, based on the capture template parameter.
`Hardware`	`createObject(Hardware templateObject)`	createObject() enables the creation of servers on an account.
`Boolean`	`deleteObject()`	This method will cancel a server effective immediately.
`Boolean`	`deleteSoftwareComponentPasswords(List<Password> softwareComponentPasswords)`	Delete software component passwords.
`Boolean`	`deleteTag(String tagName)`	Delete an existing tag.
`Boolean`	`editSoftwareComponentPasswords(List<Password> softwareComponentPasswords)`	Edit the properties of a software component password such as the username, password, and notes.
`Void`	`executeRemoteScript(String uri)`	Download and run remote script from uri on the hardware.
`Hardware`	`findByIpAddress(String ipAddress)`	The '''findByIpAddress''' method finds hardware using its primary public or private IP address.
`Order`	`generateOrderTemplate(Hardware templateObject)`	Obtain an [[SoftLayer_Container_Product_Order_Hardware_Server (type)\|order container]] that can be sent to [[SoftLayer_Product_Order/verifyOrder\|verifyOrder]] or [[SoftLayer_Product_Order/placeOrder\|placeOrder]].
`Account`	`getAccount()`	The account associated with a piece of hardware.
`List<Component>`	`getActiveComponents()`	A piece of hardware's active physical components.
`List<Incident>`	`getActiveNetworkMonitorIncident()`	A piece of hardware's active network monitoring incidents.
`Host`	`getAllowedHost()`	The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.
`List<Storage>`	`getAllowedNetworkStorage()`	The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
`List<Storage>`	`getAllowedNetworkStorageReplicas()`	The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
`List<Component>`	`getAllPowerComponents()`
`Component`	`getAntivirusSpywareSoftwareComponent()`	Information regarding an antivirus/spyware software component object.
`List<Storage>`	`getAttachedNetworkStorages(String nasType)`	This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Hardware.
`List<Attribute>`	`getAttributes()`	Information regarding a piece of hardware's specific attributes.
`List<Price>`	`getAvailableBillingTermChangePrices()`	Retrieves a list of available term prices to this hardware.
`List<Storage>`	`getAvailableNetworkStorages(String nasType)`	This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Hardware.
`BigDecimal`	`getAverageDailyPublicBandwidthUsage()`	The average daily public bandwidth usage for the current billing cycle.
`BigDecimal`	`getBackendIncomingBandwidth(GregorianCalendar startDate, GregorianCalendar endDate)`	The '''getBackendIncomingBandwidth''' method retrieves the amount of incoming private network traffic used between the given start date and end date parameters.
`List<Component>`	`getBackendNetworkComponents()`	A piece of hardware's back-end or private network components.
`BigDecimal`	`getBackendOutgoingBandwidth(GregorianCalendar startDate, GregorianCalendar endDate)`	The '''getBackendOutgoingBandwidth''' method retrieves the amount of outgoing private network traffic used between the given start date and end date parameters.
`List<Hardware>`	`getBackendRouters()`	A hardware's backend or private router.
`BigDecimal`	`getBandwidthAllocation()`	A hardware's allotted bandwidth (measured in GB).
`Detail`	`getBandwidthAllotmentDetail()`	A hardware's allotted detail record.
`List<Certification>`	`getBenchmarkCertifications()`	Information regarding a piece of hardware's benchmark certifications.
`Hardware`	`getBillingItem()`	Information regarding the billing item for a server.
`Boolean`	`getBillingItemFlag()`	A flag indicating that a billing item exists.
`Boolean`	`getBlockCancelBecauseDisconnectedFlag()`	Determines whether the hardware is ineligible for cancellation because it is disconnected.
`Boolean`	`getBusinessContinuanceInsuranceFlag()`	Status indicating whether or not a piece of hardware has business continuance insurance.
`List<Hardware>`	`getChildrenHardware()`	Child hardware.
`String`	`getComponentDetailsXML()`
`List<Component>`	`getComponents()`	A piece of hardware's components.
`Component`	`getContinuousDataProtectionSoftwareComponent()`	A continuous data protection/server backup software component object.
`Configuration`	`getCreateObjectOptions()`	There are many options that may be provided while ordering a server, this method can be used to determine what these options are.
`BigDecimal`	`getCurrentBillableBandwidthUsage()`	The current billable public outbound bandwidth for this hardware for the current billing cycle.
`List<Item>`	`getCurrentBillingDetail()`	Get the billing detail for this hardware for the current billing period.
`BigDecimal`	`getCurrentBillingTotal()`	Get the total bill amount in US Dollars ($) for this hardware in the current billing period.
`BigDecimal`	`getDailyAverage(GregorianCalendar startDate, GregorianCalendar endDate)`	The '''getDailyAverage''' method calculates the average daily network traffic used by the selected server.
`Location`	`getDatacenter()`	Information regarding the datacenter in which a piece of hardware resides.
`String`	`getDatacenterName()`	The name of the datacenter in which a piece of hardware resides.
`Long`	`getDaysInSparePool()`	Number of day(s) a server have been in spare pool.
`List<Hardware>`	`getDownlinkHardware()`	All hardware that has uplink network connections to a piece of hardware.
`List<Hardware>`	`getDownlinkNetworkHardware()`	All hardware that has uplink network connections to a piece of hardware.
`List<Hardware>`	`getDownlinkServers()`	Information regarding all servers attached to a piece of network hardware.
`List<Guest>`	`getDownlinkVirtualGuests()`	Information regarding all virtual guests attached to a piece of network hardware.
`List<Hardware>`	`getDownstreamHardwareBindings()`	All hardware downstream from a network device.
`List<Hardware>`	`getDownstreamNetworkHardware()`	All network hardware downstream from the selected piece of hardware.
`List<Hardware>`	`getDownstreamNetworkHardwareWithIncidents()`	All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware.
`List<Hardware>`	`getDownstreamServers()`	Information regarding all servers attached downstream to a piece of network hardware.
`List<Guest>`	`getDownstreamVirtualGuests()`	Information regarding all virtual guests attached to a piece of network hardware.
`List<Component>`	`getDriveControllers()`	The drive controllers contained within a piece of hardware.
`List<Storage>`	`getEvaultNetworkStorage()`	Information regarding a piece of hardware's associated EVault network storage service account.
`Firewall`	`getFirewallServiceComponent()`	Information regarding a piece of hardware's firewall services.
`Preset`	`getFixedConfigurationPreset()`	Defines the fixed components in a fixed configuration bare metal server.
`BigDecimal`	`getFrontendIncomingBandwidth(GregorianCalendar startDate, GregorianCalendar endDate)`	The '''getFrontendIncomingBandwidth''' method retrieves the amount of incoming public network traffic used by a server between the given start and end date parameters.
`List<Component>`	`getFrontendNetworkComponents()`	A piece of hardware's front-end or public network components.
`BigDecimal`	`getFrontendOutgoingBandwidth(GregorianCalendar startDate, GregorianCalendar endDate)`	The '''getFrontendOutgoingBandwidth''' method retrieves the amount of outgoing public network traffic used by a server between the given start and end date parameters.
`List<Hardware>`	`getFrontendRouters()`	A hardware's frontend or public router.
`Hardware`	`getFutureBillingItem()`	Information regarding the future billing item for a server.
`String`	`getGlobalIdentifier()`	A hardware's universally unique identifier.
`List<Component>`	`getHardDrives()`	The hard drives contained within a piece of hardware.
`Chassis`	`getHardwareChassis()`	The chassis that a piece of hardware is housed in.
`Function`	`getHardwareFunction()`	A hardware's function.
`String`	`getHardwareFunctionDescription()`	A hardware's function.
`State`	`getHardwareState()`	A hardware's power/transaction state.
`Status`	`getHardwareStatus()`	A hardware's status.
`Boolean`	`getHasTrustedPlatformModuleBillingItemFlag()`	Determine in hardware object has TPM enabled.
`Component`	`getHostIpsSoftwareComponent()`	Information regarding a host IPS software component object.
`List<Data>`	`getHourlyBandwidth(String mode, GregorianCalendar day)`	The '''getHourlyBandwidth''' method retrieves all bandwidth updates hourly for the specified hardware.
`Boolean`	`getHourlyBillingFlag()`	A server's hourly billing status.
`BigDecimal`	`getInboundBandwidthUsage()`	The sum of all the inbound network traffic data for the last 30 days.
`BigDecimal`	`getInboundPublicBandwidthUsage()`	The total public inbound bandwidth for this hardware for the current billing cycle.
`Boolean`	`getIsBillingTermChangeAvailableFlag()`	Whether or not this hardware object is eligible to change to term billing.
`Transaction`	`getLastTransaction()`	Information regarding the last transaction a server performed.
`Incident`	`getLatestNetworkMonitorIncident()`	A piece of hardware's latest network monitoring incident.
`Location`	`getLocation()`	Where a piece of hardware is located within SoftLayer's location hierarchy.
`String`	`getLocationPathString()`
`Storage`	`getLockboxNetworkStorage()`	Information regarding a lockbox account associated with a server.
`Boolean`	`getManagedResourceFlag()`	A flag indicating that the hardware is a managed resource.
`List<Component>`	`getMemory()`	Information regarding a piece of hardware's memory.
`Long`	`getMemoryCapacity()`	The amount of memory a piece of hardware has, measured in gigabytes.
`HardwareServer`	`getMetricTrackingObject()`	A piece of hardware's metric tracking object.
`List<Component>`	`getModules()`
`Robot`	`getMonitoringRobot()`
`Stratum`	`getMonitoringServiceComponent()`	Information regarding a piece of hardware's network monitoring services.
`Boolean`	`getMonitoringServiceEligibilityFlag()`
`Component`	`getMotherboard()`	Information regarding a piece of hardware's motherboard.
`List<Component>`	`getNetworkCards()`	Information regarding a piece of hardware's network cards.
`List<Component>`	`getNetworkComponents()`	Returns a hardware's network components.
`Member`	`getNetworkGatewayMember()`	The gateway member if this device is part of a network gateway.
`Boolean`	`getNetworkGatewayMemberFlag()`	Whether or not this device is part of a network gateway.
`String`	`getNetworkManagementIpAddress()`	A piece of hardware's network management IP address.
`List<Hardware>`	`getNetworkMonitorAttachedDownHardware()`	All servers with failed monitoring that are attached downstream to a piece of hardware.
`List<Guest>`	`getNetworkMonitorAttachedDownVirtualGuests()`	Virtual guests that are attached downstream to a hardware that have failed monitoring
`List<Incident>`	`getNetworkMonitorIncidents()`	The status of all of a piece of hardware's network monitoring incidents.
`List<Host>`	`getNetworkMonitors()`	Information regarding a piece of hardware's network monitors.
`String`	`getNetworkStatus()`	The value of a hardware's network status attribute.
`Attribute`	`getNetworkStatusAttribute()`	The hardware's related network status attribute.
`List<Storage>`	`getNetworkStorage()`	Information regarding a piece of hardware's associated network storage service account.
`List<Vlan>`	`getNetworkVlans()`	The network virtual LANs (VLANs) associated with a piece of hardware's network components.
`BigDecimal`	`getNextBillingCycleBandwidthAllocation()`	A hardware's allotted bandwidth for the next billing cycle (measured in GB).
`List<Note>`	`getNotesHistory()`
`Long`	`getNvRamCapacity()`	The amount of non-volatile memory a piece of hardware has, measured in gigabytes.
`List<Model>`	`getNvRamComponentModels()`
`Hardware`	`getObject()`	getObject retrieves the SoftLayer_Hardware object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware service.
`OperatingSystem`	`getOperatingSystem()`	Information regarding a piece of hardware's operating system.
`String`	`getOperatingSystemReferenceCode()`	A hardware's operating system software description.
`BigDecimal`	`getOutboundBandwidthUsage()`	The sum of all the outbound network traffic data for the last 30 days.
`BigDecimal`	`getOutboundPublicBandwidthUsage()`	The total public outbound bandwidth for this hardware for the current billing cycle.
`Blade`	`getParentBay()`	Blade Bay
`Hardware`	`getParentHardware()`	Parent Hardware.
`Location`	`getPointOfPresenceLocation()`	Information regarding the Point of Presence (PoP) location in which a piece of hardware resides.
`List<Component>`	`getPowerComponents()`	The power components for a hardware object.
`List<Component>`	`getPowerSupply()`	Information regarding a piece of hardware's power supply.
`String`	`getPrimaryBackendIpAddress()`	The hardware's primary private IP address.
`Component`	`getPrimaryBackendNetworkComponent()`	Information regarding the hardware's primary back-end network component.
`String`	`getPrimaryIpAddress()`	The hardware's primary public IP address.
`Component`	`getPrimaryNetworkComponent()`	Information regarding the hardware's primary public network component.
`List<Data>`	`getPrivateBandwidthData(Long startTime, Long endTime)`	Retrieve a graph of a server's private network bandwidth usage over the specified timeframe.
`Boolean`	`getPrivateNetworkOnlyFlag()`	Whether the hardware only has access to the private network.
`Long`	`getProcessorCoreAmount()`	The total number of processor cores, summed from all processors that are attached to a piece of hardware
`Long`	`getProcessorPhysicalCoreAmount()`	The total number of physical processor cores, summed from all processors that are attached to a piece of hardware
`List<Component>`	`getProcessors()`	Information regarding a piece of hardware's processors.
`List<Data>`	`getPublicBandwidthData(Long startTime, Long endTime)`	Retrieve a graph of a server's public network bandwidth usage over the specified timeframe.
`Location`	`getRack()`
`List<Component>`	`getRaidControllers()`	The RAID controllers contained within a piece of hardware.
`List<Event>`	`getRecentEvents()`	Recent events that impact this hardware.
`List<User>`	`getRemoteManagementAccounts()`	User credentials to issue commands and/or interact with the server's remote management card.
`Component`	`getRemoteManagementComponent()`	A hardware's associated remote management component.
`List<Configuration>`	`getResourceConfigurations()`
`List<Member>`	`getResourceGroupMemberReferences()`
`List<Role>`	`getResourceGroupRoles()`
`List<Group>`	`getResourceGroups()`	The resource groups in which this hardware is a member.
`List<Hardware>`	`getRouters()`	A hardware's routers.
`List<Asset>`	`getScaleAssets()`	Collection of scale assets this hardware corresponds to.
`List<Request>`	`getSecurityScanRequests()`	Information regarding a piece of hardware's vulnerability scan requests.
`List<SensorReading>`	`getSensorData()`	The '''getSensorData''' method retrieves a server's hardware state via its internal sensors.
`SensorReadingsWithGraphs`	`getSensorDataWithGraphs()`	The '''getSensorDataWithGraphs''' method retrieves the raw data returned from the server's remote management card.
`List<SensorSpeed>`	`getServerFanSpeedGraphs()`	The '''getServerFanSpeedGraphs''' method retrieves the server's fan speeds and displays the speeds using tachometer graphs.
`String`	`getServerPowerState()`	The '''getPowerState''' method retrieves the power state for the selected server.
`Location`	`getServerRoom()`	Information regarding the server room in which the hardware is located.
`List<SensorTemperature>`	`getServerTemperatureGraphs()`	The '''getServerTemperatureGraphs''' retrieves the server's temperatures and displays the various temperatures using thermometer graphs.
`Provider`	`getServiceProvider()`	Information regarding the piece of hardware's service provider.
`List<Component>`	`getSoftwareComponents()`	Information regarding a piece of hardware's installed software.
`Hardware`	`getSparePoolBillingItem()`	Information regarding the billing item for a spare pool server.
`List<Key>`	`getSshKeys()`	SSH keys to be installed on the server during provisioning or an OS reload.
`List<Group>`	`getStorageGroups()`
`List<Component>`	`getStorageNetworkComponents()`	A piece of hardware's private storage network components.
`List<Reference>`	`getTagReferences()`
`Location`	`getTopLevelLocation()`
`List<History>`	`getTransactionHistory()`	This method will query transaction history for a piece of hardware.
`List<Price>`	`getUpgradeItemPrices()`	Retrieve a list of upgradeable items available to this piece of hardware.
`Request`	`getUpgradeRequest()`	An account's associated upgrade request object, if any.
`Hardware`	`getUplinkHardware()`	The network device connected to a piece of hardware.
`List<Component>`	`getUplinkNetworkComponents()`	Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.
`List<Attribute>`	`getUserData()`	An array containing a single string of custom user data for a hardware order.
`Group`	`getVirtualChassis()`	Information regarding the virtual chassis for a piece of hardware.
`List<Hardware>`	`getVirtualChassisSiblings()`	Information regarding the virtual chassis siblings for a piece of hardware.
`Host`	`getVirtualHost()`	A piece of hardware's virtual host record.
`Component`	`getVirtualizationPlatform()`	A piece of hardware's virtualization platform software.
`List<VirtualLicense>`	`getVirtualLicenses()`	Information regarding a piece of hardware's virtual software licenses.
`Allotment`	`getVirtualRack()`	Information regarding the bandwidth allotment to which a piece of hardware belongs.
`Long`	`getVirtualRackId()`	The name of the bandwidth allotment belonging to a piece of hardware.
`String`	`getVirtualRackName()`	The name of the bandwidth allotment belonging to a piece of hardware.
`Host`	`importVirtualHost()`	The '''importVirtualHost''' method attempts to import the host record for the virtualization platform running on a server.
`Boolean`	`isPingable()`	The '''isPingable''' method issues a ping command to the selected server and returns the result of the ping command.
`String`	`ping()`	Issues a ping command to the server and returns the ping response.
`Boolean`	`powerCycle()`	The '''powerCycle''' method completes a power off and power on of the server successively in one command.
`Boolean`	`powerOff()`	This method will power off the server via the server's remote management card.
`Boolean`	`powerOn()`	The '''powerOn''' method powers on a server via its remote management card.
`Boolean`	`rebootDefault()`	The '''rebootDefault''' method attempts to reboot the server by issuing a soft reboot, or reset, command to the server's remote management card.
`Boolean`	`rebootHard()`	The '''rebootHard''' method reboots the server by issuing a cycle command to the server's remote management card.
`Boolean`	`rebootSoft()`	The '''rebootSoft''' method reboots the server by issuing a reset command to the server's remote management card via soft reboot.
`Boolean`	`removeAccessToNetworkStorage(Storage networkStorageTemplateObject)`	This method is used to remove access to s SoftLayer_Network_Storage volumes that supports host- or network-level access control.
`Boolean`	`removeAccessToNetworkStorageList(List<Storage> networkStorageTemplateObjects)`	This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.
`Boolean`	`removeTags(String tags)`
`void`	`setMask(Hardware.Mask mask)`
`Boolean`	`setTags(String tags)`
`Boolean`	`updateIpmiPassword(String password)`	This method will update the root IPMI password on this SoftLayer_Hardware.
`Hardware.Mask`	`withMask()`	Use the existing mask on this service or create it if not present
`Hardware.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 Detail
  - asAsync
```
Hardware.ServiceAsync asAsync()
```
    Description copied from interface: Service
    
    Get an async version of this service
    
    Specified by:
    
    asAsync in interface Service
  - withNewMask
```
Hardware.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
```
Hardware.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(Hardware.Mask mask)
```
  - allowAccessToNetworkStorage
```
@ApiMethod(instanceRequired=true)
Boolean allowAccessToNetworkStorage(Storage networkStorageTemplateObject)
```
    This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.
    
    See Also:
    
    SoftLayer_Hardware::allowAccessToNetworkStorage
  - allowAccessToNetworkStorageList
```
@ApiMethod(instanceRequired=true)
Boolean allowAccessToNetworkStorageList(List<Storage> networkStorageTemplateObjects)
```
    This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.
    
    See Also:
    
    SoftLayer_Hardware::allowAccessToNetworkStorageList
  - captureImage
```
@ApiMethod(instanceRequired=true)
Group captureImage(Template captureTemplate)
```
    Captures an Image of the hard disk on the physical machine, based on the capture template parameter. Returns the image template group containing the disk image.
    
    See Also:
    
    SoftLayer_Hardware::captureImage
  - createObject
```
@ApiMethod
Hardware createObject(Hardware templateObject)
```
    createObject() enables the creation of servers on an account. This
    method is a simplified alternative to interacting with the ordering system directly.
    
    In order to create a server, a template object must be sent in with a few required
    values.
    
    When this method returns an order will have been placed for a server of the specified configuration.
    
    To determine when the server is available you can poll the server via [[SoftLayer_Hardware/getObject|getObject]],
    checking the provisionDate property.
    When provisionDate is not null, the server will be ready. Be sure to use the globalIdentifier
    as your initialization parameter.
    
    Warning: Servers created via this method will incur charges on your account. For testing input parameters see [[SoftLayer_Hardware/generateOrderTemplate|generateOrderTemplate]].
    
    Input - [[SoftLayer_Hardware (type)|SoftLayer_Hardware]]
    
    hostname
    
    Hostname for the server.
    
    Required
    
    Type - string
    
    domain
    
    Domain for the server.
    
    Required
    
    Type - string
    
    processorCoreAmount
    
    The number of logical CPU cores to allocate.
    
    Required
    
    Type - int
    
    See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
    
    memoryCapacity
    
    The amount of memory to allocate in gigabytes.
    
    Required
    
    Type - int
    
    See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
    
    hourlyBillingFlag
    
    Specifies the billing type for the server.
    
    Required
    
    Type - boolean
    
    When true the server will be billed on hourly usage, otherwise it will be billed on a monthly basis.
    
    operatingSystemReferenceCode
    
    An identifier for the operating system to provision the server with.
    
    Required
    
    Type - string
    
    See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
    
    datacenter.name
    
    Specifies which datacenter the server is to be provisioned in.
    
    Required
    
    Type - string
    
    The datacenter property is a [[SoftLayer_Location (type)|location]] structure with the name field set.
    
    See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
    
    {
    "datacenter": {
    "name": "dal05"
    }
    }
    
    networkComponents.maxSpeed
    
    Specifies the connection speed for the server's network components.
    
    Optional
    
    Type - int
    
    Default - The highest available zero cost port speed will be used.
    
    Description - The networkComponents property is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. The maxSpeed property must be set to specify the network uplink speed, in megabits per second, of the server.
    
    See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
    
    {
    "networkComponents": [
    {
    "maxSpeed": 1000
    }
    ]
    }
    
    networkComponents.redundancyEnabledFlag
    
    Specifies whether or not the server's network components should be in redundancy groups.
    
    Optional
    
    Type - bool
    
    Default - false
    
    Description - The networkComponents property is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. When the redundancyEnabledFlag property is true the server's network components will be in redundancy groups.
    
    {
    "networkComponents": [
    {
    "redundancyEnabledFlag": false
    }
    ]
    }
    
    privateNetworkOnlyFlag
    
    Specifies whether or not the server only has access to the private network
    
    Optional
    
    Type - boolean
    
    Default - false
    
    When true this flag specifies that a server is to only have access to the private network.
    
    primaryNetworkComponent.networkVlan.id
    
    Specifies the network vlan which is to be used for the frontend interface of the server.
    
    Optional
    
    Type - int
    
    Description - The primaryNetworkComponent property is a [[SoftLayer_Network_Component (type)|network component]] structure with the networkVlan property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. The id property must be set to specify the frontend network vlan of the server.
    
    {
    "primaryNetworkComponent": {
    "networkVlan": {
    "id": 1
    }
    }
    }
    
    primaryBackendNetworkComponent.networkVlan.id
    
    Specifies the network vlan which is to be used for the backend interface of the server.
    
    Optional
    
    Type - int
    
    Description - The primaryBackendNetworkComponent property is a [[SoftLayer_Network_Component (type)|network component]] structure with the networkVlan property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. The id property must be set to specify the backend network vlan of the server.
    
    {
    "primaryBackendNetworkComponent": {
    "networkVlan": {
    "id": 2
    }
    }
    }
    
    fixedConfigurationPreset.keyName
    
    Optional
    
    Type - string
    
    Description - The fixedConfigurationPreset property is a [[SoftLayer_Product_Package_Preset (type)|fixed configuration preset]] structure. The keyName property must be set to specify preset to use.
    
    If a fixed configuration preset is used processorCoreAmount, memoryCapacity and hardDrives properties must not be set.
    
    See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
    
    {
    "fixedConfigurationPreset": {
    "keyName": "SOME_KEY_NAME"
    }
    }
    
    userData.value
    
    Arbitrary data to be made available to the server.
    
    Optional
    
    Type - string
    
    Description - The userData property is an array with a single [[SoftLayer_Hardware_Attribute (type)|attribute]] structure with the value property set to an arbitrary value.
    
    This value can be retrieved via the [[SoftLayer_Resource_Metadata/getUserMetadata|getUserMetadata]] method from a request originating from the server. This is primarily useful for providing data to software that may be on the server and configured to execute upon first boot.
    
    {
    "userData": [
    {
    "value": "someValue"
    }
    ]
    }
    
    hardDrives
    
    Hard drive settings for the server
    
    Optional
    
    Type - SoftLayer_Hardware_Component
    
    Default - The largest available capacity for a zero cost primary disk will be used.
    
    Description - The hardDrives property is an array of [[SoftLayer_Hardware_Component (type)|hardware component]] structures.
    
    Each hard drive must specify the capacity property.
    
    See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
    
    {
    "hardDrives": [
    {
    "capacity": 500
    }
    ]
    }
    
    sshKeys
    
    SSH keys to install on the server upon provisioning.
    
    Optional
    
    Type - array of [[SoftLayer_Security_Ssh_Key (type)|SoftLayer_Security_Ssh_Key]]
    
    Description - The sshKeys property is an array of [[SoftLayer_Security_Ssh_Key (type)|SSH Key]] structures with the id property set to the value of an existing SSH key.
    
    To create a new SSH key, call [[SoftLayer_Security_Ssh_Key/createObject|createObject]] on the [[SoftLayer_Security_Ssh_Key]] service.
    
    To obtain a list of existing SSH keys, call [[SoftLayer_Account/getSshKeys|getSshKeys]] on the [[SoftLayer_Account]] service.
    
    {
    "sshKeys": [
    {
    "id": 123
    }
    ]
    }
    
    postInstallScriptUri
    
    Specifies the uri location of the script to be downloaded and run after installation is complete.
    
    Optional
    
    Type - string
    
    REST Example
    
    curl -X POST -d '{
    "parameters":[
    {
    "hostname": "host1",
    "domain": "example.com",
    "processorCoreAmount": 2,
    "memoryCapacity": 2,
    "hourlyBillingFlag": true,
    "operatingSystemReferenceCode": "UBUNTU_LATEST"
    }
    ]
    }' https://api.softlayer.com/rest/v3/SoftLayer_Hardware.json
    
    HTTP/1.1 201 Created
    Location: https://api.softlayer.com/rest/v3/SoftLayer_Hardware/f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5/getObject
    
    {
    "accountId": 232298,
    "bareMetalInstanceFlag": null,
    "domain": "example.com",
    "hardwareStatusId": null,
    "hostname": "host1",
    "id": null,
    "serviceProviderId": null,
    "serviceProviderResourceId": null,
    "globalIdentifier": "f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5",
    "hourlyBillingFlag": true,
    "memoryCapacity": 2,
    "operatingSystemReferenceCode": "UBUNTU_LATEST",
    "processorCoreAmount": 2
    }
    See Also:
    
    SoftLayer_Hardware::createObject
  - deleteObject
```
@ApiMethod(instanceRequired=true)
Boolean deleteObject()
```
    This method will cancel a server effective immediately. For servers billed hourly, the charges will stop immediately after the method returns.
    
    See Also:
    
    SoftLayer_Hardware::deleteObject
  - deleteSoftwareComponentPasswords
```
@ApiMethod(instanceRequired=true)
Boolean deleteSoftwareComponentPasswords(List<Password> softwareComponentPasswords)
```
    Delete software component passwords.
    
    See Also:
    
    SoftLayer_Hardware::deleteSoftwareComponentPasswords
  - deleteTag
```
@ApiMethod(instanceRequired=true)
Boolean deleteTag(String tagName)
```
    Delete an existing tag. If there are any references on the tag, an exception will be thrown.
    
    See Also:
    
    SoftLayer_Hardware::deleteTag
  - editSoftwareComponentPasswords
```
@ApiMethod(instanceRequired=true)
Boolean editSoftwareComponentPasswords(List<Password> softwareComponentPasswords)
```
    Edit the properties of a software component password such as the username, password, and notes.
    
    See Also:
    
    SoftLayer_Hardware::editSoftwareComponentPasswords
  - executeRemoteScript
```
@ApiMethod(instanceRequired=true)
Void executeRemoteScript(String uri)
```
    Download and run remote script from uri on the hardware.
    
    See Also:
    
    SoftLayer_Hardware::executeRemoteScript
  - findByIpAddress
```
@ApiMethod
Hardware findByIpAddress(String ipAddress)
```
    The '''findByIpAddress''' method finds hardware using its primary public or private IP address. IP addresses that have a secondary subnet tied to the hardware will not return the hardware. If no hardware is found, no errors are generated and no data is returned.
    
    See Also:
    
    SoftLayer_Hardware::findByIpAddress
  - generateOrderTemplate
```
@ApiMethod
Order generateOrderTemplate(Hardware templateObject)
```
    Obtain an [[SoftLayer_Container_Product_Order_Hardware_Server (type)|order container]] that can be sent to [[SoftLayer_Product_Order/verifyOrder|verifyOrder]] or [[SoftLayer_Product_Order/placeOrder|placeOrder]].
    
    This is primarily useful when there is a necessity to confirm the price which will be charged for an order.
    
    See [[SoftLayer_Hardware/createObject|createObject]] for specifics on the requirements of the template object parameter.
    
    See Also:
    
    SoftLayer_Hardware::generateOrderTemplate
  - getAttachedNetworkStorages
```
@ApiMethod(instanceRequired=true)
List<Storage> getAttachedNetworkStorages(String nasType)
```
    This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Hardware.
    
    See Also:
    
    SoftLayer_Hardware::getAttachedNetworkStorages
  - getAvailableBillingTermChangePrices
```
@ApiMethod(instanceRequired=true)
List<Price> getAvailableBillingTermChangePrices()
```
    Retrieves a list of available term prices to this hardware. Currently, price terms are only available for increasing term length to monthly billed servers.
    
    See Also:
    
    SoftLayer_Hardware::getAvailableBillingTermChangePrices
  - getAvailableNetworkStorages
```
@ApiMethod(instanceRequired=true)
List<Storage> getAvailableNetworkStorages(String nasType)
```
    This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Hardware.
    
    See Also:
    
    SoftLayer_Hardware::getAvailableNetworkStorages
  - getBackendIncomingBandwidth
```
@ApiMethod(instanceRequired=true)
BigDecimal getBackendIncomingBandwidth(GregorianCalendar startDate,
                                       GregorianCalendar endDate)
```
    The '''getBackendIncomingBandwidth''' method retrieves the amount of incoming private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.
    
    See Also:
    
    SoftLayer_Hardware::getBackendIncomingBandwidth
  - getBackendOutgoingBandwidth
```
@ApiMethod(instanceRequired=true)
BigDecimal getBackendOutgoingBandwidth(GregorianCalendar startDate,
                                       GregorianCalendar endDate)
```
    The '''getBackendOutgoingBandwidth''' method retrieves the amount of outgoing private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.
    
    See Also:
    
    SoftLayer_Hardware::getBackendOutgoingBandwidth
  - getComponentDetailsXML
```
@ApiMethod(instanceRequired=true)
String getComponentDetailsXML()
```
    See Also:
    
    SoftLayer_Hardware::getComponentDetailsXML
  - getCreateObjectOptions
```
@ApiMethod
Configuration getCreateObjectOptions()
```
    There are many options that may be provided while ordering a server, this method can be used to determine what these options are.
    
    Detailed information on the return value can be found on the data type page for [[SoftLayer_Container_Hardware_Configuration (type)]].
    
    See Also:
    
    SoftLayer_Hardware::getCreateObjectOptions
  - getCurrentBillingDetail
```
@ApiMethod(instanceRequired=true)
List<Item> getCurrentBillingDetail()
```
    Get the billing detail for this hardware for the current billing period. This does not include bandwidth usage.
    
    See Also:
    
    SoftLayer_Hardware::getCurrentBillingDetail
  - getCurrentBillingTotal
```
@ApiMethod(instanceRequired=true)
BigDecimal getCurrentBillingTotal()
```
    Get the total bill amount in US Dollars ($) for this hardware in the current billing period. This includes all bandwidth used up to the point the method is called on the hardware.
    
    See Also:
    
    SoftLayer_Hardware::getCurrentBillingTotal
  - getDailyAverage
```
@ApiMethod(instanceRequired=true)
BigDecimal getDailyAverage(GregorianCalendar startDate,
                           GregorianCalendar endDate)
```
    The '''getDailyAverage''' method calculates the average daily network traffic used by the selected server. Using the required parameter ''dateTime'' to enter a start and end date, the user retrieves this average, measure in gigabytes (GB) for the specified date range. When entering parameters, only the month, day and year are required - time entries are omitted as this method defaults the time to midnight in order to account for the entire day.
    
    See Also:
    
    SoftLayer_Hardware::getDailyAverage
  - getFrontendIncomingBandwidth
```
@ApiMethod(instanceRequired=true)
BigDecimal getFrontendIncomingBandwidth(GregorianCalendar startDate,
                                        GregorianCalendar endDate)
```
    The '''getFrontendIncomingBandwidth''' method retrieves the amount of incoming public network traffic used by a server between the given start and end date parameters. When entering the ''dateTime'' parameter, only the month, day and year of the start and end dates are required - the time (hour, minute and second) are set to midnight by default and cannot be changed. The amount of bandwidth retrieved is measured in gigabytes (GB).
    
    See Also:
    
    SoftLayer_Hardware::getFrontendIncomingBandwidth
  - getFrontendOutgoingBandwidth
```
@ApiMethod(instanceRequired=true)
BigDecimal getFrontendOutgoingBandwidth(GregorianCalendar startDate,
                                        GregorianCalendar endDate)
```
    The '''getFrontendOutgoingBandwidth''' method retrieves the amount of outgoing public network traffic used by a server between the given start and end date parameters. The ''dateTime'' parameter requires only the day, month and year to be entered - the time (hour, minute and second) are set to midnight be default in order to gather the data for the entire start and end date indicated in the parameter. The amount of bandwidth retrieved is measured in gigabytes (GB).
    
    See Also:
    
    SoftLayer_Hardware::getFrontendOutgoingBandwidth
  - getHourlyBandwidth
```
@ApiMethod(instanceRequired=true)
List<Data> getHourlyBandwidth(String mode,
                              GregorianCalendar day)
```
    The '''getHourlyBandwidth''' method retrieves all bandwidth updates hourly for the specified hardware. Because the potential number of data points can become excessive, the method limits the user to obtain data in 24-hour intervals. The required ''dateTime'' parameter is used as the starting point for the query and will be calculated for the 24-hour period starting with the specified date and time. For example, entering a parameter of
    
    '02/01/2008 0:00'
    
    results in a return of all bandwidth data for the entire day of February 1, 2008, as 0:00 specifies a midnight start date. Please note that the time entered should be completed using a 24-hour clock (military time, astronomical time).
    
    For data spanning more than a single 24-hour period, refer to the getBandwidthData function on the metricTrackingObject for the piece of hardware.
    
    See Also:
    
    SoftLayer_Hardware::getHourlyBandwidth
  - getObject
```
@ApiMethod(instanceRequired=true)
Hardware getObject()
```
    getObject retrieves the SoftLayer_Hardware object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware service. You can only retrieve the account that your portal user is assigned to.
    
    See Also:
    
    SoftLayer_Hardware::getObject
  - getPrivateBandwidthData
```
@ApiMethod(instanceRequired=true)
List<Data> getPrivateBandwidthData(Long startTime,
                                   Long endTime)
```
    Retrieve a graph of a server's private network bandwidth usage over the specified timeframe. If no timeframe is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPrivateBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels.
    
    See Also:
    
    SoftLayer_Hardware::getPrivateBandwidthData
  - getPublicBandwidthData
```
@ApiMethod(instanceRequired=true)
List<Data> getPublicBandwidthData(Long startTime,
                                  Long endTime)
```
    Retrieve a graph of a server's public network bandwidth usage over the specified timeframe. If no timeframe is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels.
    
    See Also:
    
    SoftLayer_Hardware::getPublicBandwidthData
  - getSensorData
```
@ApiMethod(instanceRequired=true)
List<SensorReading> getSensorData()
```
    The '''getSensorData''' method retrieves a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures various information, including system temperatures, voltages and other local server settings. Sensor data is cached for 30 second; calls made to this method for the same server within 30 seconds of each other will result in the same data being returned. To ensure that the data retrieved retrieves snapshot of varied data, make calls greater than 30 seconds apart.
    
    See Also:
    
    SoftLayer_Hardware::getSensorData
  - getSensorDataWithGraphs
```
@ApiMethod(instanceRequired=true)
SensorReadingsWithGraphs getSensorDataWithGraphs()
```
    The '''getSensorDataWithGraphs''' method retrieves the raw data returned from the server's remote management card. Along with raw data, graphs for the CPU and system temperatures and fan speeds are also returned. For more details on what information is returned, refer to the ''getSensorData'' method.
    
    See Also:
    
    SoftLayer_Hardware::getSensorDataWithGraphs
  - getServerFanSpeedGraphs
```
@ApiMethod(instanceRequired=true)
List<SensorSpeed> getServerFanSpeedGraphs()
```
    The '''getServerFanSpeedGraphs''' method retrieves the server's fan speeds and displays the speeds using tachometer graphs. data used to construct these graphs is retrieved from the server's remote management card. Each graph returned will have an associated title.
    
    See Also:
    
    SoftLayer_Hardware::getServerFanSpeedGraphs
  - getServerPowerState
```
@ApiMethod(instanceRequired=true)
String getServerPowerState()
```
    The '''getPowerState''' method retrieves the power state for the selected server. The server's power status is retrieved from its remote management card. This method returns "on", for a server that has been powered on, or "off" for servers powered off.
    
    See Also:
    
    SoftLayer_Hardware::getServerPowerState
  - getServerTemperatureGraphs
```
@ApiMethod(instanceRequired=true)
List<SensorTemperature> getServerTemperatureGraphs()
```
    The '''getServerTemperatureGraphs''' retrieves the server's temperatures and displays the various temperatures using thermometer graphs. Temperatures retrieved are CPU temperature(s) and system temperatures. Data used to construct the graphs is retrieved from the server's remote management card. All graphs returned will have an associated title.
    
    See Also:
    
    SoftLayer_Hardware::getServerTemperatureGraphs
  - getTransactionHistory
```
@ApiMethod(instanceRequired=true)
List<History> getTransactionHistory()
```
    This method will query transaction history for a piece of hardware.
    
    See Also:
    
    SoftLayer_Hardware::getTransactionHistory
  - getUpgradeItemPrices
```
@ApiMethod(instanceRequired=true)
List<Price> getUpgradeItemPrices()
```
    Retrieve a list of upgradeable items available to this piece of hardware. Currently, getUpgradeItemPrices retrieves upgrades available for a server's memory, hard drives, network port speed, bandwidth allocation and GPUs.
    
    See Also:
    
    SoftLayer_Hardware::getUpgradeItemPrices
  - importVirtualHost
```
@ApiMethod(instanceRequired=true)
Host importVirtualHost()
```
    The '''importVirtualHost''' method attempts to import the host record for the virtualization platform running on a server.
    
    See Also:
    
    SoftLayer_Hardware::importVirtualHost
  - isPingable
```
@ApiMethod(instanceRequired=true)
Boolean isPingable()
```
    The '''isPingable''' method issues a ping command to the selected server and returns the result of the ping command. This boolean return value displays ''true'' upon successful ping or ''false'' for a failed ping.
    
    See Also:
    
    SoftLayer_Hardware::isPingable
  - ping
```
@ApiMethod(instanceRequired=true)
String ping()
```
    Issues a ping command to the server and returns the ping response.
    
    See Also:
    
    SoftLayer_Hardware::ping
  - powerCycle
```
@ApiMethod(instanceRequired=true)
Boolean powerCycle()
```
    The '''powerCycle''' method completes a power off and power on of the server successively in one command. The power cycle command is equivalent to unplugging the server from the power strip and then plugging the server back in. '''This method should only be used when all other options have been exhausted'''. Additional remote management commands may not be executed if this command was successfully issued within the last 20 minutes to avoid server failure. Remote management commands include:
    
    rebootSoft rebootHard powerOn powerOff powerCycle
    
    See Also:
    
    SoftLayer_Hardware::powerCycle
  - powerOff
```
@ApiMethod(instanceRequired=true)
Boolean powerOff()
```
    This method will power off the server via the server's remote management card.
    
    See Also:
    
    SoftLayer_Hardware::powerOff
  - powerOn
```
@ApiMethod(instanceRequired=true)
Boolean powerOn()
```
    The '''powerOn''' method powers on a server via its remote management card. This boolean return value returns ''true'' upon successful execution and ''false'' if unsuccessful. Other remote management commands may not be issued in this command was successfully completed within the last 20 minutes to avoid server failure. Remote management commands include:
    
    rebootSoft rebootHard powerOn powerOff powerCycle
    
    See Also:
    
    SoftLayer_Hardware::powerOn
  - rebootDefault
```
@ApiMethod(instanceRequired=true)
Boolean rebootDefault()
```
    The '''rebootDefault''' method attempts to reboot the server by issuing a soft reboot, or reset, command to the server's remote management card. if the reset attempt is unsuccessful, a power cycle command will be issued via the power strip. The power cycle command is equivalent to unplugging the server from the power strip and then plugging the server back in. If the reset was successful within the last 20 minutes, another remote management command cannot be completed to avoid server failure. Remote management commands include:
    
    rebootSoft rebootHard powerOn powerOff powerCycle
    
    See Also:
    
    SoftLayer_Hardware::rebootDefault
  - rebootHard
```
@ApiMethod(instanceRequired=true)
Boolean rebootHard()
```
    The '''rebootHard''' method reboots the server by issuing a cycle command to the server's remote management card. A hard reboot is equivalent to pressing the ''Reset'' button on a server - it is issued immediately and will not allow processes to shut down prior to the reboot. Completing a hard reboot may initiate system disk checks upon server reboot, causing the boot up to take longer than normally expected.
    
    Remote management commands are unable to be executed if a reboot has been issued successfully within the last 20 minutes to avoid server failure. Remote management commands include:
    
    rebootSoft rebootHard powerOn powerOff powerCycle
    
    See Also:
    
    SoftLayer_Hardware::rebootHard
  - rebootSoft
```
@ApiMethod(instanceRequired=true)
Boolean rebootSoft()
```
    The '''rebootSoft''' method reboots the server by issuing a reset command to the server's remote management card via soft reboot. When executing a soft reboot, servers allow all processes to shut down completely before rebooting. Remote management commands are unable to be issued within 20 minutes of issuing a successful soft reboot in order to avoid server failure. Remote management commands include:
    
    rebootSoft rebootHard powerOn powerOff powerCycle
    
    See Also:
    
    SoftLayer_Hardware::rebootSoft
  - removeAccessToNetworkStorage
```
@ApiMethod(instanceRequired=true)
Boolean removeAccessToNetworkStorage(Storage networkStorageTemplateObject)
```
    This method is used to remove access to s SoftLayer_Network_Storage volumes that supports host- or network-level access control.
    
    See Also:
    
    SoftLayer_Hardware::removeAccessToNetworkStorage
  - removeAccessToNetworkStorageList
```
@ApiMethod(instanceRequired=true)
Boolean removeAccessToNetworkStorageList(List<Storage> networkStorageTemplateObjects)
```
    This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.
    
    See Also:
    
    SoftLayer_Hardware::removeAccessToNetworkStorageList
  - removeTags
```
@ApiMethod(instanceRequired=true)
Boolean removeTags(String tags)
```
    See Also:
    
    SoftLayer_Hardware::removeTags
  - setTags
```
@ApiMethod(instanceRequired=true)
Boolean setTags(String tags)
```
    See Also:
    
    SoftLayer_Hardware::setTags
  - updateIpmiPassword
```
@ApiMethod(instanceRequired=true)
Boolean updateIpmiPassword(String password)
```
    This method will update the root IPMI password on this SoftLayer_Hardware.
    
    See Also:
    
    SoftLayer_Hardware::updateIpmiPassword
  - getAccount
```
@ApiMethod(instanceRequired=true)
Account getAccount()
```
    The account associated with a piece of hardware.
    
    See Also:
    
    SoftLayer_Hardware::getAccount
  - getActiveComponents
```
@ApiMethod(instanceRequired=true)
List<Component> getActiveComponents()
```
    A piece of hardware's active physical components.
    
    See Also:
    
    SoftLayer_Hardware::getActiveComponents
  - getActiveNetworkMonitorIncident
```
@ApiMethod(instanceRequired=true)
List<Incident> getActiveNetworkMonitorIncident()
```
    A piece of hardware's active network monitoring incidents.
    
    See Also:
    
    SoftLayer_Hardware::getActiveNetworkMonitorIncident
  - getAllPowerComponents
```
@ApiMethod(instanceRequired=true)
List<Component> getAllPowerComponents()
```
    See Also:
    
    SoftLayer_Hardware::getAllPowerComponents
  - getAllowedHost
```
@ApiMethod(instanceRequired=true)
Host getAllowedHost()
```
    The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.
    
    See Also:
    
    SoftLayer_Hardware::getAllowedHost
  - getAllowedNetworkStorage
```
@ApiMethod(instanceRequired=true)
List<Storage> getAllowedNetworkStorage()
```
    The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
    
    See Also:
    
    SoftLayer_Hardware::getAllowedNetworkStorage
  - getAllowedNetworkStorageReplicas
```
@ApiMethod(instanceRequired=true)
List<Storage> getAllowedNetworkStorageReplicas()
```
    The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
    
    See Also:
    
    SoftLayer_Hardware::getAllowedNetworkStorageReplicas
  - getAntivirusSpywareSoftwareComponent
```
@ApiMethod(instanceRequired=true)
Component getAntivirusSpywareSoftwareComponent()
```
    Information regarding an antivirus/spyware software component object.
    
    See Also:
    
    SoftLayer_Hardware::getAntivirusSpywareSoftwareComponent
  - getAttributes
```
@ApiMethod(instanceRequired=true)
List<Attribute> getAttributes()
```
    Information regarding a piece of hardware's specific attributes.
    
    See Also:
    
    SoftLayer_Hardware::getAttributes
  - getAverageDailyPublicBandwidthUsage
```
@ApiMethod(instanceRequired=true)
BigDecimal getAverageDailyPublicBandwidthUsage()
```
    The average daily public bandwidth usage for the current billing cycle.
    
    See Also:
    
    SoftLayer_Hardware::getAverageDailyPublicBandwidthUsage
  - getBackendNetworkComponents
```
@ApiMethod(instanceRequired=true)
List<Component> getBackendNetworkComponents()
```
    A piece of hardware's back-end or private network components.
    
    See Also:
    
    SoftLayer_Hardware::getBackendNetworkComponents
  - getBackendRouters
```
@ApiMethod(instanceRequired=true)
List<Hardware> getBackendRouters()
```
    A hardware's backend or private router.
    
    See Also:
    
    SoftLayer_Hardware::getBackendRouters
  - getBandwidthAllocation
```
@ApiMethod(instanceRequired=true)
BigDecimal getBandwidthAllocation()
```
    A hardware's allotted bandwidth (measured in GB).
    
    See Also:
    
    SoftLayer_Hardware::getBandwidthAllocation
  - getBandwidthAllotmentDetail
```
@ApiMethod(instanceRequired=true)
Detail getBandwidthAllotmentDetail()
```
    A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.
    
    See Also:
    
    SoftLayer_Hardware::getBandwidthAllotmentDetail
  - getBenchmarkCertifications
```
@ApiMethod(instanceRequired=true)
List<Certification> getBenchmarkCertifications()
```
    Information regarding a piece of hardware's benchmark certifications.
    
    See Also:
    
    SoftLayer_Hardware::getBenchmarkCertifications
  - getBillingItem
```
@ApiMethod(instanceRequired=true)
Hardware getBillingItem()
```
    Information regarding the billing item for a server.
    
    See Also:
    
    SoftLayer_Hardware::getBillingItem
  - getBillingItemFlag
```
@ApiMethod(instanceRequired=true)
Boolean getBillingItemFlag()
```
    A flag indicating that a billing item exists.
    
    See Also:
    
    SoftLayer_Hardware::getBillingItemFlag
  - getBlockCancelBecauseDisconnectedFlag
```
@ApiMethod(instanceRequired=true)
Boolean getBlockCancelBecauseDisconnectedFlag()
```
    Determines whether the hardware is ineligible for cancellation because it is disconnected.
    
    See Also:
    
    SoftLayer_Hardware::getBlockCancelBecauseDisconnectedFlag
  - getBusinessContinuanceInsuranceFlag
```
@ApiMethod(instanceRequired=true)
Boolean getBusinessContinuanceInsuranceFlag()
```
    Status indicating whether or not a piece of hardware has business continuance insurance.
    
    See Also:
    
    SoftLayer_Hardware::getBusinessContinuanceInsuranceFlag
  - getChildrenHardware
```
@ApiMethod(instanceRequired=true)
List<Hardware> getChildrenHardware()
```
    Child hardware.
    
    See Also:
    
    SoftLayer_Hardware::getChildrenHardware
  - getComponents
```
@ApiMethod(instanceRequired=true)
List<Component> getComponents()
```
    A piece of hardware's components.
    
    See Also:
    
    SoftLayer_Hardware::getComponents
  - getContinuousDataProtectionSoftwareComponent
```
@ApiMethod(instanceRequired=true)
Component getContinuousDataProtectionSoftwareComponent()
```
    A continuous data protection/server backup software component object.
    
    See Also:
    
    SoftLayer_Hardware::getContinuousDataProtectionSoftwareComponent
  - getCurrentBillableBandwidthUsage
```
@ApiMethod(instanceRequired=true)
BigDecimal getCurrentBillableBandwidthUsage()
```
    The current billable public outbound bandwidth for this hardware for the current billing cycle.
    
    See Also:
    
    SoftLayer_Hardware::getCurrentBillableBandwidthUsage
  - getDatacenter
```
@ApiMethod(instanceRequired=true)
Location getDatacenter()
```
    Information regarding the datacenter in which a piece of hardware resides.
    
    See Also:
    
    SoftLayer_Hardware::getDatacenter
  - getDatacenterName
```
@ApiMethod(instanceRequired=true)
String getDatacenterName()
```
    The name of the datacenter in which a piece of hardware resides.
    
    See Also:
    
    SoftLayer_Hardware::getDatacenterName
  - getDaysInSparePool
```
@ApiMethod(instanceRequired=true)
Long getDaysInSparePool()
```
    Number of day(s) a server have been in spare pool.
    
    See Also:
    
    SoftLayer_Hardware::getDaysInSparePool
  - getDownlinkHardware
```
@ApiMethod(instanceRequired=true)
List<Hardware> getDownlinkHardware()
```
    All hardware that has uplink network connections to a piece of hardware.
    
    See Also:
    
    SoftLayer_Hardware::getDownlinkHardware
  - getDownlinkNetworkHardware
```
@ApiMethod(instanceRequired=true)
List<Hardware> getDownlinkNetworkHardware()
```
    All hardware that has uplink network connections to a piece of hardware.
    
    See Also:
    
    SoftLayer_Hardware::getDownlinkNetworkHardware
  - getDownlinkServers
```
@ApiMethod(instanceRequired=true)
List<Hardware> getDownlinkServers()
```
    Information regarding all servers attached to a piece of network hardware.
    
    See Also:
    
    SoftLayer_Hardware::getDownlinkServers
  - getDownlinkVirtualGuests
```
@ApiMethod(instanceRequired=true)
List<Guest> getDownlinkVirtualGuests()
```
    Information regarding all virtual guests attached to a piece of network hardware.
    
    See Also:
    
    SoftLayer_Hardware::getDownlinkVirtualGuests
  - getDownstreamHardwareBindings
```
@ApiMethod(instanceRequired=true)
List<Hardware> getDownstreamHardwareBindings()
```
    All hardware downstream from a network device.
    
    See Also:
    
    SoftLayer_Hardware::getDownstreamHardwareBindings
  - getDownstreamNetworkHardware
```
@ApiMethod(instanceRequired=true)
List<Hardware> getDownstreamNetworkHardware()
```
    All network hardware downstream from the selected piece of hardware.
    
    See Also:
    
    SoftLayer_Hardware::getDownstreamNetworkHardware
  - getDownstreamNetworkHardwareWithIncidents
```
@ApiMethod(instanceRequired=true)
List<Hardware> getDownstreamNetworkHardwareWithIncidents()
```
    All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware.
    
    See Also:
    
    SoftLayer_Hardware::getDownstreamNetworkHardwareWithIncidents
  - getDownstreamServers
```
@ApiMethod(instanceRequired=true)
List<Hardware> getDownstreamServers()
```
    Information regarding all servers attached downstream to a piece of network hardware.
    
    See Also:
    
    SoftLayer_Hardware::getDownstreamServers
  - getDownstreamVirtualGuests
```
@ApiMethod(instanceRequired=true)
List<Guest> getDownstreamVirtualGuests()
```
    Information regarding all virtual guests attached to a piece of network hardware.
    
    See Also:
    
    SoftLayer_Hardware::getDownstreamVirtualGuests
  - getDriveControllers
```
@ApiMethod(instanceRequired=true)
List<Component> getDriveControllers()
```
    The drive controllers contained within a piece of hardware.
    
    See Also:
    
    SoftLayer_Hardware::getDriveControllers
  - getEvaultNetworkStorage
```
@ApiMethod(instanceRequired=true)
List<Storage> getEvaultNetworkStorage()
```
    Information regarding a piece of hardware's associated EVault network storage service account.
    
    See Also:
    
    SoftLayer_Hardware::getEvaultNetworkStorage
  - getFirewallServiceComponent
```
@ApiMethod(instanceRequired=true)
Firewall getFirewallServiceComponent()
```
    Information regarding a piece of hardware's firewall services.
    
    See Also:
    
    SoftLayer_Hardware::getFirewallServiceComponent
  - getFixedConfigurationPreset
```
@ApiMethod(instanceRequired=true)
Preset getFixedConfigurationPreset()
```
    Defines the fixed components in a fixed configuration bare metal server.
    
    See Also:
    
    SoftLayer_Hardware::getFixedConfigurationPreset
  - getFrontendNetworkComponents
```
@ApiMethod(instanceRequired=true)
List<Component> getFrontendNetworkComponents()
```
    A piece of hardware's front-end or public network components.
    
    See Also:
    
    SoftLayer_Hardware::getFrontendNetworkComponents
  - getFrontendRouters
```
@ApiMethod(instanceRequired=true)
List<Hardware> getFrontendRouters()
```
    A hardware's frontend or public router.
    
    See Also:
    
    SoftLayer_Hardware::getFrontendRouters
  - getFutureBillingItem
```
@ApiMethod(instanceRequired=true)
Hardware getFutureBillingItem()
```
    Information regarding the future billing item for a server.
    
    See Also:
    
    SoftLayer_Hardware::getFutureBillingItem
  - getGlobalIdentifier
```
@ApiMethod(instanceRequired=true)
String getGlobalIdentifier()
```
    A hardware's universally unique identifier.
    
    See Also:
    
    SoftLayer_Hardware::getGlobalIdentifier
  - getHardDrives
```
@ApiMethod(instanceRequired=true)
List<Component> getHardDrives()
```
    The hard drives contained within a piece of hardware.
    
    See Also:
    
    SoftLayer_Hardware::getHardDrives
  - getHardwareChassis
```
@ApiMethod(instanceRequired=true)
Chassis getHardwareChassis()
```
    The chassis that a piece of hardware is housed in.
    
    See Also:
    
    SoftLayer_Hardware::getHardwareChassis
  - getHardwareFunction
```
@ApiMethod(instanceRequired=true)
Function getHardwareFunction()
```
    A hardware's function.
    
    See Also:
    
    SoftLayer_Hardware::getHardwareFunction
  - getHardwareFunctionDescription
```
@ApiMethod(instanceRequired=true)
String getHardwareFunctionDescription()
```
    A hardware's function.
    
    See Also:
    
    SoftLayer_Hardware::getHardwareFunctionDescription
  - getHardwareState
```
@ApiMethod(instanceRequired=true)
State getHardwareState()
```
    A hardware's power/transaction state.
    
    See Also:
    
    SoftLayer_Hardware::getHardwareState
  - getHardwareStatus
```
@ApiMethod(instanceRequired=true)
Status getHardwareStatus()
```
    A hardware's status.
    
    See Also:
    
    SoftLayer_Hardware::getHardwareStatus
  - getHasTrustedPlatformModuleBillingItemFlag
```
@ApiMethod(instanceRequired=true)
Boolean getHasTrustedPlatformModuleBillingItemFlag()
```
    Determine in hardware object has TPM enabled.
    
    See Also:
    
    SoftLayer_Hardware::getHasTrustedPlatformModuleBillingItemFlag
  - getHostIpsSoftwareComponent
```
@ApiMethod(instanceRequired=true)
Component getHostIpsSoftwareComponent()
```
    Information regarding a host IPS software component object.
    
    See Also:
    
    SoftLayer_Hardware::getHostIpsSoftwareComponent
  - getHourlyBillingFlag
```
@ApiMethod(instanceRequired=true)
Boolean getHourlyBillingFlag()
```
    A server's hourly billing status.
    
    See Also:
    
    SoftLayer_Hardware::getHourlyBillingFlag
  - getInboundBandwidthUsage
```
@ApiMethod(instanceRequired=true)
BigDecimal getInboundBandwidthUsage()
```
    The sum of all the inbound network traffic data for the last 30 days.
    
    See Also:
    
    SoftLayer_Hardware::getInboundBandwidthUsage
  - getInboundPublicBandwidthUsage
```
@ApiMethod(instanceRequired=true)
BigDecimal getInboundPublicBandwidthUsage()
```
    The total public inbound bandwidth for this hardware for the current billing cycle.
    
    See Also:
    
    SoftLayer_Hardware::getInboundPublicBandwidthUsage
  - getIsBillingTermChangeAvailableFlag
```
@ApiMethod(instanceRequired=true)
Boolean getIsBillingTermChangeAvailableFlag()
```
    Whether or not this hardware object is eligible to change to term billing.
    
    See Also:
    
    SoftLayer_Hardware::getIsBillingTermChangeAvailableFlag
  - getLastTransaction
```
@ApiMethod(instanceRequired=true)
Transaction getLastTransaction()
```
    Information regarding the last transaction a server performed.
    
    See Also:
    
    SoftLayer_Hardware::getLastTransaction
  - getLatestNetworkMonitorIncident
```
@ApiMethod(instanceRequired=true)
Incident getLatestNetworkMonitorIncident()
```
    A piece of hardware's latest network monitoring incident.
    
    See Also:
    
    SoftLayer_Hardware::getLatestNetworkMonitorIncident
  - getLocation
```
@ApiMethod(instanceRequired=true)
Location getLocation()
```
    Where a piece of hardware is located within SoftLayer's location hierarchy.
    
    See Also:
    
    SoftLayer_Hardware::getLocation
  - getLocationPathString
```
@ApiMethod(instanceRequired=true)
String getLocationPathString()
```
    See Also:
    
    SoftLayer_Hardware::getLocationPathString
  - getLockboxNetworkStorage
```
@ApiMethod(instanceRequired=true)
Storage getLockboxNetworkStorage()
```
    Information regarding a lockbox account associated with a server.
    
    See Also:
    
    SoftLayer_Hardware::getLockboxNetworkStorage
  - getManagedResourceFlag
```
@ApiMethod(instanceRequired=true)
Boolean getManagedResourceFlag()
```
    A flag indicating that the hardware is a managed resource.
    
    See Also:
    
    SoftLayer_Hardware::getManagedResourceFlag
  - getMemory
```
@ApiMethod(instanceRequired=true)
List<Component> getMemory()
```
    Information regarding a piece of hardware's memory.
    
    See Also:
    
    SoftLayer_Hardware::getMemory
  - getMemoryCapacity
```
@ApiMethod(instanceRequired=true)
Long getMemoryCapacity()
```
    The amount of memory a piece of hardware has, measured in gigabytes.
    
    See Also:
    
    SoftLayer_Hardware::getMemoryCapacity
  - getMetricTrackingObject
```
@ApiMethod(instanceRequired=true)
HardwareServer getMetricTrackingObject()
```
    A piece of hardware's metric tracking object.
    
    See Also:
    
    SoftLayer_Hardware::getMetricTrackingObject
  - getModules
```
@ApiMethod(instanceRequired=true)
List<Component> getModules()
```
    See Also:
    
    SoftLayer_Hardware::getModules
  - getMonitoringRobot
```
@ApiMethod(instanceRequired=true)
Robot getMonitoringRobot()
```
    See Also:
    
    SoftLayer_Hardware::getMonitoringRobot
  - getMonitoringServiceComponent
```
@ApiMethod(instanceRequired=true)
Stratum getMonitoringServiceComponent()
```
    Information regarding a piece of hardware's network monitoring services.
    
    See Also:
    
    SoftLayer_Hardware::getMonitoringServiceComponent
  - getMonitoringServiceEligibilityFlag
```
@ApiMethod(instanceRequired=true)
Boolean getMonitoringServiceEligibilityFlag()
```
    See Also:
    
    SoftLayer_Hardware::getMonitoringServiceEligibilityFlag
  - getMotherboard
```
@ApiMethod(instanceRequired=true)
Component getMotherboard()
```
    Information regarding a piece of hardware's motherboard.
    
    See Also:
    
    SoftLayer_Hardware::getMotherboard
  - getNetworkCards
```
@ApiMethod(instanceRequired=true)
List<Component> getNetworkCards()
```
    Information regarding a piece of hardware's network cards.
    
    See Also:
    
    SoftLayer_Hardware::getNetworkCards
  - getNetworkComponents
```
@ApiMethod(instanceRequired=true)
List<Component> getNetworkComponents()
```
    Returns a hardware's network components.
    
    See Also:
    
    SoftLayer_Hardware::getNetworkComponents
  - getNetworkGatewayMember
```
@ApiMethod(instanceRequired=true)
Member getNetworkGatewayMember()
```
    The gateway member if this device is part of a network gateway.
    
    See Also:
    
    SoftLayer_Hardware::getNetworkGatewayMember
  - getNetworkGatewayMemberFlag
```
@ApiMethod(instanceRequired=true)
Boolean getNetworkGatewayMemberFlag()
```
    Whether or not this device is part of a network gateway.
    
    See Also:
    
    SoftLayer_Hardware::getNetworkGatewayMemberFlag
  - getNetworkManagementIpAddress
```
@ApiMethod(instanceRequired=true)
String getNetworkManagementIpAddress()
```
    A piece of hardware's network management IP address.
    
    See Also:
    
    SoftLayer_Hardware::getNetworkManagementIpAddress
  - getNetworkMonitorAttachedDownHardware
```
@ApiMethod(instanceRequired=true)
List<Hardware> getNetworkMonitorAttachedDownHardware()
```
    All servers with failed monitoring that are attached downstream to a piece of hardware.
    
    See Also:
    
    SoftLayer_Hardware::getNetworkMonitorAttachedDownHardware
  - getNetworkMonitorAttachedDownVirtualGuests
```
@ApiMethod(instanceRequired=true)
List<Guest> getNetworkMonitorAttachedDownVirtualGuests()
```
    Virtual guests that are attached downstream to a hardware that have failed monitoring
    
    See Also:
    
    SoftLayer_Hardware::getNetworkMonitorAttachedDownVirtualGuests
  - getNetworkMonitorIncidents
```
@ApiMethod(instanceRequired=true)
List<Incident> getNetworkMonitorIncidents()
```
    The status of all of a piece of hardware's network monitoring incidents.
    
    See Also:
    
    SoftLayer_Hardware::getNetworkMonitorIncidents
  - getNetworkMonitors
```
@ApiMethod(instanceRequired=true)
List<Host> getNetworkMonitors()
```
    Information regarding a piece of hardware's network monitors.
    
    See Also:
    
    SoftLayer_Hardware::getNetworkMonitors
  - getNetworkStatus
```
@ApiMethod(instanceRequired=true)
String getNetworkStatus()
```
    The value of a hardware's network status attribute.
    
    See Also:
    
    SoftLayer_Hardware::getNetworkStatus
  - getNetworkStatusAttribute
```
@ApiMethod(instanceRequired=true)
Attribute getNetworkStatusAttribute()
```
    The hardware's related network status attribute.
    
    See Also:
    
    SoftLayer_Hardware::getNetworkStatusAttribute
  - getNetworkStorage
```
@ApiMethod(instanceRequired=true)
List<Storage> getNetworkStorage()
```
    Information regarding a piece of hardware's associated network storage service account.
    
    See Also:
    
    SoftLayer_Hardware::getNetworkStorage
  - getNetworkVlans
```
@ApiMethod(instanceRequired=true)
List<Vlan> getNetworkVlans()
```
    The network virtual LANs (VLANs) associated with a piece of hardware's network components.
    
    See Also:
    
    SoftLayer_Hardware::getNetworkVlans
  - getNextBillingCycleBandwidthAllocation
```
@ApiMethod(instanceRequired=true)
BigDecimal getNextBillingCycleBandwidthAllocation()
```
    A hardware's allotted bandwidth for the next billing cycle (measured in GB).
    
    See Also:
    
    SoftLayer_Hardware::getNextBillingCycleBandwidthAllocation
  - getNotesHistory
```
@ApiMethod(instanceRequired=true)
List<Note> getNotesHistory()
```
    See Also:
    
    SoftLayer_Hardware::getNotesHistory
  - getNvRamCapacity
```
@ApiMethod(instanceRequired=true)
Long getNvRamCapacity()
```
    The amount of non-volatile memory a piece of hardware has, measured in gigabytes.
    
    See Also:
    
    SoftLayer_Hardware::getNvRamCapacity
  - getNvRamComponentModels
```
@ApiMethod(instanceRequired=true)
List<Model> getNvRamComponentModels()
```
    See Also:
    
    SoftLayer_Hardware::getNvRamComponentModels
  - getOperatingSystem
```
@ApiMethod(instanceRequired=true)
OperatingSystem getOperatingSystem()
```
    Information regarding a piece of hardware's operating system.
    
    See Also:
    
    SoftLayer_Hardware::getOperatingSystem
  - getOperatingSystemReferenceCode
```
@ApiMethod(instanceRequired=true)
String getOperatingSystemReferenceCode()
```
    A hardware's operating system software description.
    
    See Also:
    
    SoftLayer_Hardware::getOperatingSystemReferenceCode
  - getOutboundBandwidthUsage
```
@ApiMethod(instanceRequired=true)
BigDecimal getOutboundBandwidthUsage()
```
    The sum of all the outbound network traffic data for the last 30 days.
    
    See Also:
    
    SoftLayer_Hardware::getOutboundBandwidthUsage
  - getOutboundPublicBandwidthUsage
```
@ApiMethod(instanceRequired=true)
BigDecimal getOutboundPublicBandwidthUsage()
```
    The total public outbound bandwidth for this hardware for the current billing cycle.
    
    See Also:
    
    SoftLayer_Hardware::getOutboundPublicBandwidthUsage
  - getParentBay
```
@ApiMethod(instanceRequired=true)
Blade getParentBay()
```
    Blade Bay
    
    See Also:
    
    SoftLayer_Hardware::getParentBay
  - getParentHardware
```
@ApiMethod(instanceRequired=true)
Hardware getParentHardware()
```
    Parent Hardware.
    
    See Also:
    
    SoftLayer_Hardware::getParentHardware
  - getPointOfPresenceLocation
```
@ApiMethod(instanceRequired=true)
Location getPointOfPresenceLocation()
```
    Information regarding the Point of Presence (PoP) location in which a piece of hardware resides.
    
    See Also:
    
    SoftLayer_Hardware::getPointOfPresenceLocation
  - getPowerComponents
```
@ApiMethod(instanceRequired=true)
List<Component> getPowerComponents()
```
    The power components for a hardware object.
    
    See Also:
    
    SoftLayer_Hardware::getPowerComponents
  - getPowerSupply
```
@ApiMethod(instanceRequired=true)
List<Component> getPowerSupply()
```
    Information regarding a piece of hardware's power supply.
    
    See Also:
    
    SoftLayer_Hardware::getPowerSupply
  - getPrimaryBackendIpAddress
```
@ApiMethod(instanceRequired=true)
String getPrimaryBackendIpAddress()
```
    The hardware's primary private IP address.
    
    See Also:
    
    SoftLayer_Hardware::getPrimaryBackendIpAddress
  - getPrimaryBackendNetworkComponent
```
@ApiMethod(instanceRequired=true)
Component getPrimaryBackendNetworkComponent()
```
    Information regarding the hardware's primary back-end network component.
    
    See Also:
    
    SoftLayer_Hardware::getPrimaryBackendNetworkComponent
  - getPrimaryIpAddress
```
@ApiMethod(instanceRequired=true)
String getPrimaryIpAddress()
```
    The hardware's primary public IP address.
    
    See Also:
    
    SoftLayer_Hardware::getPrimaryIpAddress
  - getPrimaryNetworkComponent
```
@ApiMethod(instanceRequired=true)
Component getPrimaryNetworkComponent()
```
    Information regarding the hardware's primary public network component.
    
    See Also:
    
    SoftLayer_Hardware::getPrimaryNetworkComponent
  - getPrivateNetworkOnlyFlag
```
@ApiMethod(instanceRequired=true)
Boolean getPrivateNetworkOnlyFlag()
```
    Whether the hardware only has access to the private network.
    
    See Also:
    
    SoftLayer_Hardware::getPrivateNetworkOnlyFlag
  - getProcessorCoreAmount
```
@ApiMethod(instanceRequired=true)
Long getProcessorCoreAmount()
```
    The total number of processor cores, summed from all processors that are attached to a piece of hardware
    
    See Also:
    
    SoftLayer_Hardware::getProcessorCoreAmount
  - getProcessorPhysicalCoreAmount
```
@ApiMethod(instanceRequired=true)
Long getProcessorPhysicalCoreAmount()
```
    The total number of physical processor cores, summed from all processors that are attached to a piece of hardware
    
    See Also:
    
    SoftLayer_Hardware::getProcessorPhysicalCoreAmount
  - getProcessors
```
@ApiMethod(instanceRequired=true)
List<Component> getProcessors()
```
    Information regarding a piece of hardware's processors.
    
    See Also:
    
    SoftLayer_Hardware::getProcessors
  - getRack
```
@ApiMethod(instanceRequired=true)
Location getRack()
```
    See Also:
    
    SoftLayer_Hardware::getRack
  - getRaidControllers
```
@ApiMethod(instanceRequired=true)
List<Component> getRaidControllers()
```
    The RAID controllers contained within a piece of hardware.
    
    See Also:
    
    SoftLayer_Hardware::getRaidControllers
  - getRecentEvents
```
@ApiMethod(instanceRequired=true)
List<Event> getRecentEvents()
```
    Recent events that impact this hardware.
    
    See Also:
    
    SoftLayer_Hardware::getRecentEvents
  - getRemoteManagementAccounts
```
@ApiMethod(instanceRequired=true)
List<User> getRemoteManagementAccounts()
```
    User credentials to issue commands and/or interact with the server's remote management card.
    
    See Also:
    
    SoftLayer_Hardware::getRemoteManagementAccounts
  - getRemoteManagementComponent
```
@ApiMethod(instanceRequired=true)
Component getRemoteManagementComponent()
```
    A hardware's associated remote management component. This is normally IPMI.
    
    See Also:
    
    SoftLayer_Hardware::getRemoteManagementComponent
  - getResourceConfigurations
```
@ApiMethod(instanceRequired=true)
List<Configuration> getResourceConfigurations()
```
    See Also:
    
    SoftLayer_Hardware::getResourceConfigurations
  - getResourceGroupMemberReferences
```
@ApiMethod(instanceRequired=true)
List<Member> getResourceGroupMemberReferences()
```
    See Also:
    
    SoftLayer_Hardware::getResourceGroupMemberReferences
  - getResourceGroupRoles
```
@ApiMethod(instanceRequired=true)
List<Role> getResourceGroupRoles()
```
    See Also:
    
    SoftLayer_Hardware::getResourceGroupRoles
  - getResourceGroups
```
@ApiMethod(instanceRequired=true)
List<Group> getResourceGroups()
```
    The resource groups in which this hardware is a member.
    
    See Also:
    
    SoftLayer_Hardware::getResourceGroups
  - getRouters
```
@ApiMethod(instanceRequired=true)
List<Hardware> getRouters()
```
    A hardware's routers.
    
    See Also:
    
    SoftLayer_Hardware::getRouters
  - getScaleAssets
```
@ApiMethod(instanceRequired=true)
List<Asset> getScaleAssets()
```
    Collection of scale assets this hardware corresponds to.
    
    See Also:
    
    SoftLayer_Hardware::getScaleAssets
  - getSecurityScanRequests
```
@ApiMethod(instanceRequired=true)
List<Request> getSecurityScanRequests()
```
    Information regarding a piece of hardware's vulnerability scan requests.
    
    See Also:
    
    SoftLayer_Hardware::getSecurityScanRequests
  - getServerRoom
```
@ApiMethod(instanceRequired=true)
Location getServerRoom()
```
    Information regarding the server room in which the hardware is located.
    
    See Also:
    
    SoftLayer_Hardware::getServerRoom
  - getServiceProvider
```
@ApiMethod(instanceRequired=true)
Provider getServiceProvider()
```
    Information regarding the piece of hardware's service provider.
    
    See Also:
    
    SoftLayer_Hardware::getServiceProvider
  - getSoftwareComponents
```
@ApiMethod(instanceRequired=true)
List<Component> getSoftwareComponents()
```
    Information regarding a piece of hardware's installed software.
    
    See Also:
    
    SoftLayer_Hardware::getSoftwareComponents
  - getSparePoolBillingItem
```
@ApiMethod(instanceRequired=true)
Hardware getSparePoolBillingItem()
```
    Information regarding the billing item for a spare pool server.
    
    See Also:
    
    SoftLayer_Hardware::getSparePoolBillingItem
  - getSshKeys
```
@ApiMethod(instanceRequired=true)
List<Key> getSshKeys()
```
    SSH keys to be installed on the server during provisioning or an OS reload.
    
    See Also:
    
    SoftLayer_Hardware::getSshKeys
  - getStorageGroups
```
@ApiMethod(instanceRequired=true)
List<Group> getStorageGroups()
```
    See Also:
    
    SoftLayer_Hardware::getStorageGroups
  - getStorageNetworkComponents
```
@ApiMethod(instanceRequired=true)
List<Component> getStorageNetworkComponents()
```
    A piece of hardware's private storage network components. [Deprecated]
    
    See Also:
    
    SoftLayer_Hardware::getStorageNetworkComponents
  - getTagReferences
```
@ApiMethod(instanceRequired=true)
List<Reference> getTagReferences()
```
    See Also:
    
    SoftLayer_Hardware::getTagReferences
  - getTopLevelLocation
```
@ApiMethod(instanceRequired=true)
Location getTopLevelLocation()
```
    See Also:
    
    SoftLayer_Hardware::getTopLevelLocation
  - getUpgradeRequest
```
@ApiMethod(instanceRequired=true)
Request getUpgradeRequest()
```
    An account's associated upgrade request object, if any.
    
    See Also:
    
    SoftLayer_Hardware::getUpgradeRequest
  - getUplinkHardware
```
@ApiMethod(instanceRequired=true)
Hardware getUplinkHardware()
```
    The network device connected to a piece of hardware.
    
    See Also:
    
    SoftLayer_Hardware::getUplinkHardware
  - getUplinkNetworkComponents
```
@ApiMethod(instanceRequired=true)
List<Component> getUplinkNetworkComponents()
```
    Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.
    
    See Also:
    
    SoftLayer_Hardware::getUplinkNetworkComponents
  - getUserData
```
@ApiMethod(instanceRequired=true)
List<Attribute> getUserData()
```
    An array containing a single string of custom user data for a hardware order. Max size is 16 kb.
    
    See Also:
    
    SoftLayer_Hardware::getUserData
  - getVirtualChassis
```
@ApiMethod(instanceRequired=true)
Group getVirtualChassis()
```
    Information regarding the virtual chassis for a piece of hardware.
    
    See Also:
    
    SoftLayer_Hardware::getVirtualChassis
  - getVirtualChassisSiblings
```
@ApiMethod(instanceRequired=true)
List<Hardware> getVirtualChassisSiblings()
```
    Information regarding the virtual chassis siblings for a piece of hardware.
    
    See Also:
    
    SoftLayer_Hardware::getVirtualChassisSiblings
  - getVirtualHost
```
@ApiMethod(instanceRequired=true)
Host getVirtualHost()
```
    A piece of hardware's virtual host record.
    
    See Also:
    
    SoftLayer_Hardware::getVirtualHost
  - getVirtualLicenses
```
@ApiMethod(instanceRequired=true)
List<VirtualLicense> getVirtualLicenses()
```
    Information regarding a piece of hardware's virtual software licenses.
    
    See Also:
    
    SoftLayer_Hardware::getVirtualLicenses
  - getVirtualRack
```
@ApiMethod(instanceRequired=true)
Allotment getVirtualRack()
```
    Information regarding the bandwidth allotment to which a piece of hardware belongs.
    
    See Also:
    
    SoftLayer_Hardware::getVirtualRack
  - getVirtualRackId
```
@ApiMethod(instanceRequired=true)
Long getVirtualRackId()
```
    The name of the bandwidth allotment belonging to a piece of hardware.
    
    See Also:
    
    SoftLayer_Hardware::getVirtualRackId
  - getVirtualRackName
```
@ApiMethod(instanceRequired=true)
String getVirtualRackName()
```
    The name of the bandwidth allotment belonging to a piece of hardware.
    
    See Also:
    
    SoftLayer_Hardware::getVirtualRackName
  - getVirtualizationPlatform
```
@ApiMethod(instanceRequired=true)
Component getVirtualizationPlatform()
```
    A piece of hardware's virtualization platform software.
    
    See Also:
    
    SoftLayer_Hardware::getVirtualizationPlatform

Interface Hardware.Service

Method Summary

Methods inherited from interface com.softlayer.api.Maskable

Methods inherited from interface com.softlayer.api.ResultLimitable

Method Detail

asAsync

withNewMask

withMask

setMask

allowAccessToNetworkStorage

allowAccessToNetworkStorageList

captureImage

createObject

REST Example

deleteObject

deleteSoftwareComponentPasswords

deleteTag

editSoftwareComponentPasswords

executeRemoteScript

findByIpAddress

generateOrderTemplate

getAttachedNetworkStorages

getAvailableBillingTermChangePrices

getAvailableNetworkStorages

getBackendIncomingBandwidth

getBackendOutgoingBandwidth

getComponentDetailsXML

getCreateObjectOptions

getCurrentBillingDetail

getCurrentBillingTotal

getDailyAverage

getFrontendIncomingBandwidth

getFrontendOutgoingBandwidth

getHourlyBandwidth

getObject

getPrivateBandwidthData

getPublicBandwidthData

getSensorData

getSensorDataWithGraphs

getServerFanSpeedGraphs

getServerPowerState

getServerTemperatureGraphs

getTransactionHistory

getUpgradeItemPrices

importVirtualHost

isPingable

ping

powerCycle

powerOff

powerOn

rebootDefault

rebootHard

rebootSoft

removeAccessToNetworkStorage

removeAccessToNetworkStorageList

removeTags

setTags

updateIpmiPassword

getAccount

getActiveComponents

getActiveNetworkMonitorIncident

getAllPowerComponents

getAllowedHost

getAllowedNetworkStorage

getAllowedNetworkStorageReplicas

getAntivirusSpywareSoftwareComponent

getAttributes

getAverageDailyPublicBandwidthUsage

getBackendNetworkComponents

getBackendRouters

getBandwidthAllocation

getBandwidthAllotmentDetail

getBenchmarkCertifications

getBillingItem

getBillingItemFlag

getBlockCancelBecauseDisconnectedFlag

getBusinessContinuanceInsuranceFlag

getChildrenHardware

getComponents

getContinuousDataProtectionSoftwareComponent