com.softlayer.api.service.hardware.Server Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
package com.softlayer.api.service.hardware;
import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiProperty;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.Ticket;
import com.softlayer.api.service.container.Graph;
import com.softlayer.api.service.container.bandwidth.GraphOutputs;
import com.softlayer.api.service.container.hardware.server.Configuration;
import com.softlayer.api.service.container.hardware.server.Details;
import com.softlayer.api.service.container.hardware.server.Request;
import com.softlayer.api.service.container.network.bandwidth.data.Summary;
import com.softlayer.api.service.container.remotemanagement.PmInfo;
import com.softlayer.api.service.container.remotemanagement.SensorReading;
import com.softlayer.api.service.container.remotemanagement.SensorReadingsWithGraphs;
import com.softlayer.api.service.container.remotemanagement.graphs.SensorSpeed;
import com.softlayer.api.service.container.remotemanagement.graphs.SensorTemperature;
import com.softlayer.api.service.container.utility.microsoft.windows.updateservices.Status;
import com.softlayer.api.service.container.utility.microsoft.windows.updateservices.UpdateItem;
import com.softlayer.api.service.dns.Domain;
import com.softlayer.api.service.hardware.Attribute;
import com.softlayer.api.service.hardware.component.Partition;
import com.softlayer.api.service.hardware.component.RemoteManagement;
import com.softlayer.api.service.hardware.component.remotemanagement.User;
import com.softlayer.api.service.metric.tracking.object.Data;
import com.softlayer.api.service.network.Component;
import com.softlayer.api.service.network.Subnet;
import com.softlayer.api.service.network.Vlan;
import com.softlayer.api.service.network.bandwidth.Usage;
import com.softlayer.api.service.network.bandwidth.version1.usage.Detail;
import com.softlayer.api.service.network.monitor.version1.query.host.Stratum;
import com.softlayer.api.service.network.regional.internet.Registry;
import com.softlayer.api.service.network.subnet.IpAddress;
import com.softlayer.api.service.product.Item;
import com.softlayer.api.service.provisioning.version1.Transaction;
import com.softlayer.api.service.software.Description;
import com.softlayer.api.service.software.component.ControlPanel;
import com.softlayer.api.service.user.Customer;
import com.softlayer.api.service.user.customer.notification.Hardware;
import com.softlayer.api.service.virtual.Guest;
import com.softlayer.api.service.virtual.guest.block.device.template.Group;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.GregorianCalendar;
import java.util.List;
import java.util.concurrent.Future;
/**
* The SoftLayer_Hardware_Server data type contains general information relating to a single SoftLayer server.
*
* @see SoftLayer_Hardware_Server
*/
@ApiType("SoftLayer_Hardware_Server")
public class Server extends com.softlayer.api.service.Hardware {
/**
* The billing item for a server's attached network firewall.
*/
@ApiProperty
protected com.softlayer.api.service.billing.Item activeNetworkFirewallBillingItem;
public com.softlayer.api.service.billing.Item getActiveNetworkFirewallBillingItem() {
return activeNetworkFirewallBillingItem;
}
public void setActiveNetworkFirewallBillingItem(com.softlayer.api.service.billing.Item activeNetworkFirewallBillingItem) {
this.activeNetworkFirewallBillingItem = activeNetworkFirewallBillingItem;
}
@ApiProperty
protected List activeTickets;
public List getActiveTickets() {
if (activeTickets == null) {
activeTickets = new ArrayList();
}
return activeTickets;
}
/**
* Transaction currently running for server.
*/
@ApiProperty
protected Transaction activeTransaction;
public Transaction getActiveTransaction() {
return activeTransaction;
}
public void setActiveTransaction(Transaction activeTransaction) {
this.activeTransaction = activeTransaction;
}
/**
* Any active transaction(s) that are currently running for the server (example: os reload).
*/
@ApiProperty
protected List activeTransactions;
public List getActiveTransactions() {
if (activeTransactions == null) {
activeTransactions = new ArrayList();
}
return activeTransactions;
}
/**
* An object that stores the maximum level for the monitoring query types and response types.
*/
@ApiProperty
protected List availableMonitoring;
public List getAvailableMonitoring() {
if (availableMonitoring == null) {
availableMonitoring = new ArrayList();
}
return availableMonitoring;
}
/**
* The average daily total bandwidth usage for the current billing cycle.
*/
@ApiProperty
protected BigDecimal averageDailyBandwidthUsage;
public BigDecimal getAverageDailyBandwidthUsage() {
return averageDailyBandwidthUsage;
}
public void setAverageDailyBandwidthUsage(BigDecimal averageDailyBandwidthUsage) {
this.averageDailyBandwidthUsage = averageDailyBandwidthUsage;
}
/**
* The average daily private bandwidth usage for the current billing cycle.
*/
@ApiProperty
protected BigDecimal averageDailyPrivateBandwidthUsage;
public BigDecimal getAverageDailyPrivateBandwidthUsage() {
return averageDailyPrivateBandwidthUsage;
}
public void setAverageDailyPrivateBandwidthUsage(BigDecimal averageDailyPrivateBandwidthUsage) {
this.averageDailyPrivateBandwidthUsage = averageDailyPrivateBandwidthUsage;
}
/**
* The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.
*/
@ApiProperty
protected List billingCycleBandwidthUsage;
public List getBillingCycleBandwidthUsage() {
if (billingCycleBandwidthUsage == null) {
billingCycleBandwidthUsage = new ArrayList();
}
return billingCycleBandwidthUsage;
}
/**
* The raw private bandwidth usage data for the current billing cycle.
*/
@ApiProperty
protected Usage billingCyclePrivateBandwidthUsage;
public Usage getBillingCyclePrivateBandwidthUsage() {
return billingCyclePrivateBandwidthUsage;
}
public void setBillingCyclePrivateBandwidthUsage(Usage billingCyclePrivateBandwidthUsage) {
this.billingCyclePrivateBandwidthUsage = billingCyclePrivateBandwidthUsage;
}
/**
* The raw public bandwidth usage data for the current billing cycle.
*/
@ApiProperty
protected Usage billingCyclePublicBandwidthUsage;
public Usage getBillingCyclePublicBandwidthUsage() {
return billingCyclePublicBandwidthUsage;
}
public void setBillingCyclePublicBandwidthUsage(Usage billingCyclePublicBandwidthUsage) {
this.billingCyclePublicBandwidthUsage = billingCyclePublicBandwidthUsage;
}
@ApiProperty
protected Boolean containsSolidStateDrivesFlag;
public Boolean getContainsSolidStateDrivesFlag() {
return containsSolidStateDrivesFlag;
}
public void setContainsSolidStateDrivesFlag(Boolean containsSolidStateDrivesFlag) {
this.containsSolidStateDrivesFlag = containsSolidStateDrivesFlag;
}
/**
* A server's control panel.
*/
@ApiProperty
protected ControlPanel controlPanel;
public ControlPanel getControlPanel() {
return controlPanel;
}
public void setControlPanel(ControlPanel controlPanel) {
this.controlPanel = controlPanel;
}
/**
* The total cost of a server, measured in US Dollars ($USD).
*/
@ApiProperty
protected BigDecimal cost;
public BigDecimal getCost() {
return cost;
}
public void setCost(BigDecimal cost) {
this.cost = cost;
}
/**
* An object that provides commonly used bandwidth summary components for the current billing cycle.
*/
@ApiProperty
protected com.softlayer.api.service.metric.tracking.object.bandwidth.Summary currentBandwidthSummary;
public com.softlayer.api.service.metric.tracking.object.bandwidth.Summary getCurrentBandwidthSummary() {
return currentBandwidthSummary;
}
public void setCurrentBandwidthSummary(com.softlayer.api.service.metric.tracking.object.bandwidth.Summary currentBandwidthSummary) {
this.currentBandwidthSummary = currentBandwidthSummary;
}
/**
* Indicates if a server has a Customer Installed OS
*/
@ApiProperty
protected Boolean customerInstalledOperatingSystemFlag;
public Boolean getCustomerInstalledOperatingSystemFlag() {
return customerInstalledOperatingSystemFlag;
}
public void setCustomerInstalledOperatingSystemFlag(Boolean customerInstalledOperatingSystemFlag) {
this.customerInstalledOperatingSystemFlag = customerInstalledOperatingSystemFlag;
}
/**
* Indicates if a server is a customer owned device.
*/
@ApiProperty
protected Boolean customerOwnedFlag;
public Boolean getCustomerOwnedFlag() {
return customerOwnedFlag;
}
public void setCustomerOwnedFlag(Boolean customerOwnedFlag) {
this.customerOwnedFlag = customerOwnedFlag;
}
/**
* The total private inbound bandwidth for this hardware for the current billing cycle.
*/
@ApiProperty
protected BigDecimal inboundPrivateBandwidthUsage;
public BigDecimal getInboundPrivateBandwidthUsage() {
return inboundPrivateBandwidthUsage;
}
public void setInboundPrivateBandwidthUsage(BigDecimal inboundPrivateBandwidthUsage) {
this.inboundPrivateBandwidthUsage = inboundPrivateBandwidthUsage;
}
/**
* The last transaction that a server's operating system was loaded.
*/
@ApiProperty
protected Transaction lastOperatingSystemReload;
public Transaction getLastOperatingSystemReload() {
return lastOperatingSystemReload;
}
public void setLastOperatingSystemReload(Transaction lastOperatingSystemReload) {
this.lastOperatingSystemReload = lastOperatingSystemReload;
}
/**
* The metric tracking object id for this server.
*/
@ApiProperty
protected Long metricTrackingObjectId;
public Long getMetricTrackingObjectId() {
return metricTrackingObjectId;
}
public void setMetricTrackingObjectId(Long metricTrackingObjectId) {
this.metricTrackingObjectId = metricTrackingObjectId;
}
/**
* 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
*/
@ApiProperty
protected List monitoringUserNotification;
public List getMonitoringUserNotification() {
if (monitoringUserNotification == null) {
monitoringUserNotification = new ArrayList();
}
return monitoringUserNotification;
}
/**
* An open ticket requesting cancellation of this server, if one exists.
*/
@ApiProperty
protected Ticket openCancellationTicket;
public Ticket getOpenCancellationTicket() {
return openCancellationTicket;
}
public void setOpenCancellationTicket(Ticket openCancellationTicket) {
this.openCancellationTicket = openCancellationTicket;
}
/**
* The total private outbound bandwidth for this hardware for the current billing cycle.
*/
@ApiProperty
protected BigDecimal outboundPrivateBandwidthUsage;
public BigDecimal getOutboundPrivateBandwidthUsage() {
return outboundPrivateBandwidthUsage;
}
public void setOutboundPrivateBandwidthUsage(BigDecimal outboundPrivateBandwidthUsage) {
this.outboundPrivateBandwidthUsage = outboundPrivateBandwidthUsage;
}
/**
* Whether the bandwidth usage for this hardware for the current billing cycle exceeds the allocation.
*/
@ApiProperty
protected Long overBandwidthAllocationFlag;
public Long getOverBandwidthAllocationFlag() {
return overBandwidthAllocationFlag;
}
public void setOverBandwidthAllocationFlag(Long overBandwidthAllocationFlag) {
this.overBandwidthAllocationFlag = overBandwidthAllocationFlag;
}
/**
* A server's primary private IP address.
*/
@ApiProperty
protected String privateIpAddress;
public String getPrivateIpAddress() {
return privateIpAddress;
}
public void setPrivateIpAddress(String privateIpAddress) {
this.privateIpAddress = privateIpAddress;
}
/**
* Whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation.
*/
@ApiProperty
protected Long projectedOverBandwidthAllocationFlag;
public Long getProjectedOverBandwidthAllocationFlag() {
return projectedOverBandwidthAllocationFlag;
}
public void setProjectedOverBandwidthAllocationFlag(Long projectedOverBandwidthAllocationFlag) {
this.projectedOverBandwidthAllocationFlag = projectedOverBandwidthAllocationFlag;
}
/**
* The projected public outbound bandwidth for this hardware for the current billing cycle.
*/
@ApiProperty
protected BigDecimal projectedPublicBandwidthUsage;
public BigDecimal getProjectedPublicBandwidthUsage() {
return projectedPublicBandwidthUsage;
}
public void setProjectedPublicBandwidthUsage(BigDecimal projectedPublicBandwidthUsage) {
this.projectedPublicBandwidthUsage = projectedPublicBandwidthUsage;
}
/**
* The last five commands issued to the server's remote management card.
*/
@ApiProperty
protected List recentRemoteManagementCommands;
public List getRecentRemoteManagementCommands() {
if (recentRemoteManagementCommands == null) {
recentRemoteManagementCommands = new ArrayList();
}
return recentRemoteManagementCommands;
}
@ApiProperty
protected Registry regionalInternetRegistry;
public Registry getRegionalInternetRegistry() {
return regionalInternetRegistry;
}
public void setRegionalInternetRegistry(Registry regionalInternetRegistry) {
this.regionalInternetRegistry = regionalInternetRegistry;
}
/**
* A server's remote management card.
*/
@ApiProperty
protected RemoteManagement remoteManagement;
public RemoteManagement getRemoteManagement() {
return remoteManagement;
}
public void setRemoteManagement(RemoteManagement remoteManagement) {
this.remoteManagement = remoteManagement;
}
/**
* User(s) who have access to issue commands and/or interact with the server's remote management card.
*/
@ApiProperty
protected List remoteManagementUsers;
public List getRemoteManagementUsers() {
if (remoteManagementUsers == null) {
remoteManagementUsers = new ArrayList();
}
return remoteManagementUsers;
}
/**
* A server's remote management card used for statistics.
*/
@ApiProperty
protected RemoteManagement statisticsRemoteManagement;
public RemoteManagement getStatisticsRemoteManagement() {
return statisticsRemoteManagement;
}
public void setStatisticsRemoteManagement(RemoteManagement statisticsRemoteManagement) {
this.statisticsRemoteManagement = statisticsRemoteManagement;
}
/**
* A list of users that have access to this computing instance.
*/
@ApiProperty
protected List users;
public List getUsers() {
if (users == null) {
users = new ArrayList();
}
return users;
}
/**
* A hardware server's virtual servers.
*/
@ApiProperty
protected List virtualGuests;
public List getVirtualGuests() {
if (virtualGuests == null) {
virtualGuests = new ArrayList();
}
return virtualGuests;
}
/**
* A count of
*/
@ApiProperty
protected Long activeTicketCount;
public Long getActiveTicketCount() {
return activeTicketCount;
}
public void setActiveTicketCount(Long activeTicketCount) {
this.activeTicketCount = activeTicketCount;
}
/**
* A count of any active transaction(s) that are currently running for the server (example: os reload).
*/
@ApiProperty
protected Long activeTransactionCount;
public Long getActiveTransactionCount() {
return activeTransactionCount;
}
public void setActiveTransactionCount(Long activeTransactionCount) {
this.activeTransactionCount = activeTransactionCount;
}
/**
* A count of an object that stores the maximum level for the monitoring query types and response types.
*/
@ApiProperty
protected Long availableMonitoringCount;
public Long getAvailableMonitoringCount() {
return availableMonitoringCount;
}
public void setAvailableMonitoringCount(Long availableMonitoringCount) {
this.availableMonitoringCount = availableMonitoringCount;
}
/**
* 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.
*/
@ApiProperty
protected Long billingCycleBandwidthUsageCount;
public Long getBillingCycleBandwidthUsageCount() {
return billingCycleBandwidthUsageCount;
}
public void setBillingCycleBandwidthUsageCount(Long billingCycleBandwidthUsageCount) {
this.billingCycleBandwidthUsageCount = billingCycleBandwidthUsageCount;
}
/**
* 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
*/
@ApiProperty
protected Long monitoringUserNotificationCount;
public Long getMonitoringUserNotificationCount() {
return monitoringUserNotificationCount;
}
public void setMonitoringUserNotificationCount(Long monitoringUserNotificationCount) {
this.monitoringUserNotificationCount = monitoringUserNotificationCount;
}
/**
* A count of the last five commands issued to the server's remote management card.
*/
@ApiProperty
protected Long recentRemoteManagementCommandCount;
public Long getRecentRemoteManagementCommandCount() {
return recentRemoteManagementCommandCount;
}
public void setRecentRemoteManagementCommandCount(Long recentRemoteManagementCommandCount) {
this.recentRemoteManagementCommandCount = recentRemoteManagementCommandCount;
}
/**
* A count of user(s) who have access to issue commands and/or interact with the server's remote management card.
*/
@ApiProperty
protected Long remoteManagementUserCount;
public Long getRemoteManagementUserCount() {
return remoteManagementUserCount;
}
public void setRemoteManagementUserCount(Long remoteManagementUserCount) {
this.remoteManagementUserCount = remoteManagementUserCount;
}
/**
* A count of a list of users that have access to this computing instance.
*/
@ApiProperty
protected Long userCount;
public Long getUserCount() {
return userCount;
}
public void setUserCount(Long userCount) {
this.userCount = userCount;
}
/**
* A count of a hardware server's virtual servers.
*/
@ApiProperty
protected Long virtualGuestCount;
public Long getVirtualGuestCount() {
return virtualGuestCount;
}
public void setVirtualGuestCount(Long virtualGuestCount) {
this.virtualGuestCount = virtualGuestCount;
}
public Service asService(ApiClient client) {
if (id != null) {
return service(client, id);
} else {
return service(client, globalIdentifier);
}
}
public static Service service(ApiClient client) {
return client.createService(Service.class, null);
}
public static Service service(ApiClient client, Long id) {
return client.createService(Service.class, id == null ? null : id.toString());
}
public static Service service(ApiClient client, String globalIdentifier) {
return client.createService(Service.class, globalIdentifier);
}
/**
* Every SoftLayer server is defined in the SoftLayer_Hardware_Server service. SoftLayer servers have all the functionality of SoftLayer_Hardware with the of server specific data and functionality such as Operating System reload dates and motherboard components. The SoftLayer_Hardware service is a convenient way to obtain general information about your SoftLayer server. 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 SoftLayer_Hardware_Server
*/
@com.softlayer.api.annotation.ApiService("SoftLayer_Hardware_Server")
public static interface Service extends com.softlayer.api.service.Hardware.Service {
public ServiceAsync asAsync();
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* Activates the private network port
*
* @see SoftLayer_Hardware_Server::activatePrivatePort
*/
@ApiMethod(instanceRequired = true)
public Boolean activatePrivatePort();
/**
* Activates the public network port
*
* @see SoftLayer_Hardware_Server::activatePublicPort
*/
@ApiMethod(instanceRequired = true)
public Boolean activatePublicPort();
/**
* The Rescue Kernel is designed to provide you with the ability to bring a server online in order to troubleshoot system problems that would normally only be resolved by an OS Reload. The correct Rescue Kernel will be selected based upon the currently installed operating system. When the rescue kernel process is initiated, the server will shutdown and reboot on to the public network with the same IP's assigned to the server to allow for remote connections. It will bring your server offline for approximately 10 minutes while the rescue is in progress. The root/administrator password will be the same as what is listed in the portal for the server.
*
* @see SoftLayer_Hardware_Server::bootToRescueLayer
*/
@ApiMethod(instanceRequired = true)
public Boolean bootToRescueLayer(String noOsBootEnvironment);
/**
* You can launch firmware updates by selecting from your server list. It will bring your server offline for approximately 20 minutes while the updates are in progress.
*
* In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
*
* @see SoftLayer_Hardware_Server::createFirmwareUpdateTransaction
*/
@ApiMethod(instanceRequired = true)
public Boolean createFirmwareUpdateTransaction(Long ipmi, Long raidController, Long bios, Long harddrive);
/**
*
*
* 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 SoftLayer_Hardware_Server::createObject
*/
@ApiMethod
public Server createObject(Server templateObject);
/**
* @see SoftLayer_Hardware_Server::createPostSoftwareInstallTransaction
*/
@ApiMethod(instanceRequired = true)
public Boolean createPostSoftwareInstallTransaction(List installCodes, Boolean returnBoolean);
/**
* Edit a server's properties
*
* @see SoftLayer_Hardware_Server::editObject
*/
@ApiMethod(instanceRequired = true)
public Boolean editObject(Server templateObject);
/**
* Use this method to return an array of private bandwidth utilization records between a given date range.
*
* This method represents the NEW version of getFrontendBandwidthUse
*
* @see SoftLayer_Hardware_Server::getBackendBandwidthUsage
*/
@ApiMethod(instanceRequired = true)
public List getBackendBandwidthUsage(GregorianCalendar startDate, GregorianCalendar endDate);
/**
* Use this method to return an array of private bandwidth utilization records between a given date range.
*
* @see SoftLayer_Hardware_Server::getBackendBandwidthUse
*/
@ApiMethod(instanceRequired = true)
public List getBackendBandwidthUse(GregorianCalendar startDate, GregorianCalendar endDate);
/**
* Retrieve a collection of bandwidth data from an individual public or private network tracking object. Data is ideal if you with to employ your own traffic storage and graphing systems.
*
* @see SoftLayer_Hardware_Server::getBandwidthForDateRange
*/
@ApiMethod(instanceRequired = true)
public List getBandwidthForDateRange(GregorianCalendar startDate, GregorianCalendar endDate);
/**
* Use this method when needing a bandwidth image for a single server. It will gather the correct input parameters for the generic graphing utility automatically based on the snapshot specified. Use the $draw flag to suppress the generation of the actual binary PNG image.
*
* @see SoftLayer_Hardware_Server::getBandwidthImage
*/
@ApiMethod(instanceRequired = true)
public GraphOutputs getBandwidthImage(String networkType, String snapshotRange, Boolean draw, GregorianCalendar dateSpecified, GregorianCalendar dateSpecifiedEnd);
/**
* Attempt to retrieve the file associated with the current benchmark certification result, if such a file exists. If there is no file for this benchmark certification result, calling this method throws an exception.
*
* @see SoftLayer_Hardware_Server::getCurrentBenchmarkCertificationResultFile
*/
@ApiMethod(instanceRequired = true)
public byte[] getCurrentBenchmarkCertificationResultFile();
/**
* Retrieve bandwidth graph by date.
*
* @see SoftLayer_Hardware_Server::getCustomBandwidthDataByDate
*/
@ApiMethod(instanceRequired = true)
public Graph getCustomBandwidthDataByDate(Graph graphData);
/**
* Get the subnets associated with this server that are protectable by a network component firewall.
*
* @see SoftLayer_Hardware_Server::getFirewallProtectableSubnets
*/
@ApiMethod(instanceRequired = true)
public List getFirewallProtectableSubnets();
/**
* Use this method to return an array of public bandwidth utilization records between a given date range.
*
* This method represents the NEW version of getFrontendBandwidthUse
*
* @see SoftLayer_Hardware_Server::getFrontendBandwidthUsage
*/
@ApiMethod(instanceRequired = true)
public List getFrontendBandwidthUsage(GregorianCalendar startDate, GregorianCalendar endDate);
/**
* Use this method to return an array of public bandwidth utilization records between a given date range.
*
* @see SoftLayer_Hardware_Server::getFrontendBandwidthUse
*/
@ApiMethod(instanceRequired = true)
public List getFrontendBandwidthUse(GregorianCalendar startDate, GregorianCalendar endDate);
/**
* Retrieve a server by searching for the primary IP address.
*
* @see SoftLayer_Hardware_Server::getHardwareByIpAddress
*/
@ApiMethod
public Server getHardwareByIpAddress(String ipAddress);
/**
* Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description
*
* @see SoftLayer_Hardware_Server::getItemPricesFromSoftwareDescriptions
*/
@ApiMethod(instanceRequired = true)
public List- getItemPricesFromSoftwareDescriptions(List
softwareDescriptions, Boolean includeTranslationsFlag, Boolean returnAllPricesFlag);
/**
* Retrieve the remote management network component attached with this server.
*
* @see SoftLayer_Hardware_Server::getManagementNetworkComponent
*/
@ApiMethod(instanceRequired = true)
public Component getManagementNetworkComponent();
/**
* Get the IP addresses associated with this server that are protectable by a network component firewall. Note, this may not return all values for IPv6 subnets for this server. Please use getFirewallProtectableSubnets to get all protectable subnets.
*
* @see SoftLayer_Hardware_Server::getNetworkComponentFirewallProtectableIpAddresses
*/
@ApiMethod(instanceRequired = true)
public List getNetworkComponentFirewallProtectableIpAddresses();
/**
* getObject retrieves the SoftLayer_Hardware_Server object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware service. You can only retrieve servers from the account that your portal user is assigned to.
*
* @see SoftLayer_Hardware_Server::getObject
*/
@ApiMethod(value = "getObject", instanceRequired = true)
public Server getObjectForServer();
/**
* Retrieve 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 system temperatures, voltages, and other local server settings. Sensor data is cached for 30 seconds. Calls made to getSensorData for the same server within 30 seconds of each other will return the same data. Subsequent calls will return new data once the cache expires.
*
* @see SoftLayer_Hardware_Server::getPMInfo
*/
@ApiMethod(instanceRequired = true)
public List getPMInfo();
/**
* @see SoftLayer_Hardware_Server::getPrimaryDriveSize
*/
@ApiMethod(instanceRequired = true)
public Long getPrimaryDriveSize();
/**
* Retrieve a brief summary of a server's private network bandwidth usage. getPrivateBandwidthDataSummary retrieves a server's bandwidth allocation for its billing period, its estimated usage during its billing period, and an estimation of how much bandwidth it will use during its billing period based on its current usage. A server's projected bandwidth usage increases in accuracy as it progresses through its billing period.
*
* @see SoftLayer_Hardware_Server::getPrivateBandwidthDataSummary
*/
@ApiMethod(instanceRequired = true)
public Summary getPrivateBandwidthDataSummary();
/**
* Retrieve a graph of a server's private network bandwidth usage over the specified time frame. If no time frame is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image
*
* @see SoftLayer_Hardware_Server::getPrivateBandwidthGraphImage
*/
@ApiMethod(instanceRequired = true)
public byte[] getPrivateBandwidthGraphImage(String startTime, String endTime);
/**
* Retrieve the private network component attached with this server.
*
* @see SoftLayer_Hardware_Server::getPrivateNetworkComponent
*/
@ApiMethod(instanceRequired = true)
public Component getPrivateNetworkComponent();
/**
* Retrieve the backend VLAN for the primary IP address of the server
*
* @see SoftLayer_Hardware_Server::getPrivateVlan
*/
@ApiMethod(instanceRequired = true)
public Vlan getPrivateVlan();
/**
* Retrieve a backend network VLAN by searching for an IP address
*
* @see SoftLayer_Hardware_Server::getPrivateVlanByIpAddress
*/
@ApiMethod
public Vlan getPrivateVlanByIpAddress(String ipAddress);
/**
* @see SoftLayer_Hardware_Server::getProvisionDate
*/
@ApiMethod(instanceRequired = true)
public GregorianCalendar getProvisionDate();
/**
* Retrieve a brief summary of a server's public network bandwidth usage. getPublicBandwidthDataSummary retrieves a server's bandwidth allocation for its billing period, its estimated usage during its billing period, and an estimation of how much bandwidth it will use during its billing period based on its current usage. A server's projected bandwidth usage increases in accuracy as it progresses through its billing period.
*
* @see SoftLayer_Hardware_Server::getPublicBandwidthDataSummary
*/
@ApiMethod(instanceRequired = true)
public Summary getPublicBandwidthDataSummary();
/**
* Retrieve a graph of a server's public network bandwidth usage over the specified time frame. If no time frame is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels. THIS METHOD GENERATES GRAPHS BASED ON THE NEW DATA WAREHOUSE REPOSITORY.
*
* @see SoftLayer_Hardware_Server::getPublicBandwidthGraphImage
*/
@ApiMethod(instanceRequired = true)
public byte[] getPublicBandwidthGraphImage(GregorianCalendar startTime, GregorianCalendar endTime);
/**
* Retrieve the total number of bytes used by a server over a specified time period via the data warehouse tracking objects for this hardware.
*
* @see SoftLayer_Hardware_Server::getPublicBandwidthTotal
*/
@ApiMethod(instanceRequired = true)
public Long getPublicBandwidthTotal(Long startTime, Long endTime);
/**
* Retrieve a SoftLayer server's public network component. Some servers are only connected to the private network and may not have a public network component. In that case getPublicNetworkComponent returns a null object.
*
* @see SoftLayer_Hardware_Server::getPublicNetworkComponent
*/
@ApiMethod(instanceRequired = true)
public Component getPublicNetworkComponent();
/**
* Retrieve the frontend VLAN for the primary IP address of the server
*
* @see SoftLayer_Hardware_Server::getPublicVlan
*/
@ApiMethod(instanceRequired = true)
public Vlan getPublicVlan();
/**
* Retrieve the frontend network Vlan by searching the hostname of a server
*
* @see SoftLayer_Hardware_Server::getPublicVlanByHostname
*/
@ApiMethod
public Vlan getPublicVlanByHostname(String hostname);
/**
* Retrieve the reverse domain records associated with this server.
*
* @see SoftLayer_Hardware_Server::getReverseDomainRecords
*/
@ApiMethod(instanceRequired = true)
public List getReverseDomainRecords();
/**
* Retrieve 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 system temperatures, voltages, and other local server settings. Sensor data is cached for 30 seconds. Calls made to getSensorData for the same server within 30 seconds of each other will return the same data. Subsequent calls will return new data once the cache expires.
*
* @see SoftLayer_Hardware_Server::getSensorData
*/
@ApiMethod(value = "getSensorData", instanceRequired = true)
public List getSensorDataForServer();
/**
* Retrieves the raw data returned from the server's remote management card. For more details of what is returned please refer to the getSensorData method. Along with the raw data, graphs for the cpu and system temperatures and fan speeds are also returned.
*
* @see SoftLayer_Hardware_Server::getSensorDataWithGraphs
*/
@ApiMethod(value = "getSensorDataWithGraphs", instanceRequired = true)
public SensorReadingsWithGraphs getSensorDataWithGraphsForServer();
/**
* Retrieve a server's hardware components, software, and network components. getServerDetails is an aggregation function that combines the results of [[SoftLayer_Hardware_Server::getComponents]], [[SoftLayer_Hardware_Server::getSoftware]], and [[SoftLayer_Hardware_Server::getNetworkComponents]] in a single container.
*
* @see SoftLayer_Hardware_Server::getServerDetails
*/
@ApiMethod(instanceRequired = true)
public Details getServerDetails();
/**
* Retrieve the server's fan speeds and displays them using tachometer graphs. Data used to construct graphs is retrieved from the server's remote management card. All graphs returned will have a title associated with it.
*
* @see SoftLayer_Hardware_Server::getServerFanSpeedGraphs
*/
@ApiMethod(value = "getServerFanSpeedGraphs", instanceRequired = true)
public List getServerFanSpeedGraphsForServer();
/**
* Retrieves the power state for the server. The server's power status is retrieved from its remote management card. This will return 'on' or 'off'.
*
* @see SoftLayer_Hardware_Server::getServerPowerState
*/
@ApiMethod(value = "getServerPowerState", instanceRequired = true)
public String getServerPowerStateForServer();
/**
* Retrieve the server's temperature and displays them using thermometer graphs. Temperatures retrieved are CPU(s) and system temperatures. Data used to construct graphs is retrieved from the server's remote management card. All graphs returned will have a title associated with it.
*
* @see SoftLayer_Hardware_Server::getServerTemperatureGraphs
*/
@ApiMethod(value = "getServerTemperatureGraphs", instanceRequired = true)
public List getServerTemperatureGraphsForServer();
/**
* This method will return the list of block device template groups that are valid to the host. For instance, it will only retrieve FLEX images.
*
* @see SoftLayer_Hardware_Server::getValidBlockDeviceTemplateGroups
*/
@ApiMethod(instanceRequired = true)
public List getValidBlockDeviceTemplateGroups(String visibility);
/**
* Retrieve a list of Windows updates available for a server from the local SoftLayer Windows Server Update Services (WSUS) server. Windows servers provisioned by SoftLayer are configured to use the local WSUS server via the private network by default.
*
* @see SoftLayer_Hardware_Server::getWindowsUpdateAvailableUpdates
*/
@ApiMethod(instanceRequired = true)
public List getWindowsUpdateAvailableUpdates();
/**
* Retrieve a list of Windows updates installed on a server as reported by the local SoftLayer Windows Server Update Services (WSUS) server. Windows servers provisioned by SoftLayer are configured to use the local WSUS server via the private network by default.
*
* @see SoftLayer_Hardware_Server::getWindowsUpdateInstalledUpdates
*/
@ApiMethod(instanceRequired = true)
public List getWindowsUpdateInstalledUpdates();
/**
* This method returns an update status record for this server. That record will specify if the server is missing updates, or has updates that must be reinstalled or require a reboot to go into affect.
*
* @see SoftLayer_Hardware_Server::getWindowsUpdateStatus
*/
@ApiMethod(instanceRequired = true)
public Status getWindowsUpdateStatus();
/**
* Idera Bare Metal Server Restore is a backup agent designed specifically for making full system restores made with Idera Server Backup.
*
* @see SoftLayer_Hardware_Server::initiateIderaBareMetalRestore
*/
@ApiMethod(instanceRequired = true)
public Boolean initiateIderaBareMetalRestore();
/**
* R1Soft Bare Metal Server Restore is an R1Soft disk agent designed specifically for making full system restores made with R1Soft CDP Server backup.
*
* @see SoftLayer_Hardware_Server::initiateR1SoftBareMetalRestore
*/
@ApiMethod(instanceRequired = true)
public Boolean initiateR1SoftBareMetalRestore();
/**
* Issues a ping command and returns the success (true) or failure (false) of the ping command.
*
* @see SoftLayer_Hardware_Server::isBackendPingable
*/
@ApiMethod(instanceRequired = true)
public Boolean isBackendPingable();
/**
* Issues a ping command and returns the success (true) or failure (false) of the ping command.
*
* @see SoftLayer_Hardware_Server::isPingable
*/
@ApiMethod(value = "isPingable", instanceRequired = true)
public Boolean isPingableForServer();
/**
* Determine if the server runs any version of the Microsoft Windows operating systems. Return ''true'' if it does and ''false if otherwise.
*
* @see SoftLayer_Hardware_Server::isWindowsServer
*/
@ApiMethod(instanceRequired = true)
public Boolean isWindowsServer();
/**
* You can launch firmware updates by selecting from your server list. It will bring your server offline for approximately 20 minutes while the updates are in progress.
*
* In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
*
* @see SoftLayer_Hardware_Server::massFirmwareUpdate
*/
@ApiMethod
public List massFirmwareUpdate(List hardwareIds, Boolean ipmi, Boolean raidController, Boolean bios, Boolean harddrive);
/**
* Reloads current or customer specified operating system configuration.
*
* This service has a confirmation protocol for proceeding with the reload. To proceed with the reload without confirmation, simply pass in 'FORCE' as the token parameter. To proceed with the reload with confirmation, simply call the service with no parameter. A token string will be returned by this service. The token will remain active for 10 minutes. Use this token as the parameter to confirm that a reload is to be performed for the server.
*
* As a precaution, we strongly recommend backing up all data before reloading the operating system. The reload will format the primary disk and will reconfigure the server to the current specifications on record.
*
* The reload will take AT MINIMUM 66 minutes.
*
* @see SoftLayer_Hardware_Server::massReloadOperatingSystem
*/
@ApiMethod
public String massReloadOperatingSystem(List hardwareIds, String token, Configuration config);
/**
* The ability to place multiple bare metal servers in a state where they are powered down and ports closed yet still allocated to the customer as a part of the Spare Pool program.
*
* @see SoftLayer_Hardware_Server::massSparePool
*/
@ApiMethod
public List massSparePool(List hardwareIds, String action, Boolean newOrder);
/**
* Issues a ping command to the server and returns the ping response.
*
* @see SoftLayer_Hardware_Server::ping
*/
@ApiMethod(value = "ping", instanceRequired = true)
public String pingForServer();
/**
* @see SoftLayer_Hardware_Server::populateServer
*/
@ApiMethod(instanceRequired = true)
public Void populateServer(Long hardwareId, String serialString);
/**
* Power off then power on the server via powerstrip. The power cycle command is equivalent to unplugging the server from the powerstrip and then plugging the server back into the powerstrip. This should only be used as a last resort. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.
*
* @see SoftLayer_Hardware_Server::powerCycle
*/
@ApiMethod(value = "powerCycle", instanceRequired = true)
public Boolean powerCycleForServer();
/**
* This method will power off the server via the server's remote management card.
*
* @see SoftLayer_Hardware_Server::powerOff
*/
@ApiMethod(value = "powerOff", instanceRequired = true)
public Boolean powerOffForServer();
/**
* Power on server via its remote management card. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.
*
* @see SoftLayer_Hardware_Server::powerOn
*/
@ApiMethod(value = "powerOn", instanceRequired = true)
public Boolean powerOnForServer();
/**
* Attempts to reboot the server by issuing a reset (soft reboot) command to the server's remote management card. If the reset (soft reboot) attempt is unsuccessful, a power cycle command will be issued via the powerstrip. The power cycle command is equivalent to unplugging the server from the powerstrip and then plugging the server back into the powerstrip. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.
*
* @see SoftLayer_Hardware_Server::rebootDefault
*/
@ApiMethod(value = "rebootDefault", instanceRequired = true)
public Boolean rebootDefaultForServer();
/**
* Reboot the server by issuing a cycle command to the server's remote management card. This is equivalent to pressing the 'Reset' button on the server. This command is issued immediately and will not wait for processes to shutdown. After this command is issued, the server may take a few moments to boot up as server may run system disks checks. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.
*
* @see SoftLayer_Hardware_Server::rebootHard
*/
@ApiMethod(value = "rebootHard", instanceRequired = true)
public Boolean rebootHardForServer();
/**
* Reboot the server by issuing a reset command to the server's remote management card. This is a graceful reboot. The servers will allow all process to shutdown gracefully before rebooting. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.
*
* @see SoftLayer_Hardware_Server::rebootSoft
*/
@ApiMethod(value = "rebootSoft", instanceRequired = true)
public Boolean rebootSoftForServer();
/**
* Reloads current operating system configuration.
*
* This service has a confirmation protocol for proceeding with the reload. To proceed with the reload without confirmation, simply pass in 'FORCE' as the token parameter. To proceed with the reload with confirmation, simply call the service with no parameter. A token string will be returned by this service. The token will remain active for 10 minutes. Use this token as the parameter to confirm that a reload is to be performed for the server.
*
* As a precaution, we strongly recommend backing up all data before reloading the operating system. The reload will format the primary disk and will reconfigure the server to the current specifications on record.
*
* The reload will take AT MINIMUM 66 minutes.
*
* @see SoftLayer_Hardware_Server::reloadCurrentOperatingSystemConfiguration
*/
@ApiMethod(instanceRequired = true)
public String reloadCurrentOperatingSystemConfiguration(String token);
/**
* Reloads current or customer specified operating system configuration.
*
* This service has a confirmation protocol for proceeding with the reload. To proceed with the reload without confirmation, simply pass in 'FORCE' as the token parameter. To proceed with the reload with confirmation, simply call the service with no parameter. A token string will be returned by this service. The token will remain active for 10 minutes. Use this token as the parameter to confirm that a reload is to be performed for the server.
*
* As a precaution, we strongly recommend backing up all data before reloading the operating system. The reload will format the primary disk and will reconfigure the server to the current specifications on record.
*
* The reload will take AT MINIMUM 66 minutes.
*
* @see SoftLayer_Hardware_Server::reloadOperatingSystem
*/
@ApiMethod(instanceRequired = true)
public String reloadOperatingSystem(String token, Configuration config);
/**
* You can launch a new Passmark hardware test by selecting from your server list. It will bring your server offline for approximately 20 minutes while the testing is in progress, and will publish a certificate with the results to your hardware details page.
*
* While the hard drives are tested for the initial deployment, the Passmark Certificate utility will not test the hard drives on your live server. This is to ensure that no data is overwritten. If you would like to test the server's hard drives, you can have the full Passmark suite installed to your server free of charge through a new Support ticket.
*
* While the test itself does not overwrite any data on the server, it is recommended that you make full off-server backups of all data prior to launching the test. The Passmark hardware test is designed to force any latent hardware issues to the surface, so hardware failure is possible.
*
* In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.
*
* @see SoftLayer_Hardware_Server::runPassmarkCertificationBenchmark
*/
@ApiMethod(instanceRequired = true)
public Boolean runPassmarkCertificationBenchmark();
/**
* Changes the password that we have stored in our database for a servers' Operating System
*
* @see SoftLayer_Hardware_Server::setOperatingSystemPassword
*/
@ApiMethod(instanceRequired = true)
public Boolean setOperatingSystemPassword(String newPassword);
/**
* Sets the private network interface speed to the new speed. Speed values can only be 0 (Disconnect), 10, 100, 1000, and 10000. The new speed must be equal to or less than the max speed of the interface.
*
* It will take less than a minute to update the switch port speed. The server uplink will not be operational again until the server interface speed is updated.
*
* @see SoftLayer_Hardware_Server::setPrivateNetworkInterfaceSpeed
*/
@ApiMethod(instanceRequired = true)
public Boolean setPrivateNetworkInterfaceSpeed(Long newSpeed);
/**
* Sets the public network interface speed to the new speed. Speed values can only be 0 (Disconnect), 10, 100, 1000, and 10000. The new speed must be equal to or less than the max speed of the interface.
*
* It will take less than a minute to update the switch port speed. The server uplink will not be operational again until the server interface speed is updated.
*
* @see SoftLayer_Hardware_Server::setPublicNetworkInterfaceSpeed
*/
@ApiMethod(instanceRequired = true)
public Boolean setPublicNetworkInterfaceSpeed(Long newSpeed);
/**
* Sets the data that will be written to the configuration drive.
*
* @see SoftLayer_Hardware_Server::setUserMetadata
*/
@ApiMethod(instanceRequired = true)
public List setUserMetadata(List metadata);
/**
* Shuts down the public network port
*
* @see SoftLayer_Hardware_Server::shutdownPrivatePort
*/
@ApiMethod(instanceRequired = true)
public Boolean shutdownPrivatePort();
/**
* Shuts down the public network port
*
* @see SoftLayer_Hardware_Server::shutdownPublicPort
*/
@ApiMethod(instanceRequired = true)
public Boolean shutdownPublicPort();
/**
* The ability to place bare metal servers in a state where they are powered down, and ports closed yet still allocated to the customer as a part of the Spare Pool program.
*
* @see SoftLayer_Hardware_Server::sparePool
*/
@ApiMethod(instanceRequired = true)
public Boolean sparePool(String action, Boolean newOrder);
/**
* This method will update the root IPMI password on this SoftLayer_Hardware.
*
* @see SoftLayer_Hardware_Server::updateIpmiPassword
*/
@ApiMethod(instanceRequired = true)
public Boolean updateIpmiPassword(String password);
/**
* Validates a collection of partitions for an operating system
*
* @see SoftLayer_Hardware_Server::validatePartitionsForOperatingSystem
*/
@ApiMethod
public Boolean validatePartitionsForOperatingSystem(Description operatingSystem, List partitions);
/**
* The billing item for a server's attached network firewall.
*
* @see SoftLayer_Hardware_Server::getActiveNetworkFirewallBillingItem
*/
@ApiMethod(instanceRequired = true)
public com.softlayer.api.service.billing.Item getActiveNetworkFirewallBillingItem();
/**
* @see SoftLayer_Hardware_Server::getActiveTickets
*/
@ApiMethod(instanceRequired = true)
public List getActiveTickets();
/**
* Transaction currently running for server.
*
* @see SoftLayer_Hardware_Server::getActiveTransaction
*/
@ApiMethod(instanceRequired = true)
public Transaction getActiveTransaction();
/**
* Any active transaction(s) that are currently running for the server (example: os reload).
*
* @see SoftLayer_Hardware_Server::getActiveTransactions
*/
@ApiMethod(instanceRequired = true)
public List getActiveTransactions();
/**
* An object that stores the maximum level for the monitoring query types and response types.
*
* @see SoftLayer_Hardware_Server::getAvailableMonitoring
*/
@ApiMethod(instanceRequired = true)
public List getAvailableMonitoring();
/**
* The average daily total bandwidth usage for the current billing cycle.
*
* @see SoftLayer_Hardware_Server::getAverageDailyBandwidthUsage
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getAverageDailyBandwidthUsage();
/**
* The average daily private bandwidth usage for the current billing cycle.
*
* @see SoftLayer_Hardware_Server::getAverageDailyPrivateBandwidthUsage
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getAverageDailyPrivateBandwidthUsage();
/**
* The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.
*
* @see SoftLayer_Hardware_Server::getBillingCycleBandwidthUsage
*/
@ApiMethod(instanceRequired = true)
public List getBillingCycleBandwidthUsage();
/**
* The raw private bandwidth usage data for the current billing cycle.
*
* @see SoftLayer_Hardware_Server::getBillingCyclePrivateBandwidthUsage
*/
@ApiMethod(instanceRequired = true)
public Usage getBillingCyclePrivateBandwidthUsage();
/**
* The raw public bandwidth usage data for the current billing cycle.
*
* @see SoftLayer_Hardware_Server::getBillingCyclePublicBandwidthUsage
*/
@ApiMethod(instanceRequired = true)
public Usage getBillingCyclePublicBandwidthUsage();
/**
* @see SoftLayer_Hardware_Server::getContainsSolidStateDrivesFlag
*/
@ApiMethod(instanceRequired = true)
public Boolean getContainsSolidStateDrivesFlag();
/**
* A server's control panel.
*
* @see SoftLayer_Hardware_Server::getControlPanel
*/
@ApiMethod(instanceRequired = true)
public ControlPanel getControlPanel();
/**
* The total cost of a server, measured in US Dollars ($USD).
*
* @see SoftLayer_Hardware_Server::getCost
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getCost();
/**
* An object that provides commonly used bandwidth summary components for the current billing cycle.
*
* @see SoftLayer_Hardware_Server::getCurrentBandwidthSummary
*/
@ApiMethod(instanceRequired = true)
public com.softlayer.api.service.metric.tracking.object.bandwidth.Summary getCurrentBandwidthSummary();
/**
* Indicates if a server has a Customer Installed OS
*
* @see SoftLayer_Hardware_Server::getCustomerInstalledOperatingSystemFlag
*/
@ApiMethod(instanceRequired = true)
public Boolean getCustomerInstalledOperatingSystemFlag();
/**
* Indicates if a server is a customer owned device.
*
* @see SoftLayer_Hardware_Server::getCustomerOwnedFlag
*/
@ApiMethod(instanceRequired = true)
public Boolean getCustomerOwnedFlag();
/**
* The total private inbound bandwidth for this hardware for the current billing cycle.
*
* @see SoftLayer_Hardware_Server::getInboundPrivateBandwidthUsage
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getInboundPrivateBandwidthUsage();
/**
* The last transaction that a server's operating system was loaded.
*
* @see SoftLayer_Hardware_Server::getLastOperatingSystemReload
*/
@ApiMethod(instanceRequired = true)
public Transaction getLastOperatingSystemReload();
/**
* The metric tracking object id for this server.
*
* @see SoftLayer_Hardware_Server::getMetricTrackingObjectId
*/
@ApiMethod(instanceRequired = true)
public Long getMetricTrackingObjectId();
/**
* 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
*
* @see SoftLayer_Hardware_Server::getMonitoringUserNotification
*/
@ApiMethod(instanceRequired = true)
public List getMonitoringUserNotification();
/**
* An open ticket requesting cancellation of this server, if one exists.
*
* @see SoftLayer_Hardware_Server::getOpenCancellationTicket
*/
@ApiMethod(instanceRequired = true)
public Ticket getOpenCancellationTicket();
/**
* The total private outbound bandwidth for this hardware for the current billing cycle.
*
* @see SoftLayer_Hardware_Server::getOutboundPrivateBandwidthUsage
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getOutboundPrivateBandwidthUsage();
/**
* Whether the bandwidth usage for this hardware for the current billing cycle exceeds the allocation.
*
* @see SoftLayer_Hardware_Server::getOverBandwidthAllocationFlag
*/
@ApiMethod(instanceRequired = true)
public Long getOverBandwidthAllocationFlag();
/**
* A server's primary private IP address.
*
* @see SoftLayer_Hardware_Server::getPrivateIpAddress
*/
@ApiMethod(instanceRequired = true)
public String getPrivateIpAddress();
/**
* Whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation.
*
* @see SoftLayer_Hardware_Server::getProjectedOverBandwidthAllocationFlag
*/
@ApiMethod(instanceRequired = true)
public Long getProjectedOverBandwidthAllocationFlag();
/**
* The projected public outbound bandwidth for this hardware for the current billing cycle.
*
* @see SoftLayer_Hardware_Server::getProjectedPublicBandwidthUsage
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getProjectedPublicBandwidthUsage();
/**
* The last five commands issued to the server's remote management card.
*
* @see SoftLayer_Hardware_Server::getRecentRemoteManagementCommands
*/
@ApiMethod(instanceRequired = true)
public List getRecentRemoteManagementCommands();
/**
* @see SoftLayer_Hardware_Server::getRegionalInternetRegistry
*/
@ApiMethod(instanceRequired = true)
public Registry getRegionalInternetRegistry();
/**
* A server's remote management card.
*
* @see SoftLayer_Hardware_Server::getRemoteManagement
*/
@ApiMethod(instanceRequired = true)
public RemoteManagement getRemoteManagement();
/**
* User(s) who have access to issue commands and/or interact with the server's remote management card.
*
* @see SoftLayer_Hardware_Server::getRemoteManagementUsers
*/
@ApiMethod(instanceRequired = true)
public List getRemoteManagementUsers();
/**
* A server's remote management card used for statistics.
*
* @see SoftLayer_Hardware_Server::getStatisticsRemoteManagement
*/
@ApiMethod(instanceRequired = true)
public RemoteManagement getStatisticsRemoteManagement();
/**
* A list of users that have access to this computing instance.
*
* @see SoftLayer_Hardware_Server::getUsers
*/
@ApiMethod(instanceRequired = true)
public List getUsers();
/**
* A hardware server's virtual servers.
*
* @see SoftLayer_Hardware_Server::getVirtualGuests
*/
@ApiMethod(instanceRequired = true)
public List getVirtualGuests();
}
public static interface ServiceAsync extends com.softlayer.api.service.Hardware.ServiceAsync {
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* Async version of {@link Service#activatePrivatePort}
*/
public Future activatePrivatePort();
public Future activatePrivatePort(ResponseHandler callback);
/**
* Async version of {@link Service#activatePublicPort}
*/
public Future activatePublicPort();
public Future activatePublicPort(ResponseHandler callback);
/**
* Async version of {@link Service#bootToRescueLayer}
*/
public Future bootToRescueLayer(String noOsBootEnvironment);
public Future bootToRescueLayer(String noOsBootEnvironment, ResponseHandler callback);
/**
* Async version of {@link Service#createFirmwareUpdateTransaction}
*/
public Future createFirmwareUpdateTransaction(Long ipmi, Long raidController, Long bios, Long harddrive);
public Future createFirmwareUpdateTransaction(Long ipmi, Long raidController, Long bios, Long harddrive, ResponseHandler callback);
/**
* Async version of {@link Service#createObject}
*/
public Future createObject(Server templateObject);
public Future createObject(Server templateObject, ResponseHandler callback);
/**
* Async version of {@link Service#createPostSoftwareInstallTransaction}
*/
public Future createPostSoftwareInstallTransaction(List installCodes, Boolean returnBoolean);
public Future createPostSoftwareInstallTransaction(List installCodes, Boolean returnBoolean, ResponseHandler callback);
/**
* Async version of {@link Service#editObject}
*/
public Future editObject(Server templateObject);
public Future editObject(Server templateObject, ResponseHandler callback);
/**
* Async version of {@link Service#getBackendBandwidthUsage}
*/
public Future> getBackendBandwidthUsage(GregorianCalendar startDate, GregorianCalendar endDate);
public Future getBackendBandwidthUsage(GregorianCalendar startDate, GregorianCalendar endDate, ResponseHandler> callback);
/**
* Async version of {@link Service#getBackendBandwidthUse}
*/
public Future> getBackendBandwidthUse(GregorianCalendar startDate, GregorianCalendar endDate);
public Future getBackendBandwidthUse(GregorianCalendar startDate, GregorianCalendar endDate, ResponseHandler> callback);
/**
* Async version of {@link Service#getBandwidthForDateRange}
*/
public Future> getBandwidthForDateRange(GregorianCalendar startDate, GregorianCalendar endDate);
public Future getBandwidthForDateRange(GregorianCalendar startDate, GregorianCalendar endDate, ResponseHandler> callback);
/**
* Async version of {@link Service#getBandwidthImage}
*/
public Future getBandwidthImage(String networkType, String snapshotRange, Boolean draw, GregorianCalendar dateSpecified, GregorianCalendar dateSpecifiedEnd);
public Future getBandwidthImage(String networkType, String snapshotRange, Boolean draw, GregorianCalendar dateSpecified, GregorianCalendar dateSpecifiedEnd, ResponseHandler callback);
/**
* Async version of {@link Service#getCurrentBenchmarkCertificationResultFile}
*/
public Future getCurrentBenchmarkCertificationResultFile();
public Future getCurrentBenchmarkCertificationResultFile(ResponseHandler callback);
/**
* Async version of {@link Service#getCustomBandwidthDataByDate}
*/
public Future getCustomBandwidthDataByDate(Graph graphData);
public Future getCustomBandwidthDataByDate(Graph graphData, ResponseHandler callback);
/**
* Async version of {@link Service#getFirewallProtectableSubnets}
*/
public Future> getFirewallProtectableSubnets();
public Future getFirewallProtectableSubnets(ResponseHandler> callback);
/**
* Async version of {@link Service#getFrontendBandwidthUsage}
*/
public Future> getFrontendBandwidthUsage(GregorianCalendar startDate, GregorianCalendar endDate);
public Future getFrontendBandwidthUsage(GregorianCalendar startDate, GregorianCalendar endDate, ResponseHandler> callback);
/**
* Async version of {@link Service#getFrontendBandwidthUse}
*/
public Future> getFrontendBandwidthUse(GregorianCalendar startDate, GregorianCalendar endDate);
public Future getFrontendBandwidthUse(GregorianCalendar startDate, GregorianCalendar endDate, ResponseHandler> callback);
/**
* Async version of {@link Service#getHardwareByIpAddress}
*/
public Future getHardwareByIpAddress(String ipAddress);
public Future getHardwareByIpAddress(String ipAddress, ResponseHandler callback);
/**
* Async version of {@link Service#getItemPricesFromSoftwareDescriptions}
*/
public Future> getItemPricesFromSoftwareDescriptions(List softwareDescriptions, Boolean includeTranslationsFlag, Boolean returnAllPricesFlag);
public Future getItemPricesFromSoftwareDescriptions(List softwareDescriptions, Boolean includeTranslationsFlag, Boolean returnAllPricesFlag, ResponseHandler> callback);
/**
* Async version of {@link Service#getManagementNetworkComponent}
*/
public Future getManagementNetworkComponent();
public Future getManagementNetworkComponent(ResponseHandler callback);
/**
* Async version of {@link Service#getNetworkComponentFirewallProtectableIpAddresses}
*/
public Future> getNetworkComponentFirewallProtectableIpAddresses();
public Future getNetworkComponentFirewallProtectableIpAddresses(ResponseHandler> callback);
/**
* Async version of {@link Service#getObjectForServer}
*/
public Future getObjectForServer();
public Future getObjectForServer(ResponseHandler callback);
/**
* Async version of {@link Service#getPMInfo}
*/
public Future> getPMInfo();
public Future getPMInfo(ResponseHandler> callback);
/**
* Async version of {@link Service#getPrimaryDriveSize}
*/
public Future getPrimaryDriveSize();
public Future getPrimaryDriveSize(ResponseHandler callback);
/**
* Async version of {@link Service#getPrivateBandwidthDataSummary}
*/
public Future getPrivateBandwidthDataSummary();
public Future getPrivateBandwidthDataSummary(ResponseHandler callback);
/**
* Async version of {@link Service#getPrivateBandwidthGraphImage}
*/
public Future getPrivateBandwidthGraphImage(String startTime, String endTime);
public Future getPrivateBandwidthGraphImage(String startTime, String endTime, ResponseHandler callback);
/**
* Async version of {@link Service#getPrivateNetworkComponent}
*/
public Future getPrivateNetworkComponent();
public Future getPrivateNetworkComponent(ResponseHandler callback);
/**
* Async version of {@link Service#getPrivateVlan}
*/
public Future getPrivateVlan();
public Future getPrivateVlan(ResponseHandler callback);
/**
* Async version of {@link Service#getPrivateVlanByIpAddress}
*/
public Future getPrivateVlanByIpAddress(String ipAddress);
public Future getPrivateVlanByIpAddress(String ipAddress, ResponseHandler callback);
/**
* Async version of {@link Service#getProvisionDate}
*/
public Future getProvisionDate();
public Future getProvisionDate(ResponseHandler callback);
/**
* Async version of {@link Service#getPublicBandwidthDataSummary}
*/
public Future getPublicBandwidthDataSummary();
public Future getPublicBandwidthDataSummary(ResponseHandler callback);
/**
* Async version of {@link Service#getPublicBandwidthGraphImage}
*/
public Future getPublicBandwidthGraphImage(GregorianCalendar startTime, GregorianCalendar endTime);
public Future getPublicBandwidthGraphImage(GregorianCalendar startTime, GregorianCalendar endTime, ResponseHandler callback);
/**
* Async version of {@link Service#getPublicBandwidthTotal}
*/
public Future getPublicBandwidthTotal(Long startTime, Long endTime);
public Future getPublicBandwidthTotal(Long startTime, Long endTime, ResponseHandler callback);
/**
* Async version of {@link Service#getPublicNetworkComponent}
*/
public Future getPublicNetworkComponent();
public Future getPublicNetworkComponent(ResponseHandler callback);
/**
* Async version of {@link Service#getPublicVlan}
*/
public Future getPublicVlan();
public Future getPublicVlan(ResponseHandler callback);
/**
* Async version of {@link Service#getPublicVlanByHostname}
*/
public Future getPublicVlanByHostname(String hostname);
public Future getPublicVlanByHostname(String hostname, ResponseHandler callback);
/**
* Async version of {@link Service#getReverseDomainRecords}
*/
public Future> getReverseDomainRecords();
public Future getReverseDomainRecords(ResponseHandler> callback);
/**
* Async version of {@link Service#getSensorDataForServer}
*/
public Future> getSensorDataForServer();
public Future getSensorDataForServer(ResponseHandler> callback);
/**
* Async version of {@link Service#getSensorDataWithGraphsForServer}
*/
public Future getSensorDataWithGraphsForServer();
public Future getSensorDataWithGraphsForServer(ResponseHandler callback);
/**
* Async version of {@link Service#getServerDetails}
*/
public Future getServerDetails();
public Future getServerDetails(ResponseHandler callback);
/**
* Async version of {@link Service#getServerFanSpeedGraphsForServer}
*/
public Future> getServerFanSpeedGraphsForServer();
public Future getServerFanSpeedGraphsForServer(ResponseHandler> callback);
/**
* Async version of {@link Service#getServerPowerStateForServer}
*/
public Future getServerPowerStateForServer();
public Future getServerPowerStateForServer(ResponseHandler callback);
/**
* Async version of {@link Service#getServerTemperatureGraphsForServer}
*/
public Future> getServerTemperatureGraphsForServer();
public Future getServerTemperatureGraphsForServer(ResponseHandler> callback);
/**
* Async version of {@link Service#getValidBlockDeviceTemplateGroups}
*/
public Future> getValidBlockDeviceTemplateGroups(String visibility);
public Future getValidBlockDeviceTemplateGroups(String visibility, ResponseHandler> callback);
/**
* Async version of {@link Service#getWindowsUpdateAvailableUpdates}
*/
public Future> getWindowsUpdateAvailableUpdates();
public Future getWindowsUpdateAvailableUpdates(ResponseHandler> callback);
/**
* Async version of {@link Service#getWindowsUpdateInstalledUpdates}
*/
public Future> getWindowsUpdateInstalledUpdates();
public Future getWindowsUpdateInstalledUpdates(ResponseHandler> callback);
/**
* Async version of {@link Service#getWindowsUpdateStatus}
*/
public Future getWindowsUpdateStatus();
public Future getWindowsUpdateStatus(ResponseHandler callback);
/**
* Async version of {@link Service#initiateIderaBareMetalRestore}
*/
public Future initiateIderaBareMetalRestore();
public Future initiateIderaBareMetalRestore(ResponseHandler callback);
/**
* Async version of {@link Service#initiateR1SoftBareMetalRestore}
*/
public Future initiateR1SoftBareMetalRestore();
public Future initiateR1SoftBareMetalRestore(ResponseHandler callback);
/**
* Async version of {@link Service#isBackendPingable}
*/
public Future isBackendPingable();
public Future isBackendPingable(ResponseHandler callback);
/**
* Async version of {@link Service#isPingableForServer}
*/
public Future isPingableForServer();
public Future isPingableForServer(ResponseHandler callback);
/**
* Async version of {@link Service#isWindowsServer}
*/
public Future isWindowsServer();
public Future isWindowsServer(ResponseHandler callback);
/**
* Async version of {@link Service#massFirmwareUpdate}
*/
public Future> massFirmwareUpdate(List hardwareIds, Boolean ipmi, Boolean raidController, Boolean bios, Boolean harddrive);
public Future massFirmwareUpdate(List hardwareIds, Boolean ipmi, Boolean raidController, Boolean bios, Boolean harddrive, ResponseHandler> callback);
/**
* Async version of {@link Service#massReloadOperatingSystem}
*/
public Future massReloadOperatingSystem(List hardwareIds, String token, Configuration config);
public Future massReloadOperatingSystem(List hardwareIds, String token, Configuration config, ResponseHandler callback);
/**
* Async version of {@link Service#massSparePool}
*/
public Future> massSparePool(List hardwareIds, String action, Boolean newOrder);
public Future massSparePool(List hardwareIds, String action, Boolean newOrder, ResponseHandler> callback);
/**
* Async version of {@link Service#pingForServer}
*/
public Future pingForServer();
public Future pingForServer(ResponseHandler callback);
/**
* Async version of {@link Service#populateServer}
*/
public Future populateServer(Long hardwareId, String serialString);
public Future populateServer(Long hardwareId, String serialString, ResponseHandler callback);
/**
* Async version of {@link Service#powerCycleForServer}
*/
public Future powerCycleForServer();
public Future powerCycleForServer(ResponseHandler callback);
/**
* Async version of {@link Service#powerOffForServer}
*/
public Future powerOffForServer();
public Future powerOffForServer(ResponseHandler callback);
/**
* Async version of {@link Service#powerOnForServer}
*/
public Future powerOnForServer();
public Future powerOnForServer(ResponseHandler callback);
/**
* Async version of {@link Service#rebootDefaultForServer}
*/
public Future rebootDefaultForServer();
public Future rebootDefaultForServer(ResponseHandler callback);
/**
* Async version of {@link Service#rebootHardForServer}
*/
public Future rebootHardForServer();
public Future rebootHardForServer(ResponseHandler callback);
/**
* Async version of {@link Service#rebootSoftForServer}
*/
public Future rebootSoftForServer();
public Future rebootSoftForServer(ResponseHandler callback);
/**
* Async version of {@link Service#reloadCurrentOperatingSystemConfiguration}
*/
public Future reloadCurrentOperatingSystemConfiguration(String token);
public Future reloadCurrentOperatingSystemConfiguration(String token, ResponseHandler callback);
/**
* Async version of {@link Service#reloadOperatingSystem}
*/
public Future reloadOperatingSystem(String token, Configuration config);
public Future reloadOperatingSystem(String token, Configuration config, ResponseHandler callback);
/**
* Async version of {@link Service#runPassmarkCertificationBenchmark}
*/
public Future runPassmarkCertificationBenchmark();
public Future runPassmarkCertificationBenchmark(ResponseHandler callback);
/**
* Async version of {@link Service#setOperatingSystemPassword}
*/
public Future setOperatingSystemPassword(String newPassword);
public Future setOperatingSystemPassword(String newPassword, ResponseHandler callback);
/**
* Async version of {@link Service#setPrivateNetworkInterfaceSpeed}
*/
public Future setPrivateNetworkInterfaceSpeed(Long newSpeed);
public Future setPrivateNetworkInterfaceSpeed(Long newSpeed, ResponseHandler callback);
/**
* Async version of {@link Service#setPublicNetworkInterfaceSpeed}
*/
public Future setPublicNetworkInterfaceSpeed(Long newSpeed);
public Future setPublicNetworkInterfaceSpeed(Long newSpeed, ResponseHandler callback);
/**
* Async version of {@link Service#setUserMetadata}
*/
public Future> setUserMetadata(List metadata);
public Future setUserMetadata(List metadata, ResponseHandler> callback);
/**
* Async version of {@link Service#shutdownPrivatePort}
*/
public Future shutdownPrivatePort();
public Future shutdownPrivatePort(ResponseHandler callback);
/**
* Async version of {@link Service#shutdownPublicPort}
*/
public Future shutdownPublicPort();
public Future shutdownPublicPort(ResponseHandler callback);
/**
* Async version of {@link Service#sparePool}
*/
public Future sparePool(String action, Boolean newOrder);
public Future sparePool(String action, Boolean newOrder, ResponseHandler callback);
/**
* Async version of {@link Service#updateIpmiPassword}
*/
public Future updateIpmiPassword(String password);
public Future updateIpmiPassword(String password, ResponseHandler callback);
/**
* Async version of {@link Service#validatePartitionsForOperatingSystem}
*/
public Future validatePartitionsForOperatingSystem(Description operatingSystem, List partitions);
public Future validatePartitionsForOperatingSystem(Description operatingSystem, List partitions, ResponseHandler callback);
/**
* Async version of {@link Service#getActiveNetworkFirewallBillingItem}
*/
public Future getActiveNetworkFirewallBillingItem();
/**
* Async callback version of {@link Service#getActiveNetworkFirewallBillingItem}
*/
public Future getActiveNetworkFirewallBillingItem(ResponseHandler callback);
/**
* Async version of {@link Service#getActiveTickets}
*/
public Future> getActiveTickets();
/**
* Async callback version of {@link Service#getActiveTickets}
*/
public Future getActiveTickets(ResponseHandler> callback);
/**
* Async version of {@link Service#getActiveTransaction}
*/
public Future getActiveTransaction();
/**
* Async callback version of {@link Service#getActiveTransaction}
*/
public Future getActiveTransaction(ResponseHandler callback);
/**
* Async version of {@link Service#getActiveTransactions}
*/
public Future> getActiveTransactions();
/**
* Async callback version of {@link Service#getActiveTransactions}
*/
public Future getActiveTransactions(ResponseHandler> callback);
/**
* Async version of {@link Service#getAvailableMonitoring}
*/
public Future> getAvailableMonitoring();
/**
* Async callback version of {@link Service#getAvailableMonitoring}
*/
public Future getAvailableMonitoring(ResponseHandler> callback);
/**
* Async version of {@link Service#getAverageDailyBandwidthUsage}
*/
public Future getAverageDailyBandwidthUsage();
/**
* Async callback version of {@link Service#getAverageDailyBandwidthUsage}
*/
public Future getAverageDailyBandwidthUsage(ResponseHandler callback);
/**
* Async version of {@link Service#getAverageDailyPrivateBandwidthUsage}
*/
public Future getAverageDailyPrivateBandwidthUsage();
/**
* Async callback version of {@link Service#getAverageDailyPrivateBandwidthUsage}
*/
public Future getAverageDailyPrivateBandwidthUsage(ResponseHandler callback);
/**
* Async version of {@link Service#getBillingCycleBandwidthUsage}
*/
public Future> getBillingCycleBandwidthUsage();
/**
* Async callback version of {@link Service#getBillingCycleBandwidthUsage}
*/
public Future getBillingCycleBandwidthUsage(ResponseHandler> callback);
/**
* Async version of {@link Service#getBillingCyclePrivateBandwidthUsage}
*/
public Future getBillingCyclePrivateBandwidthUsage();
/**
* Async callback version of {@link Service#getBillingCyclePrivateBandwidthUsage}
*/
public Future getBillingCyclePrivateBandwidthUsage(ResponseHandler callback);
/**
* Async version of {@link Service#getBillingCyclePublicBandwidthUsage}
*/
public Future getBillingCyclePublicBandwidthUsage();
/**
* Async callback version of {@link Service#getBillingCyclePublicBandwidthUsage}
*/
public Future getBillingCyclePublicBandwidthUsage(ResponseHandler callback);
/**
* Async version of {@link Service#getContainsSolidStateDrivesFlag}
*/
public Future getContainsSolidStateDrivesFlag();
/**
* Async callback version of {@link Service#getContainsSolidStateDrivesFlag}
*/
public Future getContainsSolidStateDrivesFlag(ResponseHandler callback);
/**
* Async version of {@link Service#getControlPanel}
*/
public Future getControlPanel();
/**
* Async callback version of {@link Service#getControlPanel}
*/
public Future getControlPanel(ResponseHandler callback);
/**
* Async version of {@link Service#getCost}
*/
public Future getCost();
/**
* Async callback version of {@link Service#getCost}
*/
public Future getCost(ResponseHandler callback);
/**
* Async version of {@link Service#getCurrentBandwidthSummary}
*/
public Future