Package com.softlayer.api.service.hardware

Class Server

java.lang.Object
com.softlayer.api.Type
com.softlayer.api.service.Entity
com.softlayer.api.service.Hardware
com.softlayer.api.service.hardware.Server
Direct Known Subclasses:
SecurityModule
@ApiType("SoftLayer_Hardware_Server")
public class Server
extends Hardware
The SoftLayer_Hardware_Server data type contains general information relating to a single SoftLayer server.
See Also:
SoftLayer_Hardware_Server

  • Field Details

    • activeNetworkFirewallBillingItem

      @ApiProperty protected Item activeNetworkFirewallBillingItem
      The billing item for a server's attached network firewall.

    • activeTickets

      @ApiProperty protected List<Ticket> activeTickets

    • activeTransaction

      @ApiProperty protected Transaction activeTransaction
      Transaction currently running for server.

    • activeTransactions

      @ApiProperty protected List<Transaction> activeTransactions
      Any active transaction(s) that are currently running for the server (example: os reload).

    • availableMonitoring

      @ApiProperty protected List<Stratum> availableMonitoring
      An object that stores the maximum level for the monitoring query types and response types.

    • averageDailyBandwidthUsage

      @ApiProperty protected BigDecimal averageDailyBandwidthUsage
      The average daily total bandwidth usage for the current billing cycle.

    • averageDailyPrivateBandwidthUsage

      @ApiProperty protected BigDecimal averageDailyPrivateBandwidthUsage
      The average daily private bandwidth usage for the current billing cycle.

    • billingCycleBandwidthUsage

      @ApiProperty protected List<Usage> billingCycleBandwidthUsage
      The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.

    • billingCyclePrivateBandwidthUsage

      @ApiProperty protected Usage billingCyclePrivateBandwidthUsage
      The raw private bandwidth usage data for the current billing cycle.

    • billingCyclePublicBandwidthUsage

      @ApiProperty protected Usage billingCyclePublicBandwidthUsage
      The raw public bandwidth usage data for the current billing cycle.

    • biosPasswordNullFlag

      @ApiProperty protected Boolean biosPasswordNullFlag
      Determine if BIOS password should be left as null.

    • captureEnabledFlag

      @ApiProperty protected CaptureEnabled captureEnabledFlag
      Determine if the server is able to be image captured. If unable to image capture a reason will be provided.

    • containsSolidStateDrivesFlag

      @ApiProperty protected Boolean containsSolidStateDrivesFlag

    • controlPanel

      @ApiProperty protected ControlPanel controlPanel
      A server's control panel.

    • cost

      @ApiProperty protected BigDecimal cost
      The total cost of a server, measured in US Dollars ($USD).

    • currentBandwidthSummary

      @ApiProperty protected Summary currentBandwidthSummary
      An object that provides commonly used bandwidth summary components for the current billing cycle.

    • customerInstalledOperatingSystemFlag

      @ApiProperty protected Boolean customerInstalledOperatingSystemFlag
      Indicates if a server has a Customer Installed OS

    • customerOwnedFlag

      @ApiProperty protected Boolean customerOwnedFlag
      Indicates if a server is a customer owned device.

    • hasSingleRootVirtualizationBillingItemFlag

      @ApiProperty protected Boolean hasSingleRootVirtualizationBillingItemFlag
      Determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item.

    • inboundPrivateBandwidthUsage

      @ApiProperty protected BigDecimal inboundPrivateBandwidthUsage
      The total private inbound bandwidth for this hardware for the current billing cycle.

    • isCloudReadyNodeCertified

      @ApiProperty protected Boolean isCloudReadyNodeCertified
      Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute.

    • isIpmiDisabled

      @ApiProperty protected Boolean isIpmiDisabled
      Determine if remote management has been disabled due to port speed.

    • isVirtualPrivateCloudNode

      @ApiProperty protected Boolean isVirtualPrivateCloudNode
      Determine if hardware object is a Virtual Private Cloud node.

    • lastOperatingSystemReload

      @ApiProperty protected Transaction lastOperatingSystemReload
      The last transaction that a server's operating system was loaded.

    • logicalVolumeStorageGroups

      @ApiProperty protected List<Group> logicalVolumeStorageGroups
      Returns a list of logical volumes on the physical machine.

    • metricTrackingObjectId

      @ApiProperty protected Long metricTrackingObjectId
      The metric tracking object id for this server.

    • monitoringUserNotification

      @ApiProperty protected List<Hardware> monitoringUserNotification
      The monitoring notification objects for this hardware. Each object links this hardware instance to a user account that will be notified if monitoring on this hardware object fails

    • openCancellationTicket

      @ApiProperty protected Ticket openCancellationTicket
      An open ticket requesting cancellation of this server, if one exists.

    • outboundPrivateBandwidthUsage

      @ApiProperty protected BigDecimal outboundPrivateBandwidthUsage
      The total private outbound bandwidth for this hardware for the current billing cycle.

    • overBandwidthAllocationFlag

      @ApiProperty protected Long overBandwidthAllocationFlag
      Whether the bandwidth usage for this hardware for the current billing cycle exceeds the allocation.

    • privateIpAddress

      @ApiProperty protected String privateIpAddress
      A server's primary private IP address.

    • projectedOverBandwidthAllocationFlag

      @ApiProperty protected Long projectedOverBandwidthAllocationFlag
      Whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation.

    • projectedPublicBandwidthUsage

      @ApiProperty protected BigDecimal projectedPublicBandwidthUsage
      The projected public outbound bandwidth for this hardware for the current billing cycle.

    • readyNodeFlag

      @ApiProperty protected Boolean readyNodeFlag
      Determine if hardware object is vSan Ready Node.

    • recentRemoteManagementCommands

      @ApiProperty protected List<Request> recentRemoteManagementCommands
      The last five commands issued to the server's remote management card.

    • regionalInternetRegistry

      @ApiProperty protected Registry regionalInternetRegistry

    • remoteManagement

      @ApiProperty protected RemoteManagement remoteManagement
      A server's remote management card.

    • remoteManagementUsers

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

    • softwareGuardExtensionEnabled

      @ApiProperty protected Boolean softwareGuardExtensionEnabled
      Determine if hardware object has Software Guard Extension (SGX) enabled.

    • statisticsRemoteManagement

      @ApiProperty protected RemoteManagement statisticsRemoteManagement
      A server's remote management card used for statistics.

    • uefiBootFlag

      @ApiProperty protected Boolean uefiBootFlag
      Whether to use UEFI boot instead of BIOS.

    • users

      @ApiProperty protected List<Customer> users
      A list of users that have access to this computing instance.

    • virtualGuests

      @ApiProperty protected List<Guest> virtualGuests
      A hardware server's virtual servers.

    • activeTicketCount

      @ApiProperty protected Long activeTicketCount
      A count of

    • activeTransactionCount

      @ApiProperty protected Long activeTransactionCount
      A count of any active transaction(s) that are currently running for the server (example: os reload).

    • availableMonitoringCount

      @ApiProperty protected Long availableMonitoringCount
      A count of an object that stores the maximum level for the monitoring query types and response types.

    • billingCycleBandwidthUsageCount

      @ApiProperty protected Long billingCycleBandwidthUsageCount
      A count of the raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.

    • logicalVolumeStorageGroupCount

      @ApiProperty protected Long logicalVolumeStorageGroupCount
      A count of returns a list of logical volumes on the physical machine.

    • monitoringUserNotificationCount

      @ApiProperty protected Long monitoringUserNotificationCount
      A count of the monitoring notification objects for this hardware. Each object links this hardware instance to a user account that will be notified if monitoring on this hardware object fails

    • recentRemoteManagementCommandCount

      @ApiProperty protected Long recentRemoteManagementCommandCount
      A count of the last five commands issued to the server's remote management card.

    • remoteManagementUserCount

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

    • userCount

      @ApiProperty protected Long userCount
      A count of a list of users that have access to this computing instance.

    • virtualGuestCount

      @ApiProperty protected Long virtualGuestCount
      A count of a hardware server's virtual servers.

  • Constructor Details

    • Server

      public Server()

  • Method Details

    • getActiveNetworkFirewallBillingItem

      public Item getActiveNetworkFirewallBillingItem()

    • setActiveNetworkFirewallBillingItem

      public void setActiveNetworkFirewallBillingItem​(Item activeNetworkFirewallBillingItem)

    • getActiveTickets

      public List<Ticket> getActiveTickets()

    • getActiveTransaction

      public Transaction getActiveTransaction()

    • setActiveTransaction

      public void setActiveTransaction​(Transaction activeTransaction)

    • getActiveTransactions

      public List<Transaction> getActiveTransactions()

    • getAvailableMonitoring

      public List<Stratum> getAvailableMonitoring()

    • getAverageDailyBandwidthUsage

      public BigDecimal getAverageDailyBandwidthUsage()

    • setAverageDailyBandwidthUsage

      public void setAverageDailyBandwidthUsage​(BigDecimal averageDailyBandwidthUsage)

    • getAverageDailyPrivateBandwidthUsage

      public BigDecimal getAverageDailyPrivateBandwidthUsage()

    • setAverageDailyPrivateBandwidthUsage

      public void setAverageDailyPrivateBandwidthUsage​(BigDecimal averageDailyPrivateBandwidthUsage)

    • getBillingCycleBandwidthUsage

      public List<Usage> getBillingCycleBandwidthUsage()

    • getBillingCyclePrivateBandwidthUsage

      public Usage getBillingCyclePrivateBandwidthUsage()

    • setBillingCyclePrivateBandwidthUsage

      public void setBillingCyclePrivateBandwidthUsage​(Usage billingCyclePrivateBandwidthUsage)

    • getBillingCyclePublicBandwidthUsage

      public Usage getBillingCyclePublicBandwidthUsage()

    • setBillingCyclePublicBandwidthUsage

      public void setBillingCyclePublicBandwidthUsage​(Usage billingCyclePublicBandwidthUsage)

    • getBiosPasswordNullFlag

      public Boolean getBiosPasswordNullFlag()

    • setBiosPasswordNullFlag

      public void setBiosPasswordNullFlag​(Boolean biosPasswordNullFlag)

    • getCaptureEnabledFlag

      public CaptureEnabled getCaptureEnabledFlag()

    • setCaptureEnabledFlag

      public void setCaptureEnabledFlag​(CaptureEnabled captureEnabledFlag)

    • getContainsSolidStateDrivesFlag

      public Boolean getContainsSolidStateDrivesFlag()

    • setContainsSolidStateDrivesFlag

      public void setContainsSolidStateDrivesFlag​(Boolean containsSolidStateDrivesFlag)

    • getControlPanel

      public ControlPanel getControlPanel()

    • setControlPanel

      public void setControlPanel​(ControlPanel controlPanel)

    • getCost

      public BigDecimal getCost()

    • setCost

      public void setCost​(BigDecimal cost)

    • getCurrentBandwidthSummary

      public Summary getCurrentBandwidthSummary()

    • setCurrentBandwidthSummary

      public void setCurrentBandwidthSummary​(Summary currentBandwidthSummary)

    • getCustomerInstalledOperatingSystemFlag

      public Boolean getCustomerInstalledOperatingSystemFlag()

    • setCustomerInstalledOperatingSystemFlag

      public void setCustomerInstalledOperatingSystemFlag​(Boolean customerInstalledOperatingSystemFlag)

    • getCustomerOwnedFlag

      public Boolean getCustomerOwnedFlag()

    • setCustomerOwnedFlag

      public void setCustomerOwnedFlag​(Boolean customerOwnedFlag)

    • getHasSingleRootVirtualizationBillingItemFlag

      public Boolean getHasSingleRootVirtualizationBillingItemFlag()

    • setHasSingleRootVirtualizationBillingItemFlag

      public void setHasSingleRootVirtualizationBillingItemFlag​(Boolean hasSingleRootVirtualizationBillingItemFlag)

    • getInboundPrivateBandwidthUsage

      public BigDecimal getInboundPrivateBandwidthUsage()

    • setInboundPrivateBandwidthUsage

      public void setInboundPrivateBandwidthUsage​(BigDecimal inboundPrivateBandwidthUsage)

    • getIsCloudReadyNodeCertified

      public Boolean getIsCloudReadyNodeCertified()

    • setIsCloudReadyNodeCertified

      public void setIsCloudReadyNodeCertified​(Boolean isCloudReadyNodeCertified)

    • getIsIpmiDisabled

      public Boolean getIsIpmiDisabled()

    • setIsIpmiDisabled

      public void setIsIpmiDisabled​(Boolean isIpmiDisabled)

    • getIsVirtualPrivateCloudNode

      public Boolean getIsVirtualPrivateCloudNode()

    • setIsVirtualPrivateCloudNode

      public void setIsVirtualPrivateCloudNode​(Boolean isVirtualPrivateCloudNode)

    • getLastOperatingSystemReload

      public Transaction getLastOperatingSystemReload()

    • setLastOperatingSystemReload

      public void setLastOperatingSystemReload​(Transaction lastOperatingSystemReload)

    • getLogicalVolumeStorageGroups

      public List<Group> getLogicalVolumeStorageGroups()

    • getMetricTrackingObjectId

      public Long getMetricTrackingObjectId()

    • setMetricTrackingObjectId

      public void setMetricTrackingObjectId​(Long metricTrackingObjectId)

    • getMonitoringUserNotification

      public List<Hardware> getMonitoringUserNotification()

    • getOpenCancellationTicket

      public Ticket getOpenCancellationTicket()

    • setOpenCancellationTicket

      public void setOpenCancellationTicket​(Ticket openCancellationTicket)

    • getOutboundPrivateBandwidthUsage

      public BigDecimal getOutboundPrivateBandwidthUsage()

    • setOutboundPrivateBandwidthUsage

      public void setOutboundPrivateBandwidthUsage​(BigDecimal outboundPrivateBandwidthUsage)

    • getOverBandwidthAllocationFlag

      public Long getOverBandwidthAllocationFlag()

    • setOverBandwidthAllocationFlag

      public void setOverBandwidthAllocationFlag​(Long overBandwidthAllocationFlag)

    • getPrivateIpAddress

      public String getPrivateIpAddress()

    • setPrivateIpAddress

      public void setPrivateIpAddress​(String privateIpAddress)

    • getProjectedOverBandwidthAllocationFlag

      public Long getProjectedOverBandwidthAllocationFlag()

    • setProjectedOverBandwidthAllocationFlag

      public void setProjectedOverBandwidthAllocationFlag​(Long projectedOverBandwidthAllocationFlag)

    • getProjectedPublicBandwidthUsage

      public BigDecimal getProjectedPublicBandwidthUsage()

    • setProjectedPublicBandwidthUsage

      public void setProjectedPublicBandwidthUsage​(BigDecimal projectedPublicBandwidthUsage)

    • getReadyNodeFlag

      public Boolean getReadyNodeFlag()

    • setReadyNodeFlag

      public void setReadyNodeFlag​(Boolean readyNodeFlag)

    • getRecentRemoteManagementCommands

      public List<Request> getRecentRemoteManagementCommands()

    • getRegionalInternetRegistry

      public Registry getRegionalInternetRegistry()

    • setRegionalInternetRegistry

      public void setRegionalInternetRegistry​(Registry regionalInternetRegistry)

    • getRemoteManagement

      public RemoteManagement getRemoteManagement()

    • setRemoteManagement

      public void setRemoteManagement​(RemoteManagement remoteManagement)

    • getRemoteManagementUsers

      public List<User> getRemoteManagementUsers()

    • getSoftwareGuardExtensionEnabled

      public Boolean getSoftwareGuardExtensionEnabled()

    • setSoftwareGuardExtensionEnabled

      public void setSoftwareGuardExtensionEnabled​(Boolean softwareGuardExtensionEnabled)

    • getStatisticsRemoteManagement

      public RemoteManagement getStatisticsRemoteManagement()

    • setStatisticsRemoteManagement

      public void setStatisticsRemoteManagement​(RemoteManagement statisticsRemoteManagement)

    • getUefiBootFlag

      public Boolean getUefiBootFlag()

    • setUefiBootFlag

      public void setUefiBootFlag​(Boolean uefiBootFlag)

    • getUsers

      public List<Customer> getUsers()

    • getVirtualGuests

      public List<Guest> getVirtualGuests()

    • getActiveTicketCount

      public Long getActiveTicketCount()

    • setActiveTicketCount

      public void setActiveTicketCount​(Long activeTicketCount)

    • getActiveTransactionCount

      public Long getActiveTransactionCount()

    • setActiveTransactionCount

      public void setActiveTransactionCount​(Long activeTransactionCount)

    • getAvailableMonitoringCount

      public Long getAvailableMonitoringCount()

    • setAvailableMonitoringCount

      public void setAvailableMonitoringCount​(Long availableMonitoringCount)

    • getBillingCycleBandwidthUsageCount

      public Long getBillingCycleBandwidthUsageCount()

    • setBillingCycleBandwidthUsageCount

      public void setBillingCycleBandwidthUsageCount​(Long billingCycleBandwidthUsageCount)

    • getLogicalVolumeStorageGroupCount

      public Long getLogicalVolumeStorageGroupCount()

    • setLogicalVolumeStorageGroupCount

      public void setLogicalVolumeStorageGroupCount​(Long logicalVolumeStorageGroupCount)

    • getMonitoringUserNotificationCount

      public Long getMonitoringUserNotificationCount()

    • setMonitoringUserNotificationCount

      public void setMonitoringUserNotificationCount​(Long monitoringUserNotificationCount)

    • getRecentRemoteManagementCommandCount

      public Long getRecentRemoteManagementCommandCount()

    • setRecentRemoteManagementCommandCount

      public void setRecentRemoteManagementCommandCount​(Long recentRemoteManagementCommandCount)

    • getRemoteManagementUserCount

      public Long getRemoteManagementUserCount()

    • setRemoteManagementUserCount

      public void setRemoteManagementUserCount​(Long remoteManagementUserCount)

    • getUserCount

      public Long getUserCount()

    • setUserCount

      public void setUserCount​(Long userCount)

    • getVirtualGuestCount

      public Long getVirtualGuestCount()

    • setVirtualGuestCount

      public void setVirtualGuestCount​(Long virtualGuestCount)

    • asService

      public Server.Service asService​(ApiClient client)
      Overrides:
      asService in class Hardware

    • service

      public static Server.Service service​(ApiClient client)

    • service

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

    • service

      public static Server.Service service​(ApiClient client, String globalIdentifier)