Package com.softlayer.api.service
Class Hardware
java.lang.Object
com.softlayer.api.Type
com.softlayer.api.service.Entity
com.softlayer.api.service.Hardware
- Direct Known Subclasses:
LoadBalancer
,Server
,Switch
@ApiType("SoftLayer_Hardware") public class Hardware extends Entity
The SoftLayer_Hardware data type contains general information relating to a single SoftLayer hardware.
- See Also:
- SoftLayer_Hardware
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Hardware.Mask
static interface
Hardware.Service
Every SoftLayer hardware is defined in the SoftLayer_Hardware service.static interface
Hardware.ServiceAsync
-
Field Summary
Fields Modifier and Type Field Description protected Account
account
The account associated with a piece of hardware.protected Long
accountId
A hardware's associated [[SoftLayer_Account|account]] id.protected boolean
accountIdSpecified
protected Long
activeComponentCount
A count of a piece of hardware's active physical components.protected List<Component>
activeComponents
A piece of hardware's active physical components.protected List<Incident>
activeNetworkMonitorIncident
A piece of hardware's active network monitoring incidents.protected Long
activeNetworkMonitorIncidentCount
A count of a piece of hardware's active network monitoring incidents.protected Host
allowedHost
The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.protected List<Storage>
allowedNetworkStorage
The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.protected Long
allowedNetworkStorageCount
A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.protected Long
allowedNetworkStorageReplicaCount
A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.protected List<Storage>
allowedNetworkStorageReplicas
The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.protected Long
allPowerComponentCount
A count ofprotected List<Component>
allPowerComponents
protected Component
antivirusSpywareSoftwareComponent
Information regarding an antivirus/spyware software component object.protected Long
attributeCount
A count of information regarding a piece of hardware's specific attributes.protected List<Attribute>
attributes
Information regarding a piece of hardware's specific attributes.protected BigDecimal
averageDailyPublicBandwidthUsage
The average daily public bandwidth usage for the current billing cycle.protected Long
backendNetworkComponentCount
A count of a piece of hardware's back-end or private network components.protected List<Component>
backendNetworkComponents
A piece of hardware's back-end or private network components.protected Long
backendRouterCount
A count of a hardware's backend or private router.protected List<Hardware>
backendRouters
A hardware's backend or private router.protected BigDecimal
bandwidthAllocation
A hardware's allotted bandwidth (measured in GB).protected Detail
bandwidthAllotmentDetail
A hardware's allotted detail record.protected Long
bareMetalInstanceFlag
When true, this flag specifies that a hardware is Bare Metal Server.protected boolean
bareMetalInstanceFlagSpecified
protected Long
benchmarkCertificationCount
A count of information regarding a piece of hardware's benchmark certifications.protected List<Certification>
benchmarkCertifications
Information regarding a piece of hardware's benchmark certifications.protected Hardware
billingItem
Information regarding the billing item for a server.protected Boolean
billingItemFlag
A flag indicating that a billing item exists.protected Boolean
blockCancelBecauseDisconnectedFlag
Determines whether the hardware is ineligible for cancellation because it is disconnected.protected Boolean
businessContinuanceInsuranceFlag
Status indicating whether or not a piece of hardware has business continuance insurance.protected List<Hardware>
childrenHardware
Child hardware.protected Long
childrenHardwareCount
A count of child hardware.protected Long
componentCount
A count of a piece of hardware's components.protected List<Component>
components
A piece of hardware's components.protected Component
continuousDataProtectionSoftwareComponent
A continuous data protection/server backup software component object.protected BigDecimal
currentBillableBandwidthUsage
The current billable public outbound bandwidth for this hardware for the current billing cycle.protected Location
datacenter
Information regarding the datacenter in which a piece of hardware resides.protected String
datacenterName
The name of the datacenter in which a piece of hardware resides.protected Long
daysInSparePool
Number of day(s) a server have been in spare pool.protected String
domain
A piece of hardware's local network domain name.protected boolean
domainSpecified
protected List<Hardware>
downlinkHardware
All hardware that has uplink network connections to a piece of hardware.protected Long
downlinkHardwareCount
A count of all hardware that has uplink network connections to a piece of hardware.protected List<Hardware>
downlinkNetworkHardware
All hardware that has uplink network connections to a piece of hardware.protected Long
downlinkNetworkHardwareCount
A count of all hardware that has uplink network connections to a piece of hardware.protected Long
downlinkServerCount
A count of information regarding all servers attached to a piece of network hardware.protected List<Hardware>
downlinkServers
Information regarding all servers attached to a piece of network hardware.protected Long
downlinkVirtualGuestCount
A count of information regarding all virtual guests attached to a piece of network hardware.protected List<Guest>
downlinkVirtualGuests
Information regarding all virtual guests attached to a piece of network hardware.protected Long
downstreamHardwareBindingCount
A count of all hardware downstream from a network device.protected List<Hardware>
downstreamHardwareBindings
All hardware downstream from a network device.protected List<Hardware>
downstreamNetworkHardware
All network hardware downstream from the selected piece of hardware.protected Long
downstreamNetworkHardwareCount
A count of all network hardware downstream from the selected piece of hardware.protected Long
downstreamNetworkHardwareWithIncidentCount
A count of all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware.protected List<Hardware>
downstreamNetworkHardwareWithIncidents
All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware.protected Long
downstreamServerCount
A count of information regarding all servers attached downstream to a piece of network hardware.protected List<Hardware>
downstreamServers
Information regarding all servers attached downstream to a piece of network hardware.protected Long
downstreamVirtualGuestCount
A count of information regarding all virtual guests attached to a piece of network hardware.protected List<Guest>
downstreamVirtualGuests
Information regarding all virtual guests attached to a piece of network hardware.protected Long
driveControllerCount
A count of the drive controllers contained within a piece of hardware.protected List<Component>
driveControllers
The drive controllers contained within a piece of hardware.protected List<Storage>
evaultNetworkStorage
Information regarding a piece of hardware's associated EVault network storage service account.protected Long
evaultNetworkStorageCount
A count of information regarding a piece of hardware's associated EVault network storage service account.protected Firewall
firewallServiceComponent
Information regarding a piece of hardware's firewall services.protected Preset
fixedConfigurationPreset
Defines the fixed components in a fixed configuration bare metal server.protected Long
frontendNetworkComponentCount
A count of a piece of hardware's front-end or public network components.protected List<Component>
frontendNetworkComponents
A piece of hardware's front-end or public network components.protected Long
frontendRouterCount
A count of a hardware's frontend or public router.protected List<Hardware>
frontendRouters
A hardware's frontend or public router.protected String
fullyQualifiedDomainName
A name reflecting the hostname and domain of the hardware.protected boolean
fullyQualifiedDomainNameSpecified
protected String
globalIdentifier
A hardware's universally unique identifier.protected Long
hardDriveCount
A count of the hard drives contained within a piece of hardware.protected List<Component>
hardDrives
The hard drives contained within a piece of hardware.protected Chassis
hardwareChassis
The chassis that a piece of hardware is housed in.protected Function
hardwareFunction
A hardware's function.protected String
hardwareFunctionDescription
A hardware's function.protected Status
hardwareStatus
A hardware's status.protected Long
hardwareStatusId
A number reflecting the state of a hardwareprotected boolean
hardwareStatusIdSpecified
protected Boolean
hasTrustedPlatformModuleBillingItemFlag
Determine in hardware object has TPM enabled.protected Component
hostIpsSoftwareComponent
Information regarding a host IPS software component object.protected String
hostname
A hardware's hostnameprotected boolean
hostnameSpecified
protected Boolean
hourlyBillingFlag
A server's hourly billing status.protected Long
id
A hardware's internal identification numberprotected boolean
idSpecified
protected BigDecimal
inboundBandwidthUsage
The sum of all the inbound network traffic data for the last 30 days.protected BigDecimal
inboundPublicBandwidthUsage
The total public inbound bandwidth for this hardware for the current billing cycle.protected Transaction
lastTransaction
Information regarding the last transaction a server performed.protected Incident
latestNetworkMonitorIncident
A piece of hardware's latest network monitoring incident.protected Location
location
Where a piece of hardware is located within SoftLayer's location hierarchy.protected String
locationPathString
protected Storage
lockboxNetworkStorage
Information regarding a lockbox account associated with a server.protected Boolean
managedResourceFlag
A flag indicating that the hardware is a managed resource.protected String
manufacturerSerialNumber
A hardware's serial number that is supplied by the manufacturer.protected boolean
manufacturerSerialNumberSpecified
protected List<Component>
memory
Information regarding a piece of hardware's memory.protected Long
memoryCapacity
The amount of memory a piece of hardware has, measured in gigabytes.protected Long
memoryCount
A count of information regarding a piece of hardware's memory.protected HardwareServer
metricTrackingObject
A piece of hardware's metric tracking object.protected Long
moduleCount
A count ofprotected List<Component>
modules
protected Stratum
monitoringServiceComponent
Information regarding a piece of hardware's network monitoring services.protected Component
motherboard
Information regarding a piece of hardware's motherboard.protected Long
networkCardCount
A count of information regarding a piece of hardware's network cards.protected List<Component>
networkCards
Information regarding a piece of hardware's network cards.protected Long
networkComponentCount
A count of returns a hardware's network components.protected List<Component>
networkComponents
Returns a hardware's network components.protected Member
networkGatewayMember
The gateway member if this device is part of a network gateway.protected Boolean
networkGatewayMemberFlag
Whether or not this device is part of a network gateway.protected String
networkManagementIpAddress
A piece of hardware's network management IP address.protected List<Hardware>
networkMonitorAttachedDownHardware
All servers with failed monitoring that are attached downstream to a piece of hardware.protected Long
networkMonitorAttachedDownHardwareCount
A count of all servers with failed monitoring that are attached downstream to a piece of hardware.protected Long
networkMonitorAttachedDownVirtualGuestCount
A count of virtual guests that are attached downstream to a hardware that have failed monitoringprotected List<Guest>
networkMonitorAttachedDownVirtualGuests
Virtual guests that are attached downstream to a hardware that have failed monitoringprotected Long
networkMonitorCount
A count of information regarding a piece of hardware's network monitors.protected Long
networkMonitorIncidentCount
A count of the status of all of a piece of hardware's network monitoring incidents.protected List<Incident>
networkMonitorIncidents
The status of all of a piece of hardware's network monitoring incidents.protected List<Host>
networkMonitors
Information regarding a piece of hardware's network monitors.protected String
networkStatus
The value of a hardware's network status attribute.protected Attribute
networkStatusAttribute
The hardware's related network status attribute.protected List<Storage>
networkStorage
Information regarding a piece of hardware's associated network storage service account.protected Long
networkStorageCount
A count of information regarding a piece of hardware's associated network storage service account.protected Long
networkVlanCount
A count of the network virtual LANs (VLANs) associated with a piece of hardware's network components.protected List<Vlan>
networkVlans
The network virtual LANs (VLANs) associated with a piece of hardware's network components.protected BigDecimal
nextBillingCycleBandwidthAllocation
A hardware's allotted bandwidth for the next billing cycle (measured in GB).protected String
notes
A small note about a piece of hardware to use at your discretion.protected List<Note>
notesHistory
protected Long
notesHistoryCount
A count ofprotected boolean
notesSpecified
protected Long
nvRamCapacity
The amount of non-volatile memory a piece of hardware has, measured in gigabytes.protected Long
nvRamComponentModelCount
A count ofprotected List<Model>
nvRamComponentModels
protected OperatingSystem
operatingSystem
Information regarding a piece of hardware's operating system.protected String
operatingSystemReferenceCode
A hardware's operating system software description.protected BigDecimal
outboundBandwidthUsage
The sum of all the outbound network traffic data for the last 30 days.protected BigDecimal
outboundPublicBandwidthUsage
The total public outbound bandwidth for this hardware for the current billing cycle.protected Blade
parentBay
Blade Bayprotected Hardware
parentHardware
Parent Hardware.protected Location
pointOfPresenceLocation
Information regarding the Point of Presence (PoP) location in which a piece of hardware resides.protected String
postInstallScriptUri
URI of the script to be downloaded and executed after installation is complete.protected boolean
postInstallScriptUriSpecified
protected Long
powerComponentCount
A count of the power components for a hardware object.protected List<Component>
powerComponents
The power components for a hardware object.protected List<Component>
powerSupply
Information regarding a piece of hardware's power supply.protected Long
powerSupplyCount
A count of information regarding a piece of hardware's power supply.protected String
primaryBackendIpAddress
The hardware's primary private IP address.protected Component
primaryBackendNetworkComponent
Information regarding the hardware's primary back-end network component.protected String
primaryIpAddress
The hardware's primary public IP address.protected Component
primaryNetworkComponent
Information regarding the hardware's primary public network component.protected Boolean
privateNetworkOnlyFlag
Whether the hardware only has access to the private network.protected Long
processorCoreAmount
The total number of processor cores, summed from all processors that are attached to a piece of hardwareprotected Long
processorCount
A count of information regarding a piece of hardware's processors.protected Long
processorPhysicalCoreAmount
The total number of physical processor cores, summed from all processors that are attached to a piece of hardwareprotected List<Component>
processors
Information regarding a piece of hardware's processors.protected GregorianCalendar
provisionDate
protected boolean
provisionDateSpecified
protected Location
rack
protected Long
raidControllerCount
A count of the RAID controllers contained within a piece of hardware.protected List<Component>
raidControllers
The RAID controllers contained within a piece of hardware.protected Long
recentEventCount
A count of recent events that impact this hardware.protected List<Event>
recentEvents
Recent events that impact this hardware.protected Long
remoteManagementAccountCount
A count of user credentials to issue commands and/or interact with the server's remote management card.protected List<User>
remoteManagementAccounts
User credentials to issue commands and/or interact with the server's remote management card.protected Component
remoteManagementComponent
A hardware's associated remote management component.protected Long
resourceConfigurationCount
A count ofprotected List<Configuration>
resourceConfigurations
protected Long
resourceGroupCount
A count of the resource groups in which this hardware is a member.protected Long
resourceGroupMemberReferenceCount
A count ofprotected List<Member>
resourceGroupMemberReferences
protected Long
resourceGroupRoleCount
A count ofprotected List<Role>
resourceGroupRoles
protected List<Group>
resourceGroups
The resource groups in which this hardware is a member.protected Long
routerCount
A count of a hardware's routers.protected List<Hardware>
routers
A hardware's routers.protected Long
scaleAssetCount
A count of collection of scale assets this hardware corresponds to.protected List<Asset>
scaleAssets
Collection of scale assets this hardware corresponds to.protected Long
securityScanRequestCount
A count of information regarding a piece of hardware's vulnerability scan requests.protected List<Request>
securityScanRequests
Information regarding a piece of hardware's vulnerability scan requests.protected String
serialNumber
A hardware's serial number that is supplied by SoftLayer.protected boolean
serialNumberSpecified
protected Location
serverRoom
Information regarding the server room in which the hardware is located.protected Provider
serviceProvider
Information regarding the piece of hardware's service provider.protected Long
serviceProviderId
protected boolean
serviceProviderIdSpecified
protected Long
serviceProviderResourceId
A hardware's internal identification number at its service providerprotected boolean
serviceProviderResourceIdSpecified
protected Long
softwareComponentCount
A count of information regarding a piece of hardware's installed software.protected List<Component>
softwareComponents
Information regarding a piece of hardware's installed software.protected Hardware
sparePoolBillingItem
Information regarding the billing item for a spare pool server.protected Long
sshKeyCount
A count of sSH keys to be installed on the server during provisioning or an OS reload.protected List<Key>
sshKeys
SSH keys to be installed on the server during provisioning or an OS reload.protected Long
storageGroupCount
A count ofprotected List<Group>
storageGroups
protected Long
storageNetworkComponentCount
A count of a piece of hardware's private storage network components.protected List<Component>
storageNetworkComponents
A piece of hardware's private storage network components.protected Long
tagReferenceCount
A count ofprotected List<Reference>
tagReferences
protected Location
topLevelLocation
protected Request
upgradeRequest
An account's associated upgrade request object, if any.protected Hardware
uplinkHardware
The network device connected to a piece of hardware.protected Long
uplinkNetworkComponentCount
A count of information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.protected List<Component>
uplinkNetworkComponents
Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.protected List<Attribute>
userData
An array containing a single string of custom user data for a hardware order.protected Long
userDataCount
A count of an array containing a single string of custom user data for a hardware order.protected Group
virtualChassis
Information regarding the virtual chassis for a piece of hardware.protected Long
virtualChassisSiblingCount
A count of information regarding the virtual chassis siblings for a piece of hardware.protected List<Hardware>
virtualChassisSiblings
Information regarding the virtual chassis siblings for a piece of hardware.protected Host
virtualHost
A piece of hardware's virtual host record.protected Component
virtualizationPlatform
A piece of hardware's virtualization platform software.protected Long
virtualLicenseCount
A count of information regarding a piece of hardware's virtual software licenses.protected List<VirtualLicense>
virtualLicenses
Information regarding a piece of hardware's virtual software licenses.protected Allotment
virtualRack
Information regarding the bandwidth allotment to which a piece of hardware belongs.protected Long
virtualRackId
The name of the bandwidth allotment belonging to a piece of hardware.protected String
virtualRackName
The name of the bandwidth allotment belonging to a piece of hardware. -
Constructor Summary
Constructors Constructor Description Hardware()
-
Method Summary
-
Field Details
-
account
The account associated with a piece of hardware. -
activeComponents
A piece of hardware's active physical components. -
activeNetworkMonitorIncident
A piece of hardware's active network monitoring incidents. -
allPowerComponents
-
allowedHost
The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists. -
allowedNetworkStorage
The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -
allowedNetworkStorageReplicas
The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -
antivirusSpywareSoftwareComponent
Information regarding an antivirus/spyware software component object. -
attributes
Information regarding a piece of hardware's specific attributes. -
averageDailyPublicBandwidthUsage
The average daily public bandwidth usage for the current billing cycle. -
backendNetworkComponents
A piece of hardware's back-end or private network components. -
backendRouters
A hardware's backend or private router. -
bandwidthAllocation
A hardware's allotted bandwidth (measured in GB). -
bandwidthAllotmentDetail
A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments. -
benchmarkCertifications
Information regarding a piece of hardware's benchmark certifications. -
billingItem
Information regarding the billing item for a server. -
billingItemFlag
A flag indicating that a billing item exists. -
blockCancelBecauseDisconnectedFlag
Determines whether the hardware is ineligible for cancellation because it is disconnected. -
businessContinuanceInsuranceFlag
Status indicating whether or not a piece of hardware has business continuance insurance. -
childrenHardware
Child hardware. -
components
A piece of hardware's components. -
continuousDataProtectionSoftwareComponent
A continuous data protection/server backup software component object. -
currentBillableBandwidthUsage
The current billable public outbound bandwidth for this hardware for the current billing cycle. -
datacenter
Information regarding the datacenter in which a piece of hardware resides. -
datacenterName
The name of the datacenter in which a piece of hardware resides. -
daysInSparePool
Number of day(s) a server have been in spare pool. -
downlinkHardware
All hardware that has uplink network connections to a piece of hardware. -
downlinkNetworkHardware
All hardware that has uplink network connections to a piece of hardware. -
downlinkServers
Information regarding all servers attached to a piece of network hardware. -
downlinkVirtualGuests
Information regarding all virtual guests attached to a piece of network hardware. -
downstreamHardwareBindings
All hardware downstream from a network device. -
downstreamNetworkHardware
All network hardware downstream from the selected piece of hardware. -
downstreamNetworkHardwareWithIncidents
All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. -
downstreamServers
Information regarding all servers attached downstream to a piece of network hardware. -
downstreamVirtualGuests
Information regarding all virtual guests attached to a piece of network hardware. -
driveControllers
The drive controllers contained within a piece of hardware. -
evaultNetworkStorage
Information regarding a piece of hardware's associated EVault network storage service account. -
firewallServiceComponent
Information regarding a piece of hardware's firewall services. -
fixedConfigurationPreset
Defines the fixed components in a fixed configuration bare metal server. -
frontendNetworkComponents
A piece of hardware's front-end or public network components. -
frontendRouters
A hardware's frontend or public router. -
globalIdentifier
A hardware's universally unique identifier. -
hardDrives
The hard drives contained within a piece of hardware. -
hardwareChassis
The chassis that a piece of hardware is housed in. -
hardwareFunction
A hardware's function. -
hardwareFunctionDescription
A hardware's function. -
hardwareStatus
A hardware's status. -
hasTrustedPlatformModuleBillingItemFlag
Determine in hardware object has TPM enabled. -
hostIpsSoftwareComponent
Information regarding a host IPS software component object. -
hourlyBillingFlag
A server's hourly billing status. -
inboundBandwidthUsage
The sum of all the inbound network traffic data for the last 30 days. -
inboundPublicBandwidthUsage
The total public inbound bandwidth for this hardware for the current billing cycle. -
lastTransaction
Information regarding the last transaction a server performed. -
latestNetworkMonitorIncident
A piece of hardware's latest network monitoring incident. -
location
Where a piece of hardware is located within SoftLayer's location hierarchy. -
locationPathString
-
lockboxNetworkStorage
Information regarding a lockbox account associated with a server. -
managedResourceFlag
A flag indicating that the hardware is a managed resource. -
memory
Information regarding a piece of hardware's memory. -
memoryCapacity
The amount of memory a piece of hardware has, measured in gigabytes. -
metricTrackingObject
A piece of hardware's metric tracking object. -
modules
-
monitoringServiceComponent
Information regarding a piece of hardware's network monitoring services. -
motherboard
Information regarding a piece of hardware's motherboard. -
networkCards
Information regarding a piece of hardware's network cards. -
networkComponents
Returns a hardware's network components. -
networkGatewayMember
The gateway member if this device is part of a network gateway. -
networkGatewayMemberFlag
Whether or not this device is part of a network gateway. -
networkManagementIpAddress
A piece of hardware's network management IP address. -
networkMonitorAttachedDownHardware
All servers with failed monitoring that are attached downstream to a piece of hardware. -
networkMonitorAttachedDownVirtualGuests
Virtual guests that are attached downstream to a hardware that have failed monitoring -
networkMonitorIncidents
The status of all of a piece of hardware's network monitoring incidents. -
networkMonitors
Information regarding a piece of hardware's network monitors. -
networkStatus
The value of a hardware's network status attribute. -
networkStatusAttribute
The hardware's related network status attribute. -
networkStorage
Information regarding a piece of hardware's associated network storage service account. -
networkVlans
The network virtual LANs (VLANs) associated with a piece of hardware's network components. -
nextBillingCycleBandwidthAllocation
A hardware's allotted bandwidth for the next billing cycle (measured in GB). -
notesHistory
-
nvRamCapacity
The amount of non-volatile memory a piece of hardware has, measured in gigabytes. -
nvRamComponentModels
-
operatingSystem
Information regarding a piece of hardware's operating system. -
operatingSystemReferenceCode
A hardware's operating system software description. -
outboundBandwidthUsage
The sum of all the outbound network traffic data for the last 30 days. -
outboundPublicBandwidthUsage
The total public outbound bandwidth for this hardware for the current billing cycle. -
parentBay
Blade Bay -
parentHardware
Parent Hardware. -
pointOfPresenceLocation
Information regarding the Point of Presence (PoP) location in which a piece of hardware resides. -
powerComponents
The power components for a hardware object. -
powerSupply
Information regarding a piece of hardware's power supply. -
primaryBackendIpAddress
The hardware's primary private IP address. -
primaryBackendNetworkComponent
Information regarding the hardware's primary back-end network component. -
primaryIpAddress
The hardware's primary public IP address. -
primaryNetworkComponent
Information regarding the hardware's primary public network component. -
privateNetworkOnlyFlag
Whether the hardware only has access to the private network. -
processorCoreAmount
The total number of processor cores, summed from all processors that are attached to a piece of hardware -
processorPhysicalCoreAmount
The total number of physical processor cores, summed from all processors that are attached to a piece of hardware -
processors
Information regarding a piece of hardware's processors. -
rack
-
raidControllers
The RAID controllers contained within a piece of hardware. -
recentEvents
Recent events that impact this hardware. -
remoteManagementAccounts
User credentials to issue commands and/or interact with the server's remote management card. -
remoteManagementComponent
A hardware's associated remote management component. This is normally IPMI. -
resourceConfigurations
-
resourceGroupMemberReferences
-
resourceGroupRoles
-
resourceGroups
The resource groups in which this hardware is a member. -
routers
A hardware's routers. -
scaleAssets
Collection of scale assets this hardware corresponds to. -
securityScanRequests
Information regarding a piece of hardware's vulnerability scan requests. -
serverRoom
Information regarding the server room in which the hardware is located. -
serviceProvider
Information regarding the piece of hardware's service provider. -
softwareComponents
Information regarding a piece of hardware's installed software. -
sparePoolBillingItem
Information regarding the billing item for a spare pool server. -
sshKeys
SSH keys to be installed on the server during provisioning or an OS reload. -
storageGroups
-
storageNetworkComponents
A piece of hardware's private storage network components. [Deprecated] -
tagReferences
-
topLevelLocation
-
upgradeRequest
An account's associated upgrade request object, if any. -
uplinkHardware
The network device connected to a piece of hardware. -
uplinkNetworkComponents
Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. -
userData
An array containing a single string of custom user data for a hardware order. Max size is 16 kb. -
virtualChassis
Information regarding the virtual chassis for a piece of hardware. -
virtualChassisSiblings
Information regarding the virtual chassis siblings for a piece of hardware. -
virtualHost
A piece of hardware's virtual host record. -
virtualLicenses
Information regarding a piece of hardware's virtual software licenses. -
virtualRack
Information regarding the bandwidth allotment to which a piece of hardware belongs. -
virtualRackId
The name of the bandwidth allotment belonging to a piece of hardware. -
virtualRackName
The name of the bandwidth allotment belonging to a piece of hardware. -
virtualizationPlatform
A piece of hardware's virtualization platform software. -
accountId
A hardware's associated [[SoftLayer_Account|account]] id. -
accountIdSpecified
protected boolean accountIdSpecified -
bareMetalInstanceFlag
When true, this flag specifies that a hardware is Bare Metal Server. Bare Metal Servers are physical bare metal servers that are billed with the same options as Virtual Servers, with monthly and hourly rates. Bare Metal instances are ordered based on processor core count and ram amount. -
bareMetalInstanceFlagSpecified
protected boolean bareMetalInstanceFlagSpecified -
domain
A piece of hardware's local network domain name. -
domainSpecified
protected boolean domainSpecified -
fullyQualifiedDomainName
A name reflecting the hostname and domain of the hardware. This is created from the combined values of the hardware's hostname and domain name automatically, and thus should not be edited directly. -
fullyQualifiedDomainNameSpecified
protected boolean fullyQualifiedDomainNameSpecified -
hardwareStatusId
A number reflecting the state of a hardware -
hardwareStatusIdSpecified
protected boolean hardwareStatusIdSpecified -
hostname
A hardware's hostname -
hostnameSpecified
protected boolean hostnameSpecified -
id
A hardware's internal identification number -
idSpecified
protected boolean idSpecified -
manufacturerSerialNumber
A hardware's serial number that is supplied by the manufacturer. -
manufacturerSerialNumberSpecified
protected boolean manufacturerSerialNumberSpecified -
notes
A small note about a piece of hardware to use at your discretion. -
notesSpecified
protected boolean notesSpecified -
postInstallScriptUri
URI of the script to be downloaded and executed after installation is complete. -
postInstallScriptUriSpecified
protected boolean postInstallScriptUriSpecified -
provisionDate
-
provisionDateSpecified
protected boolean provisionDateSpecified -
serialNumber
A hardware's serial number that is supplied by SoftLayer. -
serialNumberSpecified
protected boolean serialNumberSpecified -
serviceProviderId
-
serviceProviderIdSpecified
protected boolean serviceProviderIdSpecified -
serviceProviderResourceId
A hardware's internal identification number at its service provider -
serviceProviderResourceIdSpecified
protected boolean serviceProviderResourceIdSpecified -
activeComponentCount
A count of a piece of hardware's active physical components. -
activeNetworkMonitorIncidentCount
A count of a piece of hardware's active network monitoring incidents. -
allPowerComponentCount
A count of -
allowedNetworkStorageCount
A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. -
allowedNetworkStorageReplicaCount
A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. -
attributeCount
A count of information regarding a piece of hardware's specific attributes. -
backendNetworkComponentCount
A count of a piece of hardware's back-end or private network components. -
backendRouterCount
A count of a hardware's backend or private router. -
benchmarkCertificationCount
A count of information regarding a piece of hardware's benchmark certifications. -
childrenHardwareCount
A count of child hardware. -
componentCount
A count of a piece of hardware's components. -
downlinkHardwareCount
A count of all hardware that has uplink network connections to a piece of hardware. -
downlinkNetworkHardwareCount
A count of all hardware that has uplink network connections to a piece of hardware. -
downlinkServerCount
A count of information regarding all servers attached to a piece of network hardware. -
downlinkVirtualGuestCount
A count of information regarding all virtual guests attached to a piece of network hardware. -
downstreamHardwareBindingCount
A count of all hardware downstream from a network device. -
downstreamNetworkHardwareCount
A count of all network hardware downstream from the selected piece of hardware. -
downstreamNetworkHardwareWithIncidentCount
A count of all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. -
downstreamServerCount
A count of information regarding all servers attached downstream to a piece of network hardware. -
downstreamVirtualGuestCount
A count of information regarding all virtual guests attached to a piece of network hardware. -
driveControllerCount
A count of the drive controllers contained within a piece of hardware. -
evaultNetworkStorageCount
A count of information regarding a piece of hardware's associated EVault network storage service account. -
frontendNetworkComponentCount
A count of a piece of hardware's front-end or public network components. -
frontendRouterCount
A count of a hardware's frontend or public router. -
hardDriveCount
A count of the hard drives contained within a piece of hardware. -
memoryCount
A count of information regarding a piece of hardware's memory. -
moduleCount
A count of -
networkCardCount
A count of information regarding a piece of hardware's network cards. -
networkComponentCount
A count of returns a hardware's network components. -
networkMonitorAttachedDownHardwareCount
A count of all servers with failed monitoring that are attached downstream to a piece of hardware. -
networkMonitorAttachedDownVirtualGuestCount
A count of virtual guests that are attached downstream to a hardware that have failed monitoring -
networkMonitorCount
A count of information regarding a piece of hardware's network monitors. -
networkMonitorIncidentCount
A count of the status of all of a piece of hardware's network monitoring incidents. -
networkStorageCount
A count of information regarding a piece of hardware's associated network storage service account. -
networkVlanCount
A count of the network virtual LANs (VLANs) associated with a piece of hardware's network components. -
notesHistoryCount
A count of -
nvRamComponentModelCount
A count of -
powerComponentCount
A count of the power components for a hardware object. -
powerSupplyCount
A count of information regarding a piece of hardware's power supply. -
processorCount
A count of information regarding a piece of hardware's processors. -
raidControllerCount
A count of the RAID controllers contained within a piece of hardware. -
recentEventCount
A count of recent events that impact this hardware. -
remoteManagementAccountCount
A count of user credentials to issue commands and/or interact with the server's remote management card. -
resourceConfigurationCount
A count of -
resourceGroupCount
A count of the resource groups in which this hardware is a member. -
resourceGroupMemberReferenceCount
A count of -
resourceGroupRoleCount
A count of -
routerCount
A count of a hardware's routers. -
scaleAssetCount
A count of collection of scale assets this hardware corresponds to. -
securityScanRequestCount
A count of information regarding a piece of hardware's vulnerability scan requests. -
softwareComponentCount
A count of information regarding a piece of hardware's installed software. -
sshKeyCount
A count of sSH keys to be installed on the server during provisioning or an OS reload. -
storageGroupCount
A count of -
storageNetworkComponentCount
A count of a piece of hardware's private storage network components. [Deprecated] -
tagReferenceCount
A count of -
uplinkNetworkComponentCount
A count of information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. -
userDataCount
A count of an array containing a single string of custom user data for a hardware order. Max size is 16 kb. -
virtualChassisSiblingCount
A count of information regarding the virtual chassis siblings for a piece of hardware. -
virtualLicenseCount
A count of information regarding a piece of hardware's virtual software licenses.
-
-
Constructor Details
-
Hardware
public Hardware()
-
-
Method Details
-
getAccount
-
setAccount
-
getActiveComponents
-
getActiveNetworkMonitorIncident
-
getAllPowerComponents
-
getAllowedHost
-
setAllowedHost
-
getAllowedNetworkStorage
-
getAllowedNetworkStorageReplicas
-
getAntivirusSpywareSoftwareComponent
-
setAntivirusSpywareSoftwareComponent
-
getAttributes
-
getAverageDailyPublicBandwidthUsage
-
setAverageDailyPublicBandwidthUsage
-
getBackendNetworkComponents
-
getBackendRouters
-
getBandwidthAllocation
-
setBandwidthAllocation
-
getBandwidthAllotmentDetail
-
setBandwidthAllotmentDetail
-
getBenchmarkCertifications
-
getBillingItem
-
setBillingItem
-
getBillingItemFlag
-
setBillingItemFlag
-
getBlockCancelBecauseDisconnectedFlag
-
setBlockCancelBecauseDisconnectedFlag
-
getBusinessContinuanceInsuranceFlag
-
setBusinessContinuanceInsuranceFlag
-
getChildrenHardware
-
getComponents
-
getContinuousDataProtectionSoftwareComponent
-
setContinuousDataProtectionSoftwareComponent
public void setContinuousDataProtectionSoftwareComponent(Component continuousDataProtectionSoftwareComponent) -
getCurrentBillableBandwidthUsage
-
setCurrentBillableBandwidthUsage
-
getDatacenter
-
setDatacenter
-
getDatacenterName
-
setDatacenterName
-
getDaysInSparePool
-
setDaysInSparePool
-
getDownlinkHardware
-
getDownlinkNetworkHardware
-
getDownlinkServers
-
getDownlinkVirtualGuests
-
getDownstreamHardwareBindings
-
getDownstreamNetworkHardware
-
getDownstreamNetworkHardwareWithIncidents
-
getDownstreamServers
-
getDownstreamVirtualGuests
-
getDriveControllers
-
getEvaultNetworkStorage
-
getFirewallServiceComponent
-
setFirewallServiceComponent
-
getFixedConfigurationPreset
-
setFixedConfigurationPreset
-
getFrontendNetworkComponents
-
getFrontendRouters
-
getGlobalIdentifier
-
setGlobalIdentifier
-
getHardDrives
-
getHardwareChassis
-
setHardwareChassis
-
getHardwareFunction
-
setHardwareFunction
-
getHardwareFunctionDescription
-
setHardwareFunctionDescription
-
getHardwareStatus
-
setHardwareStatus
-
getHasTrustedPlatformModuleBillingItemFlag
-
setHasTrustedPlatformModuleBillingItemFlag
public void setHasTrustedPlatformModuleBillingItemFlag(Boolean hasTrustedPlatformModuleBillingItemFlag) -
getHostIpsSoftwareComponent
-
setHostIpsSoftwareComponent
-
getHourlyBillingFlag
-
setHourlyBillingFlag
-
getInboundBandwidthUsage
-
setInboundBandwidthUsage
-
getInboundPublicBandwidthUsage
-
setInboundPublicBandwidthUsage
-
getLastTransaction
-
setLastTransaction
-
getLatestNetworkMonitorIncident
-
setLatestNetworkMonitorIncident
-
getLocation
-
setLocation
-
getLocationPathString
-
setLocationPathString
-
getLockboxNetworkStorage
-
setLockboxNetworkStorage
-
getManagedResourceFlag
-
setManagedResourceFlag
-
getMemory
-
getMemoryCapacity
-
setMemoryCapacity
-
getMetricTrackingObject
-
setMetricTrackingObject
-
getModules
-
getMonitoringServiceComponent
-
setMonitoringServiceComponent
-
getMotherboard
-
setMotherboard
-
getNetworkCards
-
getNetworkComponents
-
getNetworkGatewayMember
-
setNetworkGatewayMember
-
getNetworkGatewayMemberFlag
-
setNetworkGatewayMemberFlag
-
getNetworkManagementIpAddress
-
setNetworkManagementIpAddress
-
getNetworkMonitorAttachedDownHardware
-
getNetworkMonitorAttachedDownVirtualGuests
-
getNetworkMonitorIncidents
-
getNetworkMonitors
-
getNetworkStatus
-
setNetworkStatus
-
getNetworkStatusAttribute
-
setNetworkStatusAttribute
-
getNetworkStorage
-
getNetworkVlans
-
getNextBillingCycleBandwidthAllocation
-
setNextBillingCycleBandwidthAllocation
-
getNotesHistory
-
getNvRamCapacity
-
setNvRamCapacity
-
getNvRamComponentModels
-
getOperatingSystem
-
setOperatingSystem
-
getOperatingSystemReferenceCode
-
setOperatingSystemReferenceCode
-
getOutboundBandwidthUsage
-
setOutboundBandwidthUsage
-
getOutboundPublicBandwidthUsage
-
setOutboundPublicBandwidthUsage
-
getParentBay
-
setParentBay
-
getParentHardware
-
setParentHardware
-
getPointOfPresenceLocation
-
setPointOfPresenceLocation
-
getPowerComponents
-
getPowerSupply
-
getPrimaryBackendIpAddress
-
setPrimaryBackendIpAddress
-
getPrimaryBackendNetworkComponent
-
setPrimaryBackendNetworkComponent
-
getPrimaryIpAddress
-
setPrimaryIpAddress
-
getPrimaryNetworkComponent
-
setPrimaryNetworkComponent
-
getPrivateNetworkOnlyFlag
-
setPrivateNetworkOnlyFlag
-
getProcessorCoreAmount
-
setProcessorCoreAmount
-
getProcessorPhysicalCoreAmount
-
setProcessorPhysicalCoreAmount
-
getProcessors
-
getRack
-
setRack
-
getRaidControllers
-
getRecentEvents
-
getRemoteManagementAccounts
-
getRemoteManagementComponent
-
setRemoteManagementComponent
-
getResourceConfigurations
-
getResourceGroupMemberReferences
-
getResourceGroupRoles
-
getResourceGroups
-
getRouters
-
getScaleAssets
-
getSecurityScanRequests
-
getServerRoom
-
setServerRoom
-
getServiceProvider
-
setServiceProvider
-
getSoftwareComponents
-
getSparePoolBillingItem
-
setSparePoolBillingItem
-
getSshKeys
-
getStorageGroups
-
getStorageNetworkComponents
-
getTagReferences
-
getTopLevelLocation
-
setTopLevelLocation
-
getUpgradeRequest
-
setUpgradeRequest
-
getUplinkHardware
-
setUplinkHardware
-
getUplinkNetworkComponents
-
getUserData
-
getVirtualChassis
-
setVirtualChassis
-
getVirtualChassisSiblings
-
getVirtualHost
-
setVirtualHost
-
getVirtualLicenses
-
getVirtualRack
-
setVirtualRack
-
getVirtualRackId
-
setVirtualRackId
-
getVirtualRackName
-
setVirtualRackName
-
getVirtualizationPlatform
-
setVirtualizationPlatform
-
getAccountId
-
setAccountId
-
isAccountIdSpecified
public boolean isAccountIdSpecified() -
unsetAccountId
public void unsetAccountId() -
getBareMetalInstanceFlag
-
setBareMetalInstanceFlag
-
isBareMetalInstanceFlagSpecified
public boolean isBareMetalInstanceFlagSpecified() -
unsetBareMetalInstanceFlag
public void unsetBareMetalInstanceFlag() -
getDomain
-
setDomain
-
isDomainSpecified
public boolean isDomainSpecified() -
unsetDomain
public void unsetDomain() -
getFullyQualifiedDomainName
-
setFullyQualifiedDomainName
-
isFullyQualifiedDomainNameSpecified
public boolean isFullyQualifiedDomainNameSpecified() -
unsetFullyQualifiedDomainName
public void unsetFullyQualifiedDomainName() -
getHardwareStatusId
-
setHardwareStatusId
-
isHardwareStatusIdSpecified
public boolean isHardwareStatusIdSpecified() -
unsetHardwareStatusId
public void unsetHardwareStatusId() -
getHostname
-
setHostname
-
isHostnameSpecified
public boolean isHostnameSpecified() -
unsetHostname
public void unsetHostname() -
getId
-
setId
-
isIdSpecified
public boolean isIdSpecified() -
unsetId
public void unsetId() -
getManufacturerSerialNumber
-
setManufacturerSerialNumber
-
isManufacturerSerialNumberSpecified
public boolean isManufacturerSerialNumberSpecified() -
unsetManufacturerSerialNumber
public void unsetManufacturerSerialNumber() -
getNotes
-
setNotes
-
isNotesSpecified
public boolean isNotesSpecified() -
unsetNotes
public void unsetNotes() -
getPostInstallScriptUri
-
setPostInstallScriptUri
-
isPostInstallScriptUriSpecified
public boolean isPostInstallScriptUriSpecified() -
unsetPostInstallScriptUri
public void unsetPostInstallScriptUri() -
getProvisionDate
-
setProvisionDate
-
isProvisionDateSpecified
public boolean isProvisionDateSpecified() -
unsetProvisionDate
public void unsetProvisionDate() -
getSerialNumber
-
setSerialNumber
-
isSerialNumberSpecified
public boolean isSerialNumberSpecified() -
unsetSerialNumber
public void unsetSerialNumber() -
getServiceProviderId
-
setServiceProviderId
-
isServiceProviderIdSpecified
public boolean isServiceProviderIdSpecified() -
unsetServiceProviderId
public void unsetServiceProviderId() -
getServiceProviderResourceId
-
setServiceProviderResourceId
-
isServiceProviderResourceIdSpecified
public boolean isServiceProviderResourceIdSpecified() -
unsetServiceProviderResourceId
public void unsetServiceProviderResourceId() -
getActiveComponentCount
-
setActiveComponentCount
-
getActiveNetworkMonitorIncidentCount
-
setActiveNetworkMonitorIncidentCount
-
getAllPowerComponentCount
-
setAllPowerComponentCount
-
getAllowedNetworkStorageCount
-
setAllowedNetworkStorageCount
-
getAllowedNetworkStorageReplicaCount
-
setAllowedNetworkStorageReplicaCount
-
getAttributeCount
-
setAttributeCount
-
getBackendNetworkComponentCount
-
setBackendNetworkComponentCount
-
getBackendRouterCount
-
setBackendRouterCount
-
getBenchmarkCertificationCount
-
setBenchmarkCertificationCount
-
getChildrenHardwareCount
-
setChildrenHardwareCount
-
getComponentCount
-
setComponentCount
-
getDownlinkHardwareCount
-
setDownlinkHardwareCount
-
getDownlinkNetworkHardwareCount
-
setDownlinkNetworkHardwareCount
-
getDownlinkServerCount
-
setDownlinkServerCount
-
getDownlinkVirtualGuestCount
-
setDownlinkVirtualGuestCount
-
getDownstreamHardwareBindingCount
-
setDownstreamHardwareBindingCount
-
getDownstreamNetworkHardwareCount
-
setDownstreamNetworkHardwareCount
-
getDownstreamNetworkHardwareWithIncidentCount
-
setDownstreamNetworkHardwareWithIncidentCount
public void setDownstreamNetworkHardwareWithIncidentCount(Long downstreamNetworkHardwareWithIncidentCount) -
getDownstreamServerCount
-
setDownstreamServerCount
-
getDownstreamVirtualGuestCount
-
setDownstreamVirtualGuestCount
-
getDriveControllerCount
-
setDriveControllerCount
-
getEvaultNetworkStorageCount
-
setEvaultNetworkStorageCount
-
getFrontendNetworkComponentCount
-
setFrontendNetworkComponentCount
-
getFrontendRouterCount
-
setFrontendRouterCount
-
getHardDriveCount
-
setHardDriveCount
-
getMemoryCount
-
setMemoryCount
-
getModuleCount
-
setModuleCount
-
getNetworkCardCount
-
setNetworkCardCount
-
getNetworkComponentCount
-
setNetworkComponentCount
-
getNetworkMonitorAttachedDownHardwareCount
-
setNetworkMonitorAttachedDownHardwareCount
public void setNetworkMonitorAttachedDownHardwareCount(Long networkMonitorAttachedDownHardwareCount) -
getNetworkMonitorAttachedDownVirtualGuestCount
-
setNetworkMonitorAttachedDownVirtualGuestCount
public void setNetworkMonitorAttachedDownVirtualGuestCount(Long networkMonitorAttachedDownVirtualGuestCount) -
getNetworkMonitorCount
-
setNetworkMonitorCount
-
getNetworkMonitorIncidentCount
-
setNetworkMonitorIncidentCount
-
getNetworkStorageCount
-
setNetworkStorageCount
-
getNetworkVlanCount
-
setNetworkVlanCount
-
getNotesHistoryCount
-
setNotesHistoryCount
-
getNvRamComponentModelCount
-
setNvRamComponentModelCount
-
getPowerComponentCount
-
setPowerComponentCount
-
getPowerSupplyCount
-
setPowerSupplyCount
-
getProcessorCount
-
setProcessorCount
-
getRaidControllerCount
-
setRaidControllerCount
-
getRecentEventCount
-
setRecentEventCount
-
getRemoteManagementAccountCount
-
setRemoteManagementAccountCount
-
getResourceConfigurationCount
-
setResourceConfigurationCount
-
getResourceGroupCount
-
setResourceGroupCount
-
getResourceGroupMemberReferenceCount
-
setResourceGroupMemberReferenceCount
-
getResourceGroupRoleCount
-
setResourceGroupRoleCount
-
getRouterCount
-
setRouterCount
-
getScaleAssetCount
-
setScaleAssetCount
-
getSecurityScanRequestCount
-
setSecurityScanRequestCount
-
getSoftwareComponentCount
-
setSoftwareComponentCount
-
getSshKeyCount
-
setSshKeyCount
-
getStorageGroupCount
-
setStorageGroupCount
-
getStorageNetworkComponentCount
-
setStorageNetworkComponentCount
-
getTagReferenceCount
-
setTagReferenceCount
-
getUplinkNetworkComponentCount
-
setUplinkNetworkComponentCount
-
getUserDataCount
-
setUserDataCount
-
getVirtualChassisSiblingCount
-
setVirtualChassisSiblingCount
-
getVirtualLicenseCount
-
setVirtualLicenseCount
-
asService
-
service
-
service
-
service
-