com.softlayer.api.service.Hardware 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;
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.Account;
import com.softlayer.api.service.Entity;
import com.softlayer.api.service.Location;
import com.softlayer.api.service.billing.Item;
import com.softlayer.api.service.container.disk.image.capture.Template;
import com.softlayer.api.service.container.hardware.Configuration;
import com.softlayer.api.service.container.product.Order;
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.hardware.Attribute;
import com.softlayer.api.service.hardware.Blade;
import com.softlayer.api.service.hardware.Chassis;
import com.softlayer.api.service.hardware.Function;
import com.softlayer.api.service.hardware.Note;
import com.softlayer.api.service.hardware.Status;
import com.softlayer.api.service.hardware.benchmark.Certification;
import com.softlayer.api.service.hardware.component.Model;
import com.softlayer.api.service.hardware.component.remotemanagement.User;
import com.softlayer.api.service.metric.tracking.object.Data;
import com.softlayer.api.service.metric.tracking.object.HardwareServer;
import com.softlayer.api.service.network.Storage;
import com.softlayer.api.service.network.Vlan;
import com.softlayer.api.service.network.bandwidth.version1.Allotment;
import com.softlayer.api.service.network.bandwidth.version1.allotment.Detail;
import com.softlayer.api.service.network.component.Firewall;
import com.softlayer.api.service.network.monitor.version1.Incident;
import com.softlayer.api.service.network.monitor.version1.query.host.Stratum;
import com.softlayer.api.service.notification.occurrence.Event;
import com.softlayer.api.service.product.item.Price;
import com.softlayer.api.service.product.pkg.Preset;
import com.softlayer.api.service.product.upgrade.Request;
import com.softlayer.api.service.provisioning.version1.Transaction;
import com.softlayer.api.service.provisioning.version1.transaction.History;
import com.softlayer.api.service.resource.group.Member;
import com.softlayer.api.service.resource.group.Role;
import com.softlayer.api.service.scale.Asset;
import com.softlayer.api.service.security.ssh.Key;
import com.softlayer.api.service.service.Provider;
import com.softlayer.api.service.software.Component;
import com.softlayer.api.service.software.VirtualLicense;
import com.softlayer.api.service.software.component.OperatingSystem;
import com.softlayer.api.service.software.component.Password;
import com.softlayer.api.service.tag.Reference;
import com.softlayer.api.service.virtual.Guest;
import com.softlayer.api.service.virtual.Host;
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 data type contains general information relating to a single SoftLayer hardware.
*
* @see SoftLayer_Hardware
*/
@ApiType("SoftLayer_Hardware")
public class Hardware extends Entity {
/**
* The account associated with a piece of hardware.
*/
@ApiProperty
protected Account account;
public Account getAccount() {
return account;
}
public void setAccount(Account account) {
this.account = account;
}
/**
* A piece of hardware's active physical components.
*/
@ApiProperty
protected List activeComponents;
public List getActiveComponents() {
if (activeComponents == null) {
activeComponents = new ArrayList();
}
return activeComponents;
}
/**
* A piece of hardware's active network monitoring incidents.
*/
@ApiProperty
protected List activeNetworkMonitorIncident;
public List getActiveNetworkMonitorIncident() {
if (activeNetworkMonitorIncident == null) {
activeNetworkMonitorIncident = new ArrayList();
}
return activeNetworkMonitorIncident;
}
@ApiProperty
protected List allPowerComponents;
public List getAllPowerComponents() {
if (allPowerComponents == null) {
allPowerComponents = new ArrayList();
}
return allPowerComponents;
}
/**
* The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.
*/
@ApiProperty
protected com.softlayer.api.service.network.storage.allowed.Host allowedHost;
public com.softlayer.api.service.network.storage.allowed.Host getAllowedHost() {
return allowedHost;
}
public void setAllowedHost(com.softlayer.api.service.network.storage.allowed.Host allowedHost) {
this.allowedHost = allowedHost;
}
/**
* The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
*/
@ApiProperty
protected List allowedNetworkStorage;
public List getAllowedNetworkStorage() {
if (allowedNetworkStorage == null) {
allowedNetworkStorage = new ArrayList();
}
return allowedNetworkStorage;
}
/**
* The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
*/
@ApiProperty
protected List allowedNetworkStorageReplicas;
public List getAllowedNetworkStorageReplicas() {
if (allowedNetworkStorageReplicas == null) {
allowedNetworkStorageReplicas = new ArrayList();
}
return allowedNetworkStorageReplicas;
}
/**
* Information regarding an antivirus/spyware software component object.
*/
@ApiProperty
protected Component antivirusSpywareSoftwareComponent;
public Component getAntivirusSpywareSoftwareComponent() {
return antivirusSpywareSoftwareComponent;
}
public void setAntivirusSpywareSoftwareComponent(Component antivirusSpywareSoftwareComponent) {
this.antivirusSpywareSoftwareComponent = antivirusSpywareSoftwareComponent;
}
/**
* Information regarding a piece of hardware's specific attributes.
*/
@ApiProperty
protected List attributes;
public List getAttributes() {
if (attributes == null) {
attributes = new ArrayList();
}
return attributes;
}
/**
* The average daily public bandwidth usage for the current billing cycle.
*/
@ApiProperty
protected BigDecimal averageDailyPublicBandwidthUsage;
public BigDecimal getAverageDailyPublicBandwidthUsage() {
return averageDailyPublicBandwidthUsage;
}
public void setAverageDailyPublicBandwidthUsage(BigDecimal averageDailyPublicBandwidthUsage) {
this.averageDailyPublicBandwidthUsage = averageDailyPublicBandwidthUsage;
}
/**
* A piece of hardware's back-end or private network components.
*/
@ApiProperty
protected List backendNetworkComponents;
public List getBackendNetworkComponents() {
if (backendNetworkComponents == null) {
backendNetworkComponents = new ArrayList();
}
return backendNetworkComponents;
}
/**
* A hardware's backend or private router.
*/
@ApiProperty
protected List backendRouters;
public List getBackendRouters() {
if (backendRouters == null) {
backendRouters = new ArrayList();
}
return backendRouters;
}
/**
* A hardware's allotted bandwidth (measured in GB).
*/
@ApiProperty
protected BigDecimal bandwidthAllocation;
public BigDecimal getBandwidthAllocation() {
return bandwidthAllocation;
}
public void setBandwidthAllocation(BigDecimal bandwidthAllocation) {
this.bandwidthAllocation = bandwidthAllocation;
}
/**
* A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.
*/
@ApiProperty
protected Detail bandwidthAllotmentDetail;
public Detail getBandwidthAllotmentDetail() {
return bandwidthAllotmentDetail;
}
public void setBandwidthAllotmentDetail(Detail bandwidthAllotmentDetail) {
this.bandwidthAllotmentDetail = bandwidthAllotmentDetail;
}
/**
* Information regarding a piece of hardware's benchmark certifications.
*/
@ApiProperty
protected List benchmarkCertifications;
public List getBenchmarkCertifications() {
if (benchmarkCertifications == null) {
benchmarkCertifications = new ArrayList();
}
return benchmarkCertifications;
}
/**
* Information regarding the billing item for a server.
*/
@ApiProperty
protected com.softlayer.api.service.billing.item.Hardware billingItem;
public com.softlayer.api.service.billing.item.Hardware getBillingItem() {
return billingItem;
}
public void setBillingItem(com.softlayer.api.service.billing.item.Hardware billingItem) {
this.billingItem = billingItem;
}
/**
* A flag indicating that a billing item exists.
*/
@ApiProperty
protected Boolean billingItemFlag;
public Boolean getBillingItemFlag() {
return billingItemFlag;
}
public void setBillingItemFlag(Boolean billingItemFlag) {
this.billingItemFlag = billingItemFlag;
}
/**
* Determines whether the hardware is ineligible for cancellation because it is disconnected.
*/
@ApiProperty
protected Boolean blockCancelBecauseDisconnectedFlag;
public Boolean getBlockCancelBecauseDisconnectedFlag() {
return blockCancelBecauseDisconnectedFlag;
}
public void setBlockCancelBecauseDisconnectedFlag(Boolean blockCancelBecauseDisconnectedFlag) {
this.blockCancelBecauseDisconnectedFlag = blockCancelBecauseDisconnectedFlag;
}
/**
* Status indicating whether or not a piece of hardware has business continuance insurance.
*/
@ApiProperty
protected Boolean businessContinuanceInsuranceFlag;
public Boolean getBusinessContinuanceInsuranceFlag() {
return businessContinuanceInsuranceFlag;
}
public void setBusinessContinuanceInsuranceFlag(Boolean businessContinuanceInsuranceFlag) {
this.businessContinuanceInsuranceFlag = businessContinuanceInsuranceFlag;
}
/**
* Child hardware.
*/
@ApiProperty
protected List childrenHardware;
public List getChildrenHardware() {
if (childrenHardware == null) {
childrenHardware = new ArrayList();
}
return childrenHardware;
}
/**
* A piece of hardware's components.
*/
@ApiProperty
protected List components;
public List getComponents() {
if (components == null) {
components = new ArrayList();
}
return components;
}
/**
* A continuous data protection/server backup software component object.
*/
@ApiProperty
protected Component continuousDataProtectionSoftwareComponent;
public Component getContinuousDataProtectionSoftwareComponent() {
return continuousDataProtectionSoftwareComponent;
}
public void setContinuousDataProtectionSoftwareComponent(Component continuousDataProtectionSoftwareComponent) {
this.continuousDataProtectionSoftwareComponent = continuousDataProtectionSoftwareComponent;
}
/**
* The current billable public outbound bandwidth for this hardware for the current billing cycle.
*/
@ApiProperty
protected BigDecimal currentBillableBandwidthUsage;
public BigDecimal getCurrentBillableBandwidthUsage() {
return currentBillableBandwidthUsage;
}
public void setCurrentBillableBandwidthUsage(BigDecimal currentBillableBandwidthUsage) {
this.currentBillableBandwidthUsage = currentBillableBandwidthUsage;
}
/**
* Information regarding the datacenter in which a piece of hardware resides.
*/
@ApiProperty
protected Location datacenter;
public Location getDatacenter() {
return datacenter;
}
public void setDatacenter(Location datacenter) {
this.datacenter = datacenter;
}
/**
* The name of the datacenter in which a piece of hardware resides.
*/
@ApiProperty
protected String datacenterName;
public String getDatacenterName() {
return datacenterName;
}
public void setDatacenterName(String datacenterName) {
this.datacenterName = datacenterName;
}
/**
* Number of day(s) a server have been in spare pool.
*/
@ApiProperty
protected Long daysInSparePool;
public Long getDaysInSparePool() {
return daysInSparePool;
}
public void setDaysInSparePool(Long daysInSparePool) {
this.daysInSparePool = daysInSparePool;
}
/**
* All hardware that has uplink network connections to a piece of hardware.
*/
@ApiProperty
protected List downlinkHardware;
public List getDownlinkHardware() {
if (downlinkHardware == null) {
downlinkHardware = new ArrayList();
}
return downlinkHardware;
}
/**
* All hardware that has uplink network connections to a piece of hardware.
*/
@ApiProperty
protected List downlinkNetworkHardware;
public List getDownlinkNetworkHardware() {
if (downlinkNetworkHardware == null) {
downlinkNetworkHardware = new ArrayList();
}
return downlinkNetworkHardware;
}
/**
* Information regarding all servers attached to a piece of network hardware.
*/
@ApiProperty
protected List downlinkServers;
public List getDownlinkServers() {
if (downlinkServers == null) {
downlinkServers = new ArrayList();
}
return downlinkServers;
}
/**
* Information regarding all virtual guests attached to a piece of network hardware.
*/
@ApiProperty
protected List downlinkVirtualGuests;
public List getDownlinkVirtualGuests() {
if (downlinkVirtualGuests == null) {
downlinkVirtualGuests = new ArrayList();
}
return downlinkVirtualGuests;
}
/**
* All hardware downstream from a network device.
*/
@ApiProperty
protected List downstreamHardwareBindings;
public List getDownstreamHardwareBindings() {
if (downstreamHardwareBindings == null) {
downstreamHardwareBindings = new ArrayList();
}
return downstreamHardwareBindings;
}
/**
* All network hardware downstream from the selected piece of hardware.
*/
@ApiProperty
protected List downstreamNetworkHardware;
public List getDownstreamNetworkHardware() {
if (downstreamNetworkHardware == null) {
downstreamNetworkHardware = new ArrayList();
}
return downstreamNetworkHardware;
}
/**
* All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware.
*/
@ApiProperty
protected List downstreamNetworkHardwareWithIncidents;
public List getDownstreamNetworkHardwareWithIncidents() {
if (downstreamNetworkHardwareWithIncidents == null) {
downstreamNetworkHardwareWithIncidents = new ArrayList();
}
return downstreamNetworkHardwareWithIncidents;
}
/**
* Information regarding all servers attached downstream to a piece of network hardware.
*/
@ApiProperty
protected List downstreamServers;
public List getDownstreamServers() {
if (downstreamServers == null) {
downstreamServers = new ArrayList();
}
return downstreamServers;
}
/**
* Information regarding all virtual guests attached to a piece of network hardware.
*/
@ApiProperty
protected List downstreamVirtualGuests;
public List getDownstreamVirtualGuests() {
if (downstreamVirtualGuests == null) {
downstreamVirtualGuests = new ArrayList();
}
return downstreamVirtualGuests;
}
/**
* The drive controllers contained within a piece of hardware.
*/
@ApiProperty
protected List driveControllers;
public List getDriveControllers() {
if (driveControllers == null) {
driveControllers = new ArrayList();
}
return driveControllers;
}
/**
* Information regarding a piece of hardware's associated EVault network storage service account.
*/
@ApiProperty
protected List evaultNetworkStorage;
public List getEvaultNetworkStorage() {
if (evaultNetworkStorage == null) {
evaultNetworkStorage = new ArrayList();
}
return evaultNetworkStorage;
}
/**
* Information regarding a piece of hardware's firewall services.
*/
@ApiProperty
protected Firewall firewallServiceComponent;
public Firewall getFirewallServiceComponent() {
return firewallServiceComponent;
}
public void setFirewallServiceComponent(Firewall firewallServiceComponent) {
this.firewallServiceComponent = firewallServiceComponent;
}
/**
* Defines the fixed components in a fixed configuration bare metal server.
*/
@ApiProperty
protected Preset fixedConfigurationPreset;
public Preset getFixedConfigurationPreset() {
return fixedConfigurationPreset;
}
public void setFixedConfigurationPreset(Preset fixedConfigurationPreset) {
this.fixedConfigurationPreset = fixedConfigurationPreset;
}
/**
* A piece of hardware's front-end or public network components.
*/
@ApiProperty
protected List frontendNetworkComponents;
public List getFrontendNetworkComponents() {
if (frontendNetworkComponents == null) {
frontendNetworkComponents = new ArrayList();
}
return frontendNetworkComponents;
}
/**
* A hardware's frontend or public router.
*/
@ApiProperty
protected List frontendRouters;
public List getFrontendRouters() {
if (frontendRouters == null) {
frontendRouters = new ArrayList();
}
return frontendRouters;
}
/**
* A hardware's universally unique identifier.
*/
@ApiProperty
protected String globalIdentifier;
public String getGlobalIdentifier() {
return globalIdentifier;
}
public void setGlobalIdentifier(String globalIdentifier) {
this.globalIdentifier = globalIdentifier;
}
/**
* The hard drives contained within a piece of hardware.
*/
@ApiProperty
protected List hardDrives;
public List getHardDrives() {
if (hardDrives == null) {
hardDrives = new ArrayList();
}
return hardDrives;
}
/**
* The chassis that a piece of hardware is housed in.
*/
@ApiProperty
protected Chassis hardwareChassis;
public Chassis getHardwareChassis() {
return hardwareChassis;
}
public void setHardwareChassis(Chassis hardwareChassis) {
this.hardwareChassis = hardwareChassis;
}
/**
* A hardware's function.
*/
@ApiProperty
protected Function hardwareFunction;
public Function getHardwareFunction() {
return hardwareFunction;
}
public void setHardwareFunction(Function hardwareFunction) {
this.hardwareFunction = hardwareFunction;
}
/**
* A hardware's function.
*/
@ApiProperty
protected String hardwareFunctionDescription;
public String getHardwareFunctionDescription() {
return hardwareFunctionDescription;
}
public void setHardwareFunctionDescription(String hardwareFunctionDescription) {
this.hardwareFunctionDescription = hardwareFunctionDescription;
}
/**
* A hardware's status.
*/
@ApiProperty
protected Status hardwareStatus;
public Status getHardwareStatus() {
return hardwareStatus;
}
public void setHardwareStatus(Status hardwareStatus) {
this.hardwareStatus = hardwareStatus;
}
/**
* Determine in hardware object has TPM enabled.
*/
@ApiProperty
protected Boolean hasTrustedPlatformModuleBillingItemFlag;
public Boolean getHasTrustedPlatformModuleBillingItemFlag() {
return hasTrustedPlatformModuleBillingItemFlag;
}
public void setHasTrustedPlatformModuleBillingItemFlag(Boolean hasTrustedPlatformModuleBillingItemFlag) {
this.hasTrustedPlatformModuleBillingItemFlag = hasTrustedPlatformModuleBillingItemFlag;
}
/**
* Information regarding a host IPS software component object.
*/
@ApiProperty
protected Component hostIpsSoftwareComponent;
public Component getHostIpsSoftwareComponent() {
return hostIpsSoftwareComponent;
}
public void setHostIpsSoftwareComponent(Component hostIpsSoftwareComponent) {
this.hostIpsSoftwareComponent = hostIpsSoftwareComponent;
}
/**
* A server's hourly billing status.
*/
@ApiProperty
protected Boolean hourlyBillingFlag;
public Boolean getHourlyBillingFlag() {
return hourlyBillingFlag;
}
public void setHourlyBillingFlag(Boolean hourlyBillingFlag) {
this.hourlyBillingFlag = hourlyBillingFlag;
}
/**
* The sum of all the inbound network traffic data for the last 30 days.
*/
@ApiProperty
protected BigDecimal inboundBandwidthUsage;
public BigDecimal getInboundBandwidthUsage() {
return inboundBandwidthUsage;
}
public void setInboundBandwidthUsage(BigDecimal inboundBandwidthUsage) {
this.inboundBandwidthUsage = inboundBandwidthUsage;
}
/**
* The total public inbound bandwidth for this hardware for the current billing cycle.
*/
@ApiProperty
protected BigDecimal inboundPublicBandwidthUsage;
public BigDecimal getInboundPublicBandwidthUsage() {
return inboundPublicBandwidthUsage;
}
public void setInboundPublicBandwidthUsage(BigDecimal inboundPublicBandwidthUsage) {
this.inboundPublicBandwidthUsage = inboundPublicBandwidthUsage;
}
/**
* Information regarding the last transaction a server performed.
*/
@ApiProperty
protected Transaction lastTransaction;
public Transaction getLastTransaction() {
return lastTransaction;
}
public void setLastTransaction(Transaction lastTransaction) {
this.lastTransaction = lastTransaction;
}
/**
* A piece of hardware's latest network monitoring incident.
*/
@ApiProperty
protected Incident latestNetworkMonitorIncident;
public Incident getLatestNetworkMonitorIncident() {
return latestNetworkMonitorIncident;
}
public void setLatestNetworkMonitorIncident(Incident latestNetworkMonitorIncident) {
this.latestNetworkMonitorIncident = latestNetworkMonitorIncident;
}
/**
* Where a piece of hardware is located within SoftLayer's location hierarchy.
*/
@ApiProperty
protected Location location;
public Location getLocation() {
return location;
}
public void setLocation(Location location) {
this.location = location;
}
@ApiProperty
protected String locationPathString;
public String getLocationPathString() {
return locationPathString;
}
public void setLocationPathString(String locationPathString) {
this.locationPathString = locationPathString;
}
/**
* Information regarding a lockbox account associated with a server.
*/
@ApiProperty
protected Storage lockboxNetworkStorage;
public Storage getLockboxNetworkStorage() {
return lockboxNetworkStorage;
}
public void setLockboxNetworkStorage(Storage lockboxNetworkStorage) {
this.lockboxNetworkStorage = lockboxNetworkStorage;
}
/**
* A flag indicating that the hardware is a managed resource.
*/
@ApiProperty
protected Boolean managedResourceFlag;
public Boolean getManagedResourceFlag() {
return managedResourceFlag;
}
public void setManagedResourceFlag(Boolean managedResourceFlag) {
this.managedResourceFlag = managedResourceFlag;
}
/**
* Information regarding a piece of hardware's memory.
*/
@ApiProperty
protected List memory;
public List getMemory() {
if (memory == null) {
memory = new ArrayList();
}
return memory;
}
/**
* The amount of memory a piece of hardware has, measured in gigabytes.
*/
@ApiProperty
protected Long memoryCapacity;
public Long getMemoryCapacity() {
return memoryCapacity;
}
public void setMemoryCapacity(Long memoryCapacity) {
this.memoryCapacity = memoryCapacity;
}
/**
* A piece of hardware's metric tracking object.
*/
@ApiProperty
protected HardwareServer metricTrackingObject;
public HardwareServer getMetricTrackingObject() {
return metricTrackingObject;
}
public void setMetricTrackingObject(HardwareServer metricTrackingObject) {
this.metricTrackingObject = metricTrackingObject;
}
@ApiProperty
protected List modules;
public List getModules() {
if (modules == null) {
modules = new ArrayList();
}
return modules;
}
/**
* Information regarding a piece of hardware's network monitoring services.
*/
@ApiProperty
protected Stratum monitoringServiceComponent;
public Stratum getMonitoringServiceComponent() {
return monitoringServiceComponent;
}
public void setMonitoringServiceComponent(Stratum monitoringServiceComponent) {
this.monitoringServiceComponent = monitoringServiceComponent;
}
/**
* Information regarding a piece of hardware's motherboard.
*/
@ApiProperty
protected com.softlayer.api.service.hardware.Component motherboard;
public com.softlayer.api.service.hardware.Component getMotherboard() {
return motherboard;
}
public void setMotherboard(com.softlayer.api.service.hardware.Component motherboard) {
this.motherboard = motherboard;
}
/**
* Information regarding a piece of hardware's network cards.
*/
@ApiProperty
protected List networkCards;
public List getNetworkCards() {
if (networkCards == null) {
networkCards = new ArrayList();
}
return networkCards;
}
/**
* Returns a hardware's network components.
*/
@ApiProperty
protected List networkComponents;
public List getNetworkComponents() {
if (networkComponents == null) {
networkComponents = new ArrayList();
}
return networkComponents;
}
/**
* The gateway member if this device is part of a network gateway.
*/
@ApiProperty
protected com.softlayer.api.service.network.gateway.Member networkGatewayMember;
public com.softlayer.api.service.network.gateway.Member getNetworkGatewayMember() {
return networkGatewayMember;
}
public void setNetworkGatewayMember(com.softlayer.api.service.network.gateway.Member networkGatewayMember) {
this.networkGatewayMember = networkGatewayMember;
}
/**
* Whether or not this device is part of a network gateway.
*/
@ApiProperty
protected Boolean networkGatewayMemberFlag;
public Boolean getNetworkGatewayMemberFlag() {
return networkGatewayMemberFlag;
}
public void setNetworkGatewayMemberFlag(Boolean networkGatewayMemberFlag) {
this.networkGatewayMemberFlag = networkGatewayMemberFlag;
}
/**
* A piece of hardware's network management IP address.
*/
@ApiProperty
protected String networkManagementIpAddress;
public String getNetworkManagementIpAddress() {
return networkManagementIpAddress;
}
public void setNetworkManagementIpAddress(String networkManagementIpAddress) {
this.networkManagementIpAddress = networkManagementIpAddress;
}
/**
* All servers with failed monitoring that are attached downstream to a piece of hardware.
*/
@ApiProperty
protected List networkMonitorAttachedDownHardware;
public List getNetworkMonitorAttachedDownHardware() {
if (networkMonitorAttachedDownHardware == null) {
networkMonitorAttachedDownHardware = new ArrayList();
}
return networkMonitorAttachedDownHardware;
}
/**
* Virtual guests that are attached downstream to a hardware that have failed monitoring
*/
@ApiProperty
protected List networkMonitorAttachedDownVirtualGuests;
public List getNetworkMonitorAttachedDownVirtualGuests() {
if (networkMonitorAttachedDownVirtualGuests == null) {
networkMonitorAttachedDownVirtualGuests = new ArrayList();
}
return networkMonitorAttachedDownVirtualGuests;
}
/**
* The status of all of a piece of hardware's network monitoring incidents.
*/
@ApiProperty
protected List networkMonitorIncidents;
public List getNetworkMonitorIncidents() {
if (networkMonitorIncidents == null) {
networkMonitorIncidents = new ArrayList();
}
return networkMonitorIncidents;
}
/**
* Information regarding a piece of hardware's network monitors.
*/
@ApiProperty
protected List networkMonitors;
public List getNetworkMonitors() {
if (networkMonitors == null) {
networkMonitors = new ArrayList();
}
return networkMonitors;
}
/**
* The value of a hardware's network status attribute.
*/
@ApiProperty
protected String networkStatus;
public String getNetworkStatus() {
return networkStatus;
}
public void setNetworkStatus(String networkStatus) {
this.networkStatus = networkStatus;
}
/**
* The hardware's related network status attribute.
*/
@ApiProperty
protected Attribute networkStatusAttribute;
public Attribute getNetworkStatusAttribute() {
return networkStatusAttribute;
}
public void setNetworkStatusAttribute(Attribute networkStatusAttribute) {
this.networkStatusAttribute = networkStatusAttribute;
}
/**
* Information regarding a piece of hardware's associated network storage service account.
*/
@ApiProperty
protected List networkStorage;
public List getNetworkStorage() {
if (networkStorage == null) {
networkStorage = new ArrayList();
}
return networkStorage;
}
/**
* The network virtual LANs (VLANs) associated with a piece of hardware's network components.
*/
@ApiProperty
protected List networkVlans;
public List getNetworkVlans() {
if (networkVlans == null) {
networkVlans = new ArrayList();
}
return networkVlans;
}
/**
* A hardware's allotted bandwidth for the next billing cycle (measured in GB).
*/
@ApiProperty
protected BigDecimal nextBillingCycleBandwidthAllocation;
public BigDecimal getNextBillingCycleBandwidthAllocation() {
return nextBillingCycleBandwidthAllocation;
}
public void setNextBillingCycleBandwidthAllocation(BigDecimal nextBillingCycleBandwidthAllocation) {
this.nextBillingCycleBandwidthAllocation = nextBillingCycleBandwidthAllocation;
}
@ApiProperty
protected List notesHistory;
public List getNotesHistory() {
if (notesHistory == null) {
notesHistory = new ArrayList();
}
return notesHistory;
}
/**
* The amount of non-volatile memory a piece of hardware has, measured in gigabytes.
*/
@ApiProperty
protected Long nvRamCapacity;
public Long getNvRamCapacity() {
return nvRamCapacity;
}
public void setNvRamCapacity(Long nvRamCapacity) {
this.nvRamCapacity = nvRamCapacity;
}
@ApiProperty
protected List nvRamComponentModels;
public List getNvRamComponentModels() {
if (nvRamComponentModels == null) {
nvRamComponentModels = new ArrayList();
}
return nvRamComponentModels;
}
/**
* Information regarding a piece of hardware's operating system.
*/
@ApiProperty
protected OperatingSystem operatingSystem;
public OperatingSystem getOperatingSystem() {
return operatingSystem;
}
public void setOperatingSystem(OperatingSystem operatingSystem) {
this.operatingSystem = operatingSystem;
}
/**
* A hardware's operating system software description.
*/
@ApiProperty
protected String operatingSystemReferenceCode;
public String getOperatingSystemReferenceCode() {
return operatingSystemReferenceCode;
}
public void setOperatingSystemReferenceCode(String operatingSystemReferenceCode) {
this.operatingSystemReferenceCode = operatingSystemReferenceCode;
}
/**
* The sum of all the outbound network traffic data for the last 30 days.
*/
@ApiProperty
protected BigDecimal outboundBandwidthUsage;
public BigDecimal getOutboundBandwidthUsage() {
return outboundBandwidthUsage;
}
public void setOutboundBandwidthUsage(BigDecimal outboundBandwidthUsage) {
this.outboundBandwidthUsage = outboundBandwidthUsage;
}
/**
* The total public outbound bandwidth for this hardware for the current billing cycle.
*/
@ApiProperty
protected BigDecimal outboundPublicBandwidthUsage;
public BigDecimal getOutboundPublicBandwidthUsage() {
return outboundPublicBandwidthUsage;
}
public void setOutboundPublicBandwidthUsage(BigDecimal outboundPublicBandwidthUsage) {
this.outboundPublicBandwidthUsage = outboundPublicBandwidthUsage;
}
/**
* Blade Bay
*/
@ApiProperty
protected Blade parentBay;
public Blade getParentBay() {
return parentBay;
}
public void setParentBay(Blade parentBay) {
this.parentBay = parentBay;
}
/**
* Parent Hardware.
*/
@ApiProperty
protected Hardware parentHardware;
public Hardware getParentHardware() {
return parentHardware;
}
public void setParentHardware(Hardware parentHardware) {
this.parentHardware = parentHardware;
}
/**
* Information regarding the Point of Presence (PoP) location in which a piece of hardware resides.
*/
@ApiProperty
protected Location pointOfPresenceLocation;
public Location getPointOfPresenceLocation() {
return pointOfPresenceLocation;
}
public void setPointOfPresenceLocation(Location pointOfPresenceLocation) {
this.pointOfPresenceLocation = pointOfPresenceLocation;
}
/**
* The power components for a hardware object.
*/
@ApiProperty
protected List powerComponents;
public List getPowerComponents() {
if (powerComponents == null) {
powerComponents = new ArrayList();
}
return powerComponents;
}
/**
* Information regarding a piece of hardware's power supply.
*/
@ApiProperty
protected List powerSupply;
public List getPowerSupply() {
if (powerSupply == null) {
powerSupply = new ArrayList();
}
return powerSupply;
}
/**
* The hardware's primary private IP address.
*/
@ApiProperty
protected String primaryBackendIpAddress;
public String getPrimaryBackendIpAddress() {
return primaryBackendIpAddress;
}
public void setPrimaryBackendIpAddress(String primaryBackendIpAddress) {
this.primaryBackendIpAddress = primaryBackendIpAddress;
}
/**
* Information regarding the hardware's primary back-end network component.
*/
@ApiProperty
protected com.softlayer.api.service.network.Component primaryBackendNetworkComponent;
public com.softlayer.api.service.network.Component getPrimaryBackendNetworkComponent() {
return primaryBackendNetworkComponent;
}
public void setPrimaryBackendNetworkComponent(com.softlayer.api.service.network.Component primaryBackendNetworkComponent) {
this.primaryBackendNetworkComponent = primaryBackendNetworkComponent;
}
/**
* The hardware's primary public IP address.
*/
@ApiProperty
protected String primaryIpAddress;
public String getPrimaryIpAddress() {
return primaryIpAddress;
}
public void setPrimaryIpAddress(String primaryIpAddress) {
this.primaryIpAddress = primaryIpAddress;
}
/**
* Information regarding the hardware's primary public network component.
*/
@ApiProperty
protected com.softlayer.api.service.network.Component primaryNetworkComponent;
public com.softlayer.api.service.network.Component getPrimaryNetworkComponent() {
return primaryNetworkComponent;
}
public void setPrimaryNetworkComponent(com.softlayer.api.service.network.Component primaryNetworkComponent) {
this.primaryNetworkComponent = primaryNetworkComponent;
}
/**
* Whether the hardware only has access to the private network.
*/
@ApiProperty
protected Boolean privateNetworkOnlyFlag;
public Boolean getPrivateNetworkOnlyFlag() {
return privateNetworkOnlyFlag;
}
public void setPrivateNetworkOnlyFlag(Boolean privateNetworkOnlyFlag) {
this.privateNetworkOnlyFlag = privateNetworkOnlyFlag;
}
/**
* The total number of processor cores, summed from all processors that are attached to a piece of hardware
*/
@ApiProperty
protected Long processorCoreAmount;
public Long getProcessorCoreAmount() {
return processorCoreAmount;
}
public void setProcessorCoreAmount(Long processorCoreAmount) {
this.processorCoreAmount = processorCoreAmount;
}
/**
* The total number of physical processor cores, summed from all processors that are attached to a piece of hardware
*/
@ApiProperty
protected Long processorPhysicalCoreAmount;
public Long getProcessorPhysicalCoreAmount() {
return processorPhysicalCoreAmount;
}
public void setProcessorPhysicalCoreAmount(Long processorPhysicalCoreAmount) {
this.processorPhysicalCoreAmount = processorPhysicalCoreAmount;
}
/**
* Information regarding a piece of hardware's processors.
*/
@ApiProperty
protected List processors;
public List getProcessors() {
if (processors == null) {
processors = new ArrayList();
}
return processors;
}
@ApiProperty
protected Location rack;
public Location getRack() {
return rack;
}
public void setRack(Location rack) {
this.rack = rack;
}
/**
* The RAID controllers contained within a piece of hardware.
*/
@ApiProperty
protected List raidControllers;
public List getRaidControllers() {
if (raidControllers == null) {
raidControllers = new ArrayList();
}
return raidControllers;
}
/**
* Recent events that impact this hardware.
*/
@ApiProperty
protected List recentEvents;
public List getRecentEvents() {
if (recentEvents == null) {
recentEvents = new ArrayList();
}
return recentEvents;
}
/**
* User credentials to issue commands and/or interact with the server's remote management card.
*/
@ApiProperty
protected List remoteManagementAccounts;
public List getRemoteManagementAccounts() {
if (remoteManagementAccounts == null) {
remoteManagementAccounts = new ArrayList();
}
return remoteManagementAccounts;
}
/**
* A hardware's associated remote management component. This is normally IPMI.
*/
@ApiProperty
protected com.softlayer.api.service.network.Component remoteManagementComponent;
public com.softlayer.api.service.network.Component getRemoteManagementComponent() {
return remoteManagementComponent;
}
public void setRemoteManagementComponent(com.softlayer.api.service.network.Component remoteManagementComponent) {
this.remoteManagementComponent = remoteManagementComponent;
}
@ApiProperty
protected List resourceConfigurations;
public List getResourceConfigurations() {
if (resourceConfigurations == null) {
resourceConfigurations = new ArrayList();
}
return resourceConfigurations;
}
@ApiProperty
protected List resourceGroupMemberReferences;
public List getResourceGroupMemberReferences() {
if (resourceGroupMemberReferences == null) {
resourceGroupMemberReferences = new ArrayList();
}
return resourceGroupMemberReferences;
}
@ApiProperty
protected List resourceGroupRoles;
public List getResourceGroupRoles() {
if (resourceGroupRoles == null) {
resourceGroupRoles = new ArrayList();
}
return resourceGroupRoles;
}
/**
* The resource groups in which this hardware is a member.
*/
@ApiProperty
protected List resourceGroups;
public List getResourceGroups() {
if (resourceGroups == null) {
resourceGroups = new ArrayList();
}
return resourceGroups;
}
/**
* A hardware's routers.
*/
@ApiProperty
protected List routers;
public List getRouters() {
if (routers == null) {
routers = new ArrayList();
}
return routers;
}
/**
* Collection of scale assets this hardware corresponds to.
*/
@ApiProperty
protected List scaleAssets;
public List getScaleAssets() {
if (scaleAssets == null) {
scaleAssets = new ArrayList();
}
return scaleAssets;
}
/**
* Information regarding a piece of hardware's vulnerability scan requests.
*/
@ApiProperty
protected List securityScanRequests;
public List getSecurityScanRequests() {
if (securityScanRequests == null) {
securityScanRequests = new ArrayList();
}
return securityScanRequests;
}
/**
* Information regarding the server room in which the hardware is located.
*/
@ApiProperty
protected Location serverRoom;
public Location getServerRoom() {
return serverRoom;
}
public void setServerRoom(Location serverRoom) {
this.serverRoom = serverRoom;
}
/**
* Information regarding the piece of hardware's service provider.
*/
@ApiProperty
protected Provider serviceProvider;
public Provider getServiceProvider() {
return serviceProvider;
}
public void setServiceProvider(Provider serviceProvider) {
this.serviceProvider = serviceProvider;
}
/**
* Information regarding a piece of hardware's installed software.
*/
@ApiProperty
protected List softwareComponents;
public List getSoftwareComponents() {
if (softwareComponents == null) {
softwareComponents = new ArrayList();
}
return softwareComponents;
}
/**
* Information regarding the billing item for a spare pool server.
*/
@ApiProperty
protected com.softlayer.api.service.billing.item.Hardware sparePoolBillingItem;
public com.softlayer.api.service.billing.item.Hardware getSparePoolBillingItem() {
return sparePoolBillingItem;
}
public void setSparePoolBillingItem(com.softlayer.api.service.billing.item.Hardware sparePoolBillingItem) {
this.sparePoolBillingItem = sparePoolBillingItem;
}
/**
* SSH keys to be installed on the server during provisioning or an OS reload.
*/
@ApiProperty
protected List sshKeys;
public List getSshKeys() {
if (sshKeys == null) {
sshKeys = new ArrayList();
}
return sshKeys;
}
@ApiProperty
protected List storageGroups;
public List getStorageGroups() {
if (storageGroups == null) {
storageGroups = new ArrayList();
}
return storageGroups;
}
/**
* A piece of hardware's private storage network components. [Deprecated]
*/
@ApiProperty
protected List storageNetworkComponents;
public List getStorageNetworkComponents() {
if (storageNetworkComponents == null) {
storageNetworkComponents = new ArrayList();
}
return storageNetworkComponents;
}
@ApiProperty
protected List tagReferences;
public List getTagReferences() {
if (tagReferences == null) {
tagReferences = new ArrayList();
}
return tagReferences;
}
@ApiProperty
protected Location topLevelLocation;
public Location getTopLevelLocation() {
return topLevelLocation;
}
public void setTopLevelLocation(Location topLevelLocation) {
this.topLevelLocation = topLevelLocation;
}
/**
* An account's associated upgrade request object, if any.
*/
@ApiProperty
protected Request upgradeRequest;
public Request getUpgradeRequest() {
return upgradeRequest;
}
public void setUpgradeRequest(Request upgradeRequest) {
this.upgradeRequest = upgradeRequest;
}
/**
* The network device connected to a piece of hardware.
*/
@ApiProperty
protected Hardware uplinkHardware;
public Hardware getUplinkHardware() {
return uplinkHardware;
}
public void setUplinkHardware(Hardware uplinkHardware) {
this.uplinkHardware = uplinkHardware;
}
/**
* Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.
*/
@ApiProperty
protected List uplinkNetworkComponents;
public List getUplinkNetworkComponents() {
if (uplinkNetworkComponents == null) {
uplinkNetworkComponents = new ArrayList();
}
return uplinkNetworkComponents;
}
/**
* An array containing a single string of custom user data for a hardware order. Max size is 16 kb.
*/
@ApiProperty
protected List userData;
public List getUserData() {
if (userData == null) {
userData = new ArrayList();
}
return userData;
}
/**
* Information regarding the virtual chassis for a piece of hardware.
*/
@ApiProperty
protected com.softlayer.api.service.hardware.Group virtualChassis;
public com.softlayer.api.service.hardware.Group getVirtualChassis() {
return virtualChassis;
}
public void setVirtualChassis(com.softlayer.api.service.hardware.Group virtualChassis) {
this.virtualChassis = virtualChassis;
}
/**
* Information regarding the virtual chassis siblings for a piece of hardware.
*/
@ApiProperty
protected List virtualChassisSiblings;
public List getVirtualChassisSiblings() {
if (virtualChassisSiblings == null) {
virtualChassisSiblings = new ArrayList();
}
return virtualChassisSiblings;
}
/**
* A piece of hardware's virtual host record.
*/
@ApiProperty
protected Host virtualHost;
public Host getVirtualHost() {
return virtualHost;
}
public void setVirtualHost(Host virtualHost) {
this.virtualHost = virtualHost;
}
/**
* Information regarding a piece of hardware's virtual software licenses.
*/
@ApiProperty
protected List virtualLicenses;
public List getVirtualLicenses() {
if (virtualLicenses == null) {
virtualLicenses = new ArrayList();
}
return virtualLicenses;
}
/**
* Information regarding the bandwidth allotment to which a piece of hardware belongs.
*/
@ApiProperty
protected Allotment virtualRack;
public Allotment getVirtualRack() {
return virtualRack;
}
public void setVirtualRack(Allotment virtualRack) {
this.virtualRack = virtualRack;
}
/**
* The name of the bandwidth allotment belonging to a piece of hardware.
*/
@ApiProperty
protected Long virtualRackId;
public Long getVirtualRackId() {
return virtualRackId;
}
public void setVirtualRackId(Long virtualRackId) {
this.virtualRackId = virtualRackId;
}
/**
* The name of the bandwidth allotment belonging to a piece of hardware.
*/
@ApiProperty
protected String virtualRackName;
public String getVirtualRackName() {
return virtualRackName;
}
public void setVirtualRackName(String virtualRackName) {
this.virtualRackName = virtualRackName;
}
/**
* A piece of hardware's virtualization platform software.
*/
@ApiProperty
protected Component virtualizationPlatform;
public Component getVirtualizationPlatform() {
return virtualizationPlatform;
}
public void setVirtualizationPlatform(Component virtualizationPlatform) {
this.virtualizationPlatform = virtualizationPlatform;
}
/**
* A hardware's associated [[SoftLayer_Account|account]] id.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long accountId;
public Long getAccountId() {
return accountId;
}
public void setAccountId(Long accountId) {
accountIdSpecified = true;
this.accountId = accountId;
}
protected boolean accountIdSpecified;
public boolean isAccountIdSpecified() {
return accountIdSpecified;
}
public void unsetAccountId() {
accountId = null;
accountIdSpecified = false;
}
/**
* When true, this flag specifies that a hardware is Bare Metal Server. Bare Metal Servers are physical bare metal servers that are billed with the same options as Virtual Servers, with monthly and hourly rates. Bare Metal instances are ordered based on processor core count and ram amount.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long bareMetalInstanceFlag;
public Long getBareMetalInstanceFlag() {
return bareMetalInstanceFlag;
}
public void setBareMetalInstanceFlag(Long bareMetalInstanceFlag) {
bareMetalInstanceFlagSpecified = true;
this.bareMetalInstanceFlag = bareMetalInstanceFlag;
}
protected boolean bareMetalInstanceFlagSpecified;
public boolean isBareMetalInstanceFlagSpecified() {
return bareMetalInstanceFlagSpecified;
}
public void unsetBareMetalInstanceFlag() {
bareMetalInstanceFlag = null;
bareMetalInstanceFlagSpecified = false;
}
/**
* A piece of hardware's local network domain name.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String domain;
public String getDomain() {
return domain;
}
public void setDomain(String domain) {
domainSpecified = true;
this.domain = domain;
}
protected boolean domainSpecified;
public boolean isDomainSpecified() {
return domainSpecified;
}
public void unsetDomain() {
domain = null;
domainSpecified = false;
}
/**
* A name reflecting the hostname and domain of the hardware. This is created from the combined values of the hardware's hostname and domain name automatically, and thus should not be edited directly.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String fullyQualifiedDomainName;
public String getFullyQualifiedDomainName() {
return fullyQualifiedDomainName;
}
public void setFullyQualifiedDomainName(String fullyQualifiedDomainName) {
fullyQualifiedDomainNameSpecified = true;
this.fullyQualifiedDomainName = fullyQualifiedDomainName;
}
protected boolean fullyQualifiedDomainNameSpecified;
public boolean isFullyQualifiedDomainNameSpecified() {
return fullyQualifiedDomainNameSpecified;
}
public void unsetFullyQualifiedDomainName() {
fullyQualifiedDomainName = null;
fullyQualifiedDomainNameSpecified = false;
}
/**
* A number reflecting the state of a hardware
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long hardwareStatusId;
public Long getHardwareStatusId() {
return hardwareStatusId;
}
public void setHardwareStatusId(Long hardwareStatusId) {
hardwareStatusIdSpecified = true;
this.hardwareStatusId = hardwareStatusId;
}
protected boolean hardwareStatusIdSpecified;
public boolean isHardwareStatusIdSpecified() {
return hardwareStatusIdSpecified;
}
public void unsetHardwareStatusId() {
hardwareStatusId = null;
hardwareStatusIdSpecified = false;
}
/**
* A hardware's hostname
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String hostname;
public String getHostname() {
return hostname;
}
public void setHostname(String hostname) {
hostnameSpecified = true;
this.hostname = hostname;
}
protected boolean hostnameSpecified;
public boolean isHostnameSpecified() {
return hostnameSpecified;
}
public void unsetHostname() {
hostname = null;
hostnameSpecified = false;
}
/**
* A hardware's internal identification number
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long id;
public Long getId() {
return id;
}
public void setId(Long id) {
idSpecified = true;
this.id = id;
}
protected boolean idSpecified;
public boolean isIdSpecified() {
return idSpecified;
}
public void unsetId() {
id = null;
idSpecified = false;
}
/**
* A hardware's serial number that is supplied by the manufacturer.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String manufacturerSerialNumber;
public String getManufacturerSerialNumber() {
return manufacturerSerialNumber;
}
public void setManufacturerSerialNumber(String manufacturerSerialNumber) {
manufacturerSerialNumberSpecified = true;
this.manufacturerSerialNumber = manufacturerSerialNumber;
}
protected boolean manufacturerSerialNumberSpecified;
public boolean isManufacturerSerialNumberSpecified() {
return manufacturerSerialNumberSpecified;
}
public void unsetManufacturerSerialNumber() {
manufacturerSerialNumber = null;
manufacturerSerialNumberSpecified = false;
}
/**
* A small note about a piece of hardware to use at your discretion.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String notes;
public String getNotes() {
return notes;
}
public void setNotes(String notes) {
notesSpecified = true;
this.notes = notes;
}
protected boolean notesSpecified;
public boolean isNotesSpecified() {
return notesSpecified;
}
public void unsetNotes() {
notes = null;
notesSpecified = false;
}
/**
* URI of the script to be downloaded and executed after installation is complete.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String postInstallScriptUri;
public String getPostInstallScriptUri() {
return postInstallScriptUri;
}
public void setPostInstallScriptUri(String postInstallScriptUri) {
postInstallScriptUriSpecified = true;
this.postInstallScriptUri = postInstallScriptUri;
}
protected boolean postInstallScriptUriSpecified;
public boolean isPostInstallScriptUriSpecified() {
return postInstallScriptUriSpecified;
}
public void unsetPostInstallScriptUri() {
postInstallScriptUri = null;
postInstallScriptUriSpecified = false;
}
@ApiProperty(canBeNullOrNotSet = true)
protected GregorianCalendar provisionDate;
public GregorianCalendar getProvisionDate() {
return provisionDate;
}
public void setProvisionDate(GregorianCalendar provisionDate) {
provisionDateSpecified = true;
this.provisionDate = provisionDate;
}
protected boolean provisionDateSpecified;
public boolean isProvisionDateSpecified() {
return provisionDateSpecified;
}
public void unsetProvisionDate() {
provisionDate = null;
provisionDateSpecified = false;
}
/**
* A hardware's serial number that is supplied by SoftLayer.
*/
@ApiProperty(canBeNullOrNotSet = true)
protected String serialNumber;
public String getSerialNumber() {
return serialNumber;
}
public void setSerialNumber(String serialNumber) {
serialNumberSpecified = true;
this.serialNumber = serialNumber;
}
protected boolean serialNumberSpecified;
public boolean isSerialNumberSpecified() {
return serialNumberSpecified;
}
public void unsetSerialNumber() {
serialNumber = null;
serialNumberSpecified = false;
}
@ApiProperty(canBeNullOrNotSet = true)
protected Long serviceProviderId;
public Long getServiceProviderId() {
return serviceProviderId;
}
public void setServiceProviderId(Long serviceProviderId) {
serviceProviderIdSpecified = true;
this.serviceProviderId = serviceProviderId;
}
protected boolean serviceProviderIdSpecified;
public boolean isServiceProviderIdSpecified() {
return serviceProviderIdSpecified;
}
public void unsetServiceProviderId() {
serviceProviderId = null;
serviceProviderIdSpecified = false;
}
/**
* A hardware's internal identification number at its service provider
*/
@ApiProperty(canBeNullOrNotSet = true)
protected Long serviceProviderResourceId;
public Long getServiceProviderResourceId() {
return serviceProviderResourceId;
}
public void setServiceProviderResourceId(Long serviceProviderResourceId) {
serviceProviderResourceIdSpecified = true;
this.serviceProviderResourceId = serviceProviderResourceId;
}
protected boolean serviceProviderResourceIdSpecified;
public boolean isServiceProviderResourceIdSpecified() {
return serviceProviderResourceIdSpecified;
}
public void unsetServiceProviderResourceId() {
serviceProviderResourceId = null;
serviceProviderResourceIdSpecified = false;
}
/**
* A count of a piece of hardware's active physical components.
*/
@ApiProperty
protected Long activeComponentCount;
public Long getActiveComponentCount() {
return activeComponentCount;
}
public void setActiveComponentCount(Long activeComponentCount) {
this.activeComponentCount = activeComponentCount;
}
/**
* A count of a piece of hardware's active network monitoring incidents.
*/
@ApiProperty
protected Long activeNetworkMonitorIncidentCount;
public Long getActiveNetworkMonitorIncidentCount() {
return activeNetworkMonitorIncidentCount;
}
public void setActiveNetworkMonitorIncidentCount(Long activeNetworkMonitorIncidentCount) {
this.activeNetworkMonitorIncidentCount = activeNetworkMonitorIncidentCount;
}
/**
* A count of
*/
@ApiProperty
protected Long allPowerComponentCount;
public Long getAllPowerComponentCount() {
return allPowerComponentCount;
}
public void setAllPowerComponentCount(Long allPowerComponentCount) {
this.allPowerComponentCount = allPowerComponentCount;
}
/**
* A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
*/
@ApiProperty
protected Long allowedNetworkStorageCount;
public Long getAllowedNetworkStorageCount() {
return allowedNetworkStorageCount;
}
public void setAllowedNetworkStorageCount(Long allowedNetworkStorageCount) {
this.allowedNetworkStorageCount = allowedNetworkStorageCount;
}
/**
* A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
*/
@ApiProperty
protected Long allowedNetworkStorageReplicaCount;
public Long getAllowedNetworkStorageReplicaCount() {
return allowedNetworkStorageReplicaCount;
}
public void setAllowedNetworkStorageReplicaCount(Long allowedNetworkStorageReplicaCount) {
this.allowedNetworkStorageReplicaCount = allowedNetworkStorageReplicaCount;
}
/**
* A count of information regarding a piece of hardware's specific attributes.
*/
@ApiProperty
protected Long attributeCount;
public Long getAttributeCount() {
return attributeCount;
}
public void setAttributeCount(Long attributeCount) {
this.attributeCount = attributeCount;
}
/**
* A count of a piece of hardware's back-end or private network components.
*/
@ApiProperty
protected Long backendNetworkComponentCount;
public Long getBackendNetworkComponentCount() {
return backendNetworkComponentCount;
}
public void setBackendNetworkComponentCount(Long backendNetworkComponentCount) {
this.backendNetworkComponentCount = backendNetworkComponentCount;
}
/**
* A count of a hardware's backend or private router.
*/
@ApiProperty
protected Long backendRouterCount;
public Long getBackendRouterCount() {
return backendRouterCount;
}
public void setBackendRouterCount(Long backendRouterCount) {
this.backendRouterCount = backendRouterCount;
}
/**
* A count of information regarding a piece of hardware's benchmark certifications.
*/
@ApiProperty
protected Long benchmarkCertificationCount;
public Long getBenchmarkCertificationCount() {
return benchmarkCertificationCount;
}
public void setBenchmarkCertificationCount(Long benchmarkCertificationCount) {
this.benchmarkCertificationCount = benchmarkCertificationCount;
}
/**
* A count of child hardware.
*/
@ApiProperty
protected Long childrenHardwareCount;
public Long getChildrenHardwareCount() {
return childrenHardwareCount;
}
public void setChildrenHardwareCount(Long childrenHardwareCount) {
this.childrenHardwareCount = childrenHardwareCount;
}
/**
* A count of a piece of hardware's components.
*/
@ApiProperty
protected Long componentCount;
public Long getComponentCount() {
return componentCount;
}
public void setComponentCount(Long componentCount) {
this.componentCount = componentCount;
}
/**
* A count of all hardware that has uplink network connections to a piece of hardware.
*/
@ApiProperty
protected Long downlinkHardwareCount;
public Long getDownlinkHardwareCount() {
return downlinkHardwareCount;
}
public void setDownlinkHardwareCount(Long downlinkHardwareCount) {
this.downlinkHardwareCount = downlinkHardwareCount;
}
/**
* A count of all hardware that has uplink network connections to a piece of hardware.
*/
@ApiProperty
protected Long downlinkNetworkHardwareCount;
public Long getDownlinkNetworkHardwareCount() {
return downlinkNetworkHardwareCount;
}
public void setDownlinkNetworkHardwareCount(Long downlinkNetworkHardwareCount) {
this.downlinkNetworkHardwareCount = downlinkNetworkHardwareCount;
}
/**
* A count of information regarding all servers attached to a piece of network hardware.
*/
@ApiProperty
protected Long downlinkServerCount;
public Long getDownlinkServerCount() {
return downlinkServerCount;
}
public void setDownlinkServerCount(Long downlinkServerCount) {
this.downlinkServerCount = downlinkServerCount;
}
/**
* A count of information regarding all virtual guests attached to a piece of network hardware.
*/
@ApiProperty
protected Long downlinkVirtualGuestCount;
public Long getDownlinkVirtualGuestCount() {
return downlinkVirtualGuestCount;
}
public void setDownlinkVirtualGuestCount(Long downlinkVirtualGuestCount) {
this.downlinkVirtualGuestCount = downlinkVirtualGuestCount;
}
/**
* A count of all hardware downstream from a network device.
*/
@ApiProperty
protected Long downstreamHardwareBindingCount;
public Long getDownstreamHardwareBindingCount() {
return downstreamHardwareBindingCount;
}
public void setDownstreamHardwareBindingCount(Long downstreamHardwareBindingCount) {
this.downstreamHardwareBindingCount = downstreamHardwareBindingCount;
}
/**
* A count of all network hardware downstream from the selected piece of hardware.
*/
@ApiProperty
protected Long downstreamNetworkHardwareCount;
public Long getDownstreamNetworkHardwareCount() {
return downstreamNetworkHardwareCount;
}
public void setDownstreamNetworkHardwareCount(Long downstreamNetworkHardwareCount) {
this.downstreamNetworkHardwareCount = downstreamNetworkHardwareCount;
}
/**
* A count of all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware.
*/
@ApiProperty
protected Long downstreamNetworkHardwareWithIncidentCount;
public Long getDownstreamNetworkHardwareWithIncidentCount() {
return downstreamNetworkHardwareWithIncidentCount;
}
public void setDownstreamNetworkHardwareWithIncidentCount(Long downstreamNetworkHardwareWithIncidentCount) {
this.downstreamNetworkHardwareWithIncidentCount = downstreamNetworkHardwareWithIncidentCount;
}
/**
* A count of information regarding all servers attached downstream to a piece of network hardware.
*/
@ApiProperty
protected Long downstreamServerCount;
public Long getDownstreamServerCount() {
return downstreamServerCount;
}
public void setDownstreamServerCount(Long downstreamServerCount) {
this.downstreamServerCount = downstreamServerCount;
}
/**
* A count of information regarding all virtual guests attached to a piece of network hardware.
*/
@ApiProperty
protected Long downstreamVirtualGuestCount;
public Long getDownstreamVirtualGuestCount() {
return downstreamVirtualGuestCount;
}
public void setDownstreamVirtualGuestCount(Long downstreamVirtualGuestCount) {
this.downstreamVirtualGuestCount = downstreamVirtualGuestCount;
}
/**
* A count of the drive controllers contained within a piece of hardware.
*/
@ApiProperty
protected Long driveControllerCount;
public Long getDriveControllerCount() {
return driveControllerCount;
}
public void setDriveControllerCount(Long driveControllerCount) {
this.driveControllerCount = driveControllerCount;
}
/**
* A count of information regarding a piece of hardware's associated EVault network storage service account.
*/
@ApiProperty
protected Long evaultNetworkStorageCount;
public Long getEvaultNetworkStorageCount() {
return evaultNetworkStorageCount;
}
public void setEvaultNetworkStorageCount(Long evaultNetworkStorageCount) {
this.evaultNetworkStorageCount = evaultNetworkStorageCount;
}
/**
* A count of a piece of hardware's front-end or public network components.
*/
@ApiProperty
protected Long frontendNetworkComponentCount;
public Long getFrontendNetworkComponentCount() {
return frontendNetworkComponentCount;
}
public void setFrontendNetworkComponentCount(Long frontendNetworkComponentCount) {
this.frontendNetworkComponentCount = frontendNetworkComponentCount;
}
/**
* A count of a hardware's frontend or public router.
*/
@ApiProperty
protected Long frontendRouterCount;
public Long getFrontendRouterCount() {
return frontendRouterCount;
}
public void setFrontendRouterCount(Long frontendRouterCount) {
this.frontendRouterCount = frontendRouterCount;
}
/**
* A count of the hard drives contained within a piece of hardware.
*/
@ApiProperty
protected Long hardDriveCount;
public Long getHardDriveCount() {
return hardDriveCount;
}
public void setHardDriveCount(Long hardDriveCount) {
this.hardDriveCount = hardDriveCount;
}
/**
* A count of information regarding a piece of hardware's memory.
*/
@ApiProperty
protected Long memoryCount;
public Long getMemoryCount() {
return memoryCount;
}
public void setMemoryCount(Long memoryCount) {
this.memoryCount = memoryCount;
}
/**
* A count of
*/
@ApiProperty
protected Long moduleCount;
public Long getModuleCount() {
return moduleCount;
}
public void setModuleCount(Long moduleCount) {
this.moduleCount = moduleCount;
}
/**
* A count of information regarding a piece of hardware's network cards.
*/
@ApiProperty
protected Long networkCardCount;
public Long getNetworkCardCount() {
return networkCardCount;
}
public void setNetworkCardCount(Long networkCardCount) {
this.networkCardCount = networkCardCount;
}
/**
* A count of returns a hardware's network components.
*/
@ApiProperty
protected Long networkComponentCount;
public Long getNetworkComponentCount() {
return networkComponentCount;
}
public void setNetworkComponentCount(Long networkComponentCount) {
this.networkComponentCount = networkComponentCount;
}
/**
* A count of all servers with failed monitoring that are attached downstream to a piece of hardware.
*/
@ApiProperty
protected Long networkMonitorAttachedDownHardwareCount;
public Long getNetworkMonitorAttachedDownHardwareCount() {
return networkMonitorAttachedDownHardwareCount;
}
public void setNetworkMonitorAttachedDownHardwareCount(Long networkMonitorAttachedDownHardwareCount) {
this.networkMonitorAttachedDownHardwareCount = networkMonitorAttachedDownHardwareCount;
}
/**
* A count of virtual guests that are attached downstream to a hardware that have failed monitoring
*/
@ApiProperty
protected Long networkMonitorAttachedDownVirtualGuestCount;
public Long getNetworkMonitorAttachedDownVirtualGuestCount() {
return networkMonitorAttachedDownVirtualGuestCount;
}
public void setNetworkMonitorAttachedDownVirtualGuestCount(Long networkMonitorAttachedDownVirtualGuestCount) {
this.networkMonitorAttachedDownVirtualGuestCount = networkMonitorAttachedDownVirtualGuestCount;
}
/**
* A count of information regarding a piece of hardware's network monitors.
*/
@ApiProperty
protected Long networkMonitorCount;
public Long getNetworkMonitorCount() {
return networkMonitorCount;
}
public void setNetworkMonitorCount(Long networkMonitorCount) {
this.networkMonitorCount = networkMonitorCount;
}
/**
* A count of the status of all of a piece of hardware's network monitoring incidents.
*/
@ApiProperty
protected Long networkMonitorIncidentCount;
public Long getNetworkMonitorIncidentCount() {
return networkMonitorIncidentCount;
}
public void setNetworkMonitorIncidentCount(Long networkMonitorIncidentCount) {
this.networkMonitorIncidentCount = networkMonitorIncidentCount;
}
/**
* A count of information regarding a piece of hardware's associated network storage service account.
*/
@ApiProperty
protected Long networkStorageCount;
public Long getNetworkStorageCount() {
return networkStorageCount;
}
public void setNetworkStorageCount(Long networkStorageCount) {
this.networkStorageCount = networkStorageCount;
}
/**
* A count of the network virtual LANs (VLANs) associated with a piece of hardware's network components.
*/
@ApiProperty
protected Long networkVlanCount;
public Long getNetworkVlanCount() {
return networkVlanCount;
}
public void setNetworkVlanCount(Long networkVlanCount) {
this.networkVlanCount = networkVlanCount;
}
/**
* A count of
*/
@ApiProperty
protected Long notesHistoryCount;
public Long getNotesHistoryCount() {
return notesHistoryCount;
}
public void setNotesHistoryCount(Long notesHistoryCount) {
this.notesHistoryCount = notesHistoryCount;
}
/**
* A count of
*/
@ApiProperty
protected Long nvRamComponentModelCount;
public Long getNvRamComponentModelCount() {
return nvRamComponentModelCount;
}
public void setNvRamComponentModelCount(Long nvRamComponentModelCount) {
this.nvRamComponentModelCount = nvRamComponentModelCount;
}
/**
* A count of the power components for a hardware object.
*/
@ApiProperty
protected Long powerComponentCount;
public Long getPowerComponentCount() {
return powerComponentCount;
}
public void setPowerComponentCount(Long powerComponentCount) {
this.powerComponentCount = powerComponentCount;
}
/**
* A count of information regarding a piece of hardware's power supply.
*/
@ApiProperty
protected Long powerSupplyCount;
public Long getPowerSupplyCount() {
return powerSupplyCount;
}
public void setPowerSupplyCount(Long powerSupplyCount) {
this.powerSupplyCount = powerSupplyCount;
}
/**
* A count of information regarding a piece of hardware's processors.
*/
@ApiProperty
protected Long processorCount;
public Long getProcessorCount() {
return processorCount;
}
public void setProcessorCount(Long processorCount) {
this.processorCount = processorCount;
}
/**
* A count of the RAID controllers contained within a piece of hardware.
*/
@ApiProperty
protected Long raidControllerCount;
public Long getRaidControllerCount() {
return raidControllerCount;
}
public void setRaidControllerCount(Long raidControllerCount) {
this.raidControllerCount = raidControllerCount;
}
/**
* A count of recent events that impact this hardware.
*/
@ApiProperty
protected Long recentEventCount;
public Long getRecentEventCount() {
return recentEventCount;
}
public void setRecentEventCount(Long recentEventCount) {
this.recentEventCount = recentEventCount;
}
/**
* A count of user credentials to issue commands and/or interact with the server's remote management card.
*/
@ApiProperty
protected Long remoteManagementAccountCount;
public Long getRemoteManagementAccountCount() {
return remoteManagementAccountCount;
}
public void setRemoteManagementAccountCount(Long remoteManagementAccountCount) {
this.remoteManagementAccountCount = remoteManagementAccountCount;
}
/**
* A count of
*/
@ApiProperty
protected Long resourceConfigurationCount;
public Long getResourceConfigurationCount() {
return resourceConfigurationCount;
}
public void setResourceConfigurationCount(Long resourceConfigurationCount) {
this.resourceConfigurationCount = resourceConfigurationCount;
}
/**
* A count of the resource groups in which this hardware is a member.
*/
@ApiProperty
protected Long resourceGroupCount;
public Long getResourceGroupCount() {
return resourceGroupCount;
}
public void setResourceGroupCount(Long resourceGroupCount) {
this.resourceGroupCount = resourceGroupCount;
}
/**
* A count of
*/
@ApiProperty
protected Long resourceGroupMemberReferenceCount;
public Long getResourceGroupMemberReferenceCount() {
return resourceGroupMemberReferenceCount;
}
public void setResourceGroupMemberReferenceCount(Long resourceGroupMemberReferenceCount) {
this.resourceGroupMemberReferenceCount = resourceGroupMemberReferenceCount;
}
/**
* A count of
*/
@ApiProperty
protected Long resourceGroupRoleCount;
public Long getResourceGroupRoleCount() {
return resourceGroupRoleCount;
}
public void setResourceGroupRoleCount(Long resourceGroupRoleCount) {
this.resourceGroupRoleCount = resourceGroupRoleCount;
}
/**
* A count of a hardware's routers.
*/
@ApiProperty
protected Long routerCount;
public Long getRouterCount() {
return routerCount;
}
public void setRouterCount(Long routerCount) {
this.routerCount = routerCount;
}
/**
* A count of collection of scale assets this hardware corresponds to.
*/
@ApiProperty
protected Long scaleAssetCount;
public Long getScaleAssetCount() {
return scaleAssetCount;
}
public void setScaleAssetCount(Long scaleAssetCount) {
this.scaleAssetCount = scaleAssetCount;
}
/**
* A count of information regarding a piece of hardware's vulnerability scan requests.
*/
@ApiProperty
protected Long securityScanRequestCount;
public Long getSecurityScanRequestCount() {
return securityScanRequestCount;
}
public void setSecurityScanRequestCount(Long securityScanRequestCount) {
this.securityScanRequestCount = securityScanRequestCount;
}
/**
* A count of information regarding a piece of hardware's installed software.
*/
@ApiProperty
protected Long softwareComponentCount;
public Long getSoftwareComponentCount() {
return softwareComponentCount;
}
public void setSoftwareComponentCount(Long softwareComponentCount) {
this.softwareComponentCount = softwareComponentCount;
}
/**
* A count of sSH keys to be installed on the server during provisioning or an OS reload.
*/
@ApiProperty
protected Long sshKeyCount;
public Long getSshKeyCount() {
return sshKeyCount;
}
public void setSshKeyCount(Long sshKeyCount) {
this.sshKeyCount = sshKeyCount;
}
/**
* A count of
*/
@ApiProperty
protected Long storageGroupCount;
public Long getStorageGroupCount() {
return storageGroupCount;
}
public void setStorageGroupCount(Long storageGroupCount) {
this.storageGroupCount = storageGroupCount;
}
/**
* A count of a piece of hardware's private storage network components. [Deprecated]
*/
@ApiProperty
protected Long storageNetworkComponentCount;
public Long getStorageNetworkComponentCount() {
return storageNetworkComponentCount;
}
public void setStorageNetworkComponentCount(Long storageNetworkComponentCount) {
this.storageNetworkComponentCount = storageNetworkComponentCount;
}
/**
* A count of
*/
@ApiProperty
protected Long tagReferenceCount;
public Long getTagReferenceCount() {
return tagReferenceCount;
}
public void setTagReferenceCount(Long tagReferenceCount) {
this.tagReferenceCount = tagReferenceCount;
}
/**
* A count of information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.
*/
@ApiProperty
protected Long uplinkNetworkComponentCount;
public Long getUplinkNetworkComponentCount() {
return uplinkNetworkComponentCount;
}
public void setUplinkNetworkComponentCount(Long uplinkNetworkComponentCount) {
this.uplinkNetworkComponentCount = uplinkNetworkComponentCount;
}
/**
* A count of an array containing a single string of custom user data for a hardware order. Max size is 16 kb.
*/
@ApiProperty
protected Long userDataCount;
public Long getUserDataCount() {
return userDataCount;
}
public void setUserDataCount(Long userDataCount) {
this.userDataCount = userDataCount;
}
/**
* A count of information regarding the virtual chassis siblings for a piece of hardware.
*/
@ApiProperty
protected Long virtualChassisSiblingCount;
public Long getVirtualChassisSiblingCount() {
return virtualChassisSiblingCount;
}
public void setVirtualChassisSiblingCount(Long virtualChassisSiblingCount) {
this.virtualChassisSiblingCount = virtualChassisSiblingCount;
}
/**
* A count of information regarding a piece of hardware's virtual software licenses.
*/
@ApiProperty
protected Long virtualLicenseCount;
public Long getVirtualLicenseCount() {
return virtualLicenseCount;
}
public void setVirtualLicenseCount(Long virtualLicenseCount) {
this.virtualLicenseCount = virtualLicenseCount;
}
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 hardware is defined in the SoftLayer_Hardware service. SoftLayer hardware has network components, software, monitoring services such as network monitoring, and hardware components such as hard drives. The SoftLayer_Hardware service is a convenient way to obtain general information about your SoftLayer hardware. Use the data returned by these methods with other API services to get more detailed information about your services and to make changes to your servers and services.
*
* @see SoftLayer_Hardware
*/
@com.softlayer.api.annotation.ApiService("SoftLayer_Hardware")
public static interface Service extends com.softlayer.api.Service {
public ServiceAsync asAsync();
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.
*
* @see SoftLayer_Hardware::allowAccessToNetworkStorage
*/
@ApiMethod(instanceRequired = true)
public Boolean allowAccessToNetworkStorage(Storage networkStorageTemplateObject);
/**
* This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.
*
* @see SoftLayer_Hardware::allowAccessToNetworkStorageList
*/
@ApiMethod(instanceRequired = true)
public Boolean allowAccessToNetworkStorageList(List networkStorageTemplateObjects);
/**
* Captures an Image of the hard disk on the physical machine, based on the capture template parameter. Returns the image template group containing the disk image.
*
* @see SoftLayer_Hardware::captureImage
*/
@ApiMethod(instanceRequired = true)
public Group captureImage(Template captureTemplate);
/**
*
*
* 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::createObject
*/
@ApiMethod
public Hardware createObject(Hardware templateObject);
/**
*
* This method will cancel a server effective immediately. For servers billed hourly, the charges will stop immediately after the method returns.
*
* @see SoftLayer_Hardware::deleteObject
*/
@ApiMethod(instanceRequired = true)
public Boolean deleteObject();
/**
* Delete software component passwords.
*
* @see SoftLayer_Hardware::deleteSoftwareComponentPasswords
*/
@ApiMethod(instanceRequired = true)
public Boolean deleteSoftwareComponentPasswords(List softwareComponentPasswords);
/**
* Delete an existing tag. If there are any references on the tag, an exception will be thrown.
*
* @see SoftLayer_Hardware::deleteTag
*/
@ApiMethod(instanceRequired = true)
public Boolean deleteTag(String tagName);
/**
* Edit the properties of a software component password such as the username, password, and notes.
*
* @see SoftLayer_Hardware::editSoftwareComponentPasswords
*/
@ApiMethod(instanceRequired = true)
public Boolean editSoftwareComponentPasswords(List softwareComponentPasswords);
/**
* Download and run remote script from uri on the hardware.
*
* @see SoftLayer_Hardware::executeRemoteScript
*/
@ApiMethod(instanceRequired = true)
public Void executeRemoteScript(String uri);
/**
* The '''findByIpAddress''' method finds hardware using its primary public or private IP address. IP addresses that have a secondary subnet tied to the hardware will not return the hardware. If no hardware is found, no errors are generated and no data is returned.
*
* @see SoftLayer_Hardware::findByIpAddress
*/
@ApiMethod
public Hardware findByIpAddress(String ipAddress);
/**
*
* Obtain an [[SoftLayer_Container_Product_Order_Hardware_Server (type)|order container]] that can be sent to [[SoftLayer_Product_Order/verifyOrder|verifyOrder]] or [[SoftLayer_Product_Order/placeOrder|placeOrder]].
*
*
* This is primarily useful when there is a necessity to confirm the price which will be charged for an order.
*
*
* See [[SoftLayer_Hardware/createObject|createObject]] for specifics on the requirements of the template object parameter.
*
* @see SoftLayer_Hardware::generateOrderTemplate
*/
@ApiMethod
public Order generateOrderTemplate(Hardware templateObject);
/**
* This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Hardware.
*
* @see SoftLayer_Hardware::getAttachedNetworkStorages
*/
@ApiMethod(instanceRequired = true)
public List getAttachedNetworkStorages(String nasType);
/**
* This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Hardware.
*
* @see SoftLayer_Hardware::getAvailableNetworkStorages
*/
@ApiMethod(instanceRequired = true)
public List getAvailableNetworkStorages(String nasType);
/**
* The '''getBackendIncomingBandwidth''' method retrieves the amount of incoming private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.
*
* @see SoftLayer_Hardware::getBackendIncomingBandwidth
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getBackendIncomingBandwidth(GregorianCalendar startDate, GregorianCalendar endDate);
/**
* The '''getBackendOutgoingBandwidth''' method retrieves the amount of outgoing private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.
*
* @see SoftLayer_Hardware::getBackendOutgoingBandwidth
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getBackendOutgoingBandwidth(GregorianCalendar startDate, GregorianCalendar endDate);
/**
* @see SoftLayer_Hardware::getComponentDetailsXML
*/
@ApiMethod(instanceRequired = true)
public String getComponentDetailsXML();
/**
*
* There are many options that may be provided while ordering a server, this method can be used to determine what these options are.
*
*
* Detailed information on the return value can be found on the data type page for [[SoftLayer_Container_Hardware_Configuration (type)]].
*
* @see SoftLayer_Hardware::getCreateObjectOptions
*/
@ApiMethod
public Configuration getCreateObjectOptions();
/**
* Get the billing detail for this hardware for the current billing period. This does not include bandwidth usage.
*
* @see SoftLayer_Hardware::getCurrentBillingDetail
*/
@ApiMethod(instanceRequired = true)
public List- getCurrentBillingDetail();
/**
* Get the total bill amount in US Dollars ($) for this hardware in the current billing period. This includes all bandwidth used up to the point the method is called on the hardware.
*
* @see SoftLayer_Hardware::getCurrentBillingTotal
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getCurrentBillingTotal();
/**
* The '''getDailyAverage''' method calculates the average daily network traffic used by the selected server. Using the required parameter ''dateTime'' to enter a start and end date, the user retrieves this average, measure in gigabytes (GB) for the specified date range. When entering parameters, only the month, day and year are required - time entries are omitted as this method defaults the time to midnight in order to account for the entire day.
*
* @see SoftLayer_Hardware::getDailyAverage
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getDailyAverage(GregorianCalendar startDate, GregorianCalendar endDate);
/**
* The '''getFrontendIncomingBandwidth''' method retrieves the amount of incoming public network traffic used by a server between the given start and end date parameters. When entering the ''dateTime'' parameter, only the month, day and year of the start and end dates are required - the time (hour, minute and second) are set to midnight by default and cannot be changed. The amount of bandwidth retrieved is measured in gigabytes (GB).
*
* @see SoftLayer_Hardware::getFrontendIncomingBandwidth
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getFrontendIncomingBandwidth(GregorianCalendar startDate, GregorianCalendar endDate);
/**
* The '''getFrontendOutgoingBandwidth''' method retrieves the amount of outgoing public network traffic used by a server between the given start and end date parameters. The ''dateTime'' parameter requires only the day, month and year to be entered - the time (hour, minute and second) are set to midnight be default in order to gather the data for the entire start and end date indicated in the parameter. The amount of bandwidth retrieved is measured in gigabytes (GB).
*
* @see SoftLayer_Hardware::getFrontendOutgoingBandwidth
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getFrontendOutgoingBandwidth(GregorianCalendar startDate, GregorianCalendar endDate);
/**
* The '''getHourlyBandwidth''' method retrieves all bandwidth updates hourly for the specified hardware. Because the potential number of data points can become excessive, the method limits the user to obtain data in 24-hour intervals. The required ''dateTime'' parameter is used as the starting point for the query and will be calculated for the 24-hour period starting with the specified date and time. For example, entering a parameter of
*
* '02/01/2008 0:00'
*
* results in a return of all bandwidth data for the entire day of February 1, 2008, as 0:00 specifies a midnight start date. Please note that the time entered should be completed using a 24-hour clock (military time, astronomical time).
*
* For data spanning more than a single 24-hour period, refer to the getBandwidthData function on the metricTrackingObject for the piece of hardware.
*
* @see SoftLayer_Hardware::getHourlyBandwidth
*/
@ApiMethod(instanceRequired = true)
public List getHourlyBandwidth(String mode, GregorianCalendar day);
/**
* getObject retrieves the SoftLayer_Hardware object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware service. You can only retrieve the account that your portal user is assigned to.
*
* @see SoftLayer_Hardware::getObject
*/
@ApiMethod(instanceRequired = true)
public Hardware getObject();
/**
* Retrieve a graph of a server's private network bandwidth usage over the specified timeframe. If no timeframe is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPrivateBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels.
*
* @see SoftLayer_Hardware::getPrivateBandwidthData
*/
@ApiMethod(instanceRequired = true)
public List getPrivateBandwidthData(Long startTime, Long endTime);
/**
* Retrieve a graph of a server's public network bandwidth usage over the specified timeframe. If no timeframe is specified then getPublicBandwidthGraphImage retrieves the last 24 hours of public bandwidth usage. getPublicBandwidthGraphImage returns a PNG image measuring 827 pixels by 293 pixels.
*
* @see SoftLayer_Hardware::getPublicBandwidthData
*/
@ApiMethod(instanceRequired = true)
public List getPublicBandwidthData(Long startTime, Long endTime);
/**
* The '''getSensorData''' method retrieves a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures various information, including system temperatures, voltages and other local server settings. Sensor data is cached for 30 second; calls made to this method for the same server within 30 seconds of each other will result in the same data being returned. To ensure that the data retrieved retrieves snapshot of varied data, make calls greater than 30 seconds apart.
*
* @see SoftLayer_Hardware::getSensorData
*/
@ApiMethod(instanceRequired = true)
public List getSensorData();
/**
* The '''getSensorDataWithGraphs''' method retrieves the raw data returned from the server's remote management card. Along with raw data, graphs for the CPU and system temperatures and fan speeds are also returned. For more details on what information is returned, refer to the ''getSensorData'' method.
*
* @see SoftLayer_Hardware::getSensorDataWithGraphs
*/
@ApiMethod(instanceRequired = true)
public SensorReadingsWithGraphs getSensorDataWithGraphs();
/**
* The '''getServerFanSpeedGraphs''' method retrieves the server's fan speeds and displays the speeds using tachometer graphs. data used to construct these graphs is retrieved from the server's remote management card. Each graph returned will have an associated title.
*
* @see SoftLayer_Hardware::getServerFanSpeedGraphs
*/
@ApiMethod(instanceRequired = true)
public List getServerFanSpeedGraphs();
/**
* The '''getPowerState''' method retrieves the power state for the selected server. The server's power status is retrieved from its remote management card. This method returns "on", for a server that has been powered on, or "off" for servers powered off.
*
* @see SoftLayer_Hardware::getServerPowerState
*/
@ApiMethod(instanceRequired = true)
public String getServerPowerState();
/**
* The '''getServerTemperatureGraphs''' retrieves the server's temperatures and displays the various temperatures using thermometer graphs. Temperatures retrieved are CPU temperature(s) and system temperatures. Data used to construct the graphs is retrieved from the server's remote management card. All graphs returned will have an associated title.
*
* @see SoftLayer_Hardware::getServerTemperatureGraphs
*/
@ApiMethod(instanceRequired = true)
public List getServerTemperatureGraphs();
/**
*
* This method will query transaction history for a piece of hardware.
*
* @see SoftLayer_Hardware::getTransactionHistory
*/
@ApiMethod(instanceRequired = true)
public List getTransactionHistory();
/**
* Retrieve a list of upgradeable items available to this piece of hardware. Currently, getUpgradeItemPrices retrieves upgrades available for a server's memory, hard drives, network port speed, bandwidth allocation and GPUs.
*
* @see SoftLayer_Hardware::getUpgradeItemPrices
*/
@ApiMethod(instanceRequired = true)
public List getUpgradeItemPrices();
/**
* The '''importVirtualHost''' method attempts to import the host record for the virtualization platform running on a server.
*
* @see SoftLayer_Hardware::importVirtualHost
*/
@ApiMethod(instanceRequired = true)
public Host importVirtualHost();
/**
* The '''isPingable''' method issues a ping command to the selected server and returns the result of the ping command. This boolean return value displays ''true'' upon successful ping or ''false'' for a failed ping.
*
* @see SoftLayer_Hardware::isPingable
*/
@ApiMethod(instanceRequired = true)
public Boolean isPingable();
/**
* Issues a ping command to the server and returns the ping response.
*
* @see SoftLayer_Hardware::ping
*/
@ApiMethod(instanceRequired = true)
public String ping();
/**
* The '''powerCycle''' method completes a power off and power on of the server successively in one command. The power cycle command is equivalent to unplugging the server from the power strip and then plugging the server back in. '''This method should only be used when all other options have been exhausted'''. Additional remote management commands may not be executed if this command was successfully issued within the last 20 minutes to avoid server failure. Remote management commands include:
*
* rebootSoft rebootHard powerOn powerOff powerCycle
*
*
*
* @see SoftLayer_Hardware::powerCycle
*/
@ApiMethod(instanceRequired = true)
public Boolean powerCycle();
/**
* This method will power off the server via the server's remote management card.
*
* @see SoftLayer_Hardware::powerOff
*/
@ApiMethod(instanceRequired = true)
public Boolean powerOff();
/**
* The '''powerOn''' method powers on a server via its remote management card. This boolean return value returns ''true'' upon successful execution and ''false'' if unsuccessful. Other remote management commands may not be issued in this command was successfully completed within the last 20 minutes to avoid server failure. Remote management commands include:
*
* rebootSoft rebootHard powerOn powerOff powerCycle
*
*
*
* @see SoftLayer_Hardware::powerOn
*/
@ApiMethod(instanceRequired = true)
public Boolean powerOn();
/**
* The '''rebootDefault''' method attempts to reboot the server by issuing a soft reboot, or reset, command to the server's remote management card. if the reset attempt is unsuccessful, a power cycle command will be issued via the power strip. The power cycle command is equivalent to unplugging the server from the power strip and then plugging the server back in. If the reset was successful within the last 20 minutes, another remote management command cannot be completed to avoid server failure. Remote management commands include:
*
* rebootSoft rebootHard powerOn powerOff powerCycle
*
*
*
* @see SoftLayer_Hardware::rebootDefault
*/
@ApiMethod(instanceRequired = true)
public Boolean rebootDefault();
/**
* The '''rebootHard''' method reboots the server by issuing a cycle command to the server's remote management card. A hard reboot is equivalent to pressing the ''Reset'' button on a server - it is issued immediately and will not allow processes to shut down prior to the reboot. Completing a hard reboot may initiate system disk checks upon server reboot, causing the boot up to take longer than normally expected.
*
* Remote management commands are unable to be executed if a reboot has been issued successfully within the last 20 minutes to avoid server failure. Remote management commands include:
*
* rebootSoft rebootHard powerOn powerOff powerCycle
*
*
*
* @see SoftLayer_Hardware::rebootHard
*/
@ApiMethod(instanceRequired = true)
public Boolean rebootHard();
/**
* The '''rebootSoft''' method reboots the server by issuing a reset command to the server's remote management card via soft reboot. When executing a soft reboot, servers allow all processes to shut down completely before rebooting. Remote management commands are unable to be issued within 20 minutes of issuing a successful soft reboot in order to avoid server failure. Remote management commands include:
*
* rebootSoft rebootHard powerOn powerOff powerCycle
*
*
*
* @see SoftLayer_Hardware::rebootSoft
*/
@ApiMethod(instanceRequired = true)
public Boolean rebootSoft();
/**
* This method is used to remove access to s SoftLayer_Network_Storage volumes that supports host- or network-level access control.
*
* @see SoftLayer_Hardware::removeAccessToNetworkStorage
*/
@ApiMethod(instanceRequired = true)
public Boolean removeAccessToNetworkStorage(Storage networkStorageTemplateObject);
/**
* This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.
*
* @see SoftLayer_Hardware::removeAccessToNetworkStorageList
*/
@ApiMethod(instanceRequired = true)
public Boolean removeAccessToNetworkStorageList(List networkStorageTemplateObjects);
/**
* @see SoftLayer_Hardware::removeTags
*/
@ApiMethod(instanceRequired = true)
public Boolean removeTags(String tags);
/**
* @see SoftLayer_Hardware::setTags
*/
@ApiMethod(instanceRequired = true)
public Boolean setTags(String tags);
/**
* This method will update the root IPMI password on this SoftLayer_Hardware.
*
* @see SoftLayer_Hardware::updateIpmiPassword
*/
@ApiMethod(instanceRequired = true)
public Boolean updateIpmiPassword(String password);
/**
* The account associated with a piece of hardware.
*
* @see SoftLayer_Hardware::getAccount
*/
@ApiMethod(instanceRequired = true)
public Account getAccount();
/**
* A piece of hardware's active physical components.
*
* @see SoftLayer_Hardware::getActiveComponents
*/
@ApiMethod(instanceRequired = true)
public List getActiveComponents();
/**
* A piece of hardware's active network monitoring incidents.
*
* @see SoftLayer_Hardware::getActiveNetworkMonitorIncident
*/
@ApiMethod(instanceRequired = true)
public List getActiveNetworkMonitorIncident();
/**
* @see SoftLayer_Hardware::getAllPowerComponents
*/
@ApiMethod(instanceRequired = true)
public List getAllPowerComponents();
/**
* The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.
*
* @see SoftLayer_Hardware::getAllowedHost
*/
@ApiMethod(instanceRequired = true)
public com.softlayer.api.service.network.storage.allowed.Host getAllowedHost();
/**
* The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
*
* @see SoftLayer_Hardware::getAllowedNetworkStorage
*/
@ApiMethod(instanceRequired = true)
public List getAllowedNetworkStorage();
/**
* The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
*
* @see SoftLayer_Hardware::getAllowedNetworkStorageReplicas
*/
@ApiMethod(instanceRequired = true)
public List getAllowedNetworkStorageReplicas();
/**
* Information regarding an antivirus/spyware software component object.
*
* @see SoftLayer_Hardware::getAntivirusSpywareSoftwareComponent
*/
@ApiMethod(instanceRequired = true)
public Component getAntivirusSpywareSoftwareComponent();
/**
* Information regarding a piece of hardware's specific attributes.
*
* @see SoftLayer_Hardware::getAttributes
*/
@ApiMethod(instanceRequired = true)
public List getAttributes();
/**
* The average daily public bandwidth usage for the current billing cycle.
*
* @see SoftLayer_Hardware::getAverageDailyPublicBandwidthUsage
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getAverageDailyPublicBandwidthUsage();
/**
* A piece of hardware's back-end or private network components.
*
* @see SoftLayer_Hardware::getBackendNetworkComponents
*/
@ApiMethod(instanceRequired = true)
public List getBackendNetworkComponents();
/**
* A hardware's backend or private router.
*
* @see SoftLayer_Hardware::getBackendRouters
*/
@ApiMethod(instanceRequired = true)
public List getBackendRouters();
/**
* A hardware's allotted bandwidth (measured in GB).
*
* @see SoftLayer_Hardware::getBandwidthAllocation
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getBandwidthAllocation();
/**
* A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.
*
* @see SoftLayer_Hardware::getBandwidthAllotmentDetail
*/
@ApiMethod(instanceRequired = true)
public Detail getBandwidthAllotmentDetail();
/**
* Information regarding a piece of hardware's benchmark certifications.
*
* @see SoftLayer_Hardware::getBenchmarkCertifications
*/
@ApiMethod(instanceRequired = true)
public List getBenchmarkCertifications();
/**
* Information regarding the billing item for a server.
*
* @see SoftLayer_Hardware::getBillingItem
*/
@ApiMethod(instanceRequired = true)
public com.softlayer.api.service.billing.item.Hardware getBillingItem();
/**
* A flag indicating that a billing item exists.
*
* @see SoftLayer_Hardware::getBillingItemFlag
*/
@ApiMethod(instanceRequired = true)
public Boolean getBillingItemFlag();
/**
* Determines whether the hardware is ineligible for cancellation because it is disconnected.
*
* @see SoftLayer_Hardware::getBlockCancelBecauseDisconnectedFlag
*/
@ApiMethod(instanceRequired = true)
public Boolean getBlockCancelBecauseDisconnectedFlag();
/**
* Status indicating whether or not a piece of hardware has business continuance insurance.
*
* @see SoftLayer_Hardware::getBusinessContinuanceInsuranceFlag
*/
@ApiMethod(instanceRequired = true)
public Boolean getBusinessContinuanceInsuranceFlag();
/**
* Child hardware.
*
* @see SoftLayer_Hardware::getChildrenHardware
*/
@ApiMethod(instanceRequired = true)
public List getChildrenHardware();
/**
* A piece of hardware's components.
*
* @see SoftLayer_Hardware::getComponents
*/
@ApiMethod(instanceRequired = true)
public List getComponents();
/**
* A continuous data protection/server backup software component object.
*
* @see SoftLayer_Hardware::getContinuousDataProtectionSoftwareComponent
*/
@ApiMethod(instanceRequired = true)
public Component getContinuousDataProtectionSoftwareComponent();
/**
* The current billable public outbound bandwidth for this hardware for the current billing cycle.
*
* @see SoftLayer_Hardware::getCurrentBillableBandwidthUsage
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getCurrentBillableBandwidthUsage();
/**
* Information regarding the datacenter in which a piece of hardware resides.
*
* @see SoftLayer_Hardware::getDatacenter
*/
@ApiMethod(instanceRequired = true)
public Location getDatacenter();
/**
* The name of the datacenter in which a piece of hardware resides.
*
* @see SoftLayer_Hardware::getDatacenterName
*/
@ApiMethod(instanceRequired = true)
public String getDatacenterName();
/**
* Number of day(s) a server have been in spare pool.
*
* @see SoftLayer_Hardware::getDaysInSparePool
*/
@ApiMethod(instanceRequired = true)
public Long getDaysInSparePool();
/**
* All hardware that has uplink network connections to a piece of hardware.
*
* @see SoftLayer_Hardware::getDownlinkHardware
*/
@ApiMethod(instanceRequired = true)
public List getDownlinkHardware();
/**
* All hardware that has uplink network connections to a piece of hardware.
*
* @see SoftLayer_Hardware::getDownlinkNetworkHardware
*/
@ApiMethod(instanceRequired = true)
public List getDownlinkNetworkHardware();
/**
* Information regarding all servers attached to a piece of network hardware.
*
* @see SoftLayer_Hardware::getDownlinkServers
*/
@ApiMethod(instanceRequired = true)
public List getDownlinkServers();
/**
* Information regarding all virtual guests attached to a piece of network hardware.
*
* @see SoftLayer_Hardware::getDownlinkVirtualGuests
*/
@ApiMethod(instanceRequired = true)
public List getDownlinkVirtualGuests();
/**
* All hardware downstream from a network device.
*
* @see SoftLayer_Hardware::getDownstreamHardwareBindings
*/
@ApiMethod(instanceRequired = true)
public List getDownstreamHardwareBindings();
/**
* All network hardware downstream from the selected piece of hardware.
*
* @see SoftLayer_Hardware::getDownstreamNetworkHardware
*/
@ApiMethod(instanceRequired = true)
public List getDownstreamNetworkHardware();
/**
* All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware.
*
* @see SoftLayer_Hardware::getDownstreamNetworkHardwareWithIncidents
*/
@ApiMethod(instanceRequired = true)
public List getDownstreamNetworkHardwareWithIncidents();
/**
* Information regarding all servers attached downstream to a piece of network hardware.
*
* @see SoftLayer_Hardware::getDownstreamServers
*/
@ApiMethod(instanceRequired = true)
public List getDownstreamServers();
/**
* Information regarding all virtual guests attached to a piece of network hardware.
*
* @see SoftLayer_Hardware::getDownstreamVirtualGuests
*/
@ApiMethod(instanceRequired = true)
public List getDownstreamVirtualGuests();
/**
* The drive controllers contained within a piece of hardware.
*
* @see SoftLayer_Hardware::getDriveControllers
*/
@ApiMethod(instanceRequired = true)
public List getDriveControllers();
/**
* Information regarding a piece of hardware's associated EVault network storage service account.
*
* @see SoftLayer_Hardware::getEvaultNetworkStorage
*/
@ApiMethod(instanceRequired = true)
public List getEvaultNetworkStorage();
/**
* Information regarding a piece of hardware's firewall services.
*
* @see SoftLayer_Hardware::getFirewallServiceComponent
*/
@ApiMethod(instanceRequired = true)
public Firewall getFirewallServiceComponent();
/**
* Defines the fixed components in a fixed configuration bare metal server.
*
* @see SoftLayer_Hardware::getFixedConfigurationPreset
*/
@ApiMethod(instanceRequired = true)
public Preset getFixedConfigurationPreset();
/**
* A piece of hardware's front-end or public network components.
*
* @see SoftLayer_Hardware::getFrontendNetworkComponents
*/
@ApiMethod(instanceRequired = true)
public List getFrontendNetworkComponents();
/**
* A hardware's frontend or public router.
*
* @see SoftLayer_Hardware::getFrontendRouters
*/
@ApiMethod(instanceRequired = true)
public List getFrontendRouters();
/**
* A hardware's universally unique identifier.
*
* @see SoftLayer_Hardware::getGlobalIdentifier
*/
@ApiMethod(instanceRequired = true)
public String getGlobalIdentifier();
/**
* The hard drives contained within a piece of hardware.
*
* @see SoftLayer_Hardware::getHardDrives
*/
@ApiMethod(instanceRequired = true)
public List getHardDrives();
/**
* The chassis that a piece of hardware is housed in.
*
* @see SoftLayer_Hardware::getHardwareChassis
*/
@ApiMethod(instanceRequired = true)
public Chassis getHardwareChassis();
/**
* A hardware's function.
*
* @see SoftLayer_Hardware::getHardwareFunction
*/
@ApiMethod(instanceRequired = true)
public Function getHardwareFunction();
/**
* A hardware's function.
*
* @see SoftLayer_Hardware::getHardwareFunctionDescription
*/
@ApiMethod(instanceRequired = true)
public String getHardwareFunctionDescription();
/**
* A hardware's status.
*
* @see SoftLayer_Hardware::getHardwareStatus
*/
@ApiMethod(instanceRequired = true)
public Status getHardwareStatus();
/**
* Determine in hardware object has TPM enabled.
*
* @see SoftLayer_Hardware::getHasTrustedPlatformModuleBillingItemFlag
*/
@ApiMethod(instanceRequired = true)
public Boolean getHasTrustedPlatformModuleBillingItemFlag();
/**
* Information regarding a host IPS software component object.
*
* @see SoftLayer_Hardware::getHostIpsSoftwareComponent
*/
@ApiMethod(instanceRequired = true)
public Component getHostIpsSoftwareComponent();
/**
* A server's hourly billing status.
*
* @see SoftLayer_Hardware::getHourlyBillingFlag
*/
@ApiMethod(instanceRequired = true)
public Boolean getHourlyBillingFlag();
/**
* The sum of all the inbound network traffic data for the last 30 days.
*
* @see SoftLayer_Hardware::getInboundBandwidthUsage
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getInboundBandwidthUsage();
/**
* The total public inbound bandwidth for this hardware for the current billing cycle.
*
* @see SoftLayer_Hardware::getInboundPublicBandwidthUsage
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getInboundPublicBandwidthUsage();
/**
* Information regarding the last transaction a server performed.
*
* @see SoftLayer_Hardware::getLastTransaction
*/
@ApiMethod(instanceRequired = true)
public Transaction getLastTransaction();
/**
* A piece of hardware's latest network monitoring incident.
*
* @see SoftLayer_Hardware::getLatestNetworkMonitorIncident
*/
@ApiMethod(instanceRequired = true)
public Incident getLatestNetworkMonitorIncident();
/**
* Where a piece of hardware is located within SoftLayer's location hierarchy.
*
* @see SoftLayer_Hardware::getLocation
*/
@ApiMethod(instanceRequired = true)
public Location getLocation();
/**
* @see SoftLayer_Hardware::getLocationPathString
*/
@ApiMethod(instanceRequired = true)
public String getLocationPathString();
/**
* Information regarding a lockbox account associated with a server.
*
* @see SoftLayer_Hardware::getLockboxNetworkStorage
*/
@ApiMethod(instanceRequired = true)
public Storage getLockboxNetworkStorage();
/**
* A flag indicating that the hardware is a managed resource.
*
* @see SoftLayer_Hardware::getManagedResourceFlag
*/
@ApiMethod(instanceRequired = true)
public Boolean getManagedResourceFlag();
/**
* Information regarding a piece of hardware's memory.
*
* @see SoftLayer_Hardware::getMemory
*/
@ApiMethod(instanceRequired = true)
public List getMemory();
/**
* The amount of memory a piece of hardware has, measured in gigabytes.
*
* @see SoftLayer_Hardware::getMemoryCapacity
*/
@ApiMethod(instanceRequired = true)
public Long getMemoryCapacity();
/**
* A piece of hardware's metric tracking object.
*
* @see SoftLayer_Hardware::getMetricTrackingObject
*/
@ApiMethod(instanceRequired = true)
public HardwareServer getMetricTrackingObject();
/**
* @see SoftLayer_Hardware::getModules
*/
@ApiMethod(instanceRequired = true)
public List getModules();
/**
* Information regarding a piece of hardware's network monitoring services.
*
* @see SoftLayer_Hardware::getMonitoringServiceComponent
*/
@ApiMethod(instanceRequired = true)
public Stratum getMonitoringServiceComponent();
/**
* Information regarding a piece of hardware's motherboard.
*
* @see SoftLayer_Hardware::getMotherboard
*/
@ApiMethod(instanceRequired = true)
public com.softlayer.api.service.hardware.Component getMotherboard();
/**
* Information regarding a piece of hardware's network cards.
*
* @see SoftLayer_Hardware::getNetworkCards
*/
@ApiMethod(instanceRequired = true)
public List getNetworkCards();
/**
* Returns a hardware's network components.
*
* @see SoftLayer_Hardware::getNetworkComponents
*/
@ApiMethod(instanceRequired = true)
public List getNetworkComponents();
/**
* The gateway member if this device is part of a network gateway.
*
* @see SoftLayer_Hardware::getNetworkGatewayMember
*/
@ApiMethod(instanceRequired = true)
public com.softlayer.api.service.network.gateway.Member getNetworkGatewayMember();
/**
* Whether or not this device is part of a network gateway.
*
* @see SoftLayer_Hardware::getNetworkGatewayMemberFlag
*/
@ApiMethod(instanceRequired = true)
public Boolean getNetworkGatewayMemberFlag();
/**
* A piece of hardware's network management IP address.
*
* @see SoftLayer_Hardware::getNetworkManagementIpAddress
*/
@ApiMethod(instanceRequired = true)
public String getNetworkManagementIpAddress();
/**
* All servers with failed monitoring that are attached downstream to a piece of hardware.
*
* @see SoftLayer_Hardware::getNetworkMonitorAttachedDownHardware
*/
@ApiMethod(instanceRequired = true)
public List getNetworkMonitorAttachedDownHardware();
/**
* Virtual guests that are attached downstream to a hardware that have failed monitoring
*
* @see SoftLayer_Hardware::getNetworkMonitorAttachedDownVirtualGuests
*/
@ApiMethod(instanceRequired = true)
public List getNetworkMonitorAttachedDownVirtualGuests();
/**
* The status of all of a piece of hardware's network monitoring incidents.
*
* @see SoftLayer_Hardware::getNetworkMonitorIncidents
*/
@ApiMethod(instanceRequired = true)
public List getNetworkMonitorIncidents();
/**
* Information regarding a piece of hardware's network monitors.
*
* @see SoftLayer_Hardware::getNetworkMonitors
*/
@ApiMethod(instanceRequired = true)
public List getNetworkMonitors();
/**
* The value of a hardware's network status attribute.
*
* @see SoftLayer_Hardware::getNetworkStatus
*/
@ApiMethod(instanceRequired = true)
public String getNetworkStatus();
/**
* The hardware's related network status attribute.
*
* @see SoftLayer_Hardware::getNetworkStatusAttribute
*/
@ApiMethod(instanceRequired = true)
public Attribute getNetworkStatusAttribute();
/**
* Information regarding a piece of hardware's associated network storage service account.
*
* @see SoftLayer_Hardware::getNetworkStorage
*/
@ApiMethod(instanceRequired = true)
public List getNetworkStorage();
/**
* The network virtual LANs (VLANs) associated with a piece of hardware's network components.
*
* @see SoftLayer_Hardware::getNetworkVlans
*/
@ApiMethod(instanceRequired = true)
public List getNetworkVlans();
/**
* A hardware's allotted bandwidth for the next billing cycle (measured in GB).
*
* @see SoftLayer_Hardware::getNextBillingCycleBandwidthAllocation
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getNextBillingCycleBandwidthAllocation();
/**
* @see SoftLayer_Hardware::getNotesHistory
*/
@ApiMethod(instanceRequired = true)
public List getNotesHistory();
/**
* The amount of non-volatile memory a piece of hardware has, measured in gigabytes.
*
* @see SoftLayer_Hardware::getNvRamCapacity
*/
@ApiMethod(instanceRequired = true)
public Long getNvRamCapacity();
/**
* @see SoftLayer_Hardware::getNvRamComponentModels
*/
@ApiMethod(instanceRequired = true)
public List getNvRamComponentModels();
/**
* Information regarding a piece of hardware's operating system.
*
* @see SoftLayer_Hardware::getOperatingSystem
*/
@ApiMethod(instanceRequired = true)
public OperatingSystem getOperatingSystem();
/**
* A hardware's operating system software description.
*
* @see SoftLayer_Hardware::getOperatingSystemReferenceCode
*/
@ApiMethod(instanceRequired = true)
public String getOperatingSystemReferenceCode();
/**
* The sum of all the outbound network traffic data for the last 30 days.
*
* @see SoftLayer_Hardware::getOutboundBandwidthUsage
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getOutboundBandwidthUsage();
/**
* The total public outbound bandwidth for this hardware for the current billing cycle.
*
* @see SoftLayer_Hardware::getOutboundPublicBandwidthUsage
*/
@ApiMethod(instanceRequired = true)
public BigDecimal getOutboundPublicBandwidthUsage();
/**
* Blade Bay
*
* @see SoftLayer_Hardware::getParentBay
*/
@ApiMethod(instanceRequired = true)
public Blade getParentBay();
/**
* Parent Hardware.
*
* @see SoftLayer_Hardware::getParentHardware
*/
@ApiMethod(instanceRequired = true)
public Hardware getParentHardware();
/**
* Information regarding the Point of Presence (PoP) location in which a piece of hardware resides.
*
* @see SoftLayer_Hardware::getPointOfPresenceLocation
*/
@ApiMethod(instanceRequired = true)
public Location getPointOfPresenceLocation();
/**
* The power components for a hardware object.
*
* @see SoftLayer_Hardware::getPowerComponents
*/
@ApiMethod(instanceRequired = true)
public List getPowerComponents();
/**
* Information regarding a piece of hardware's power supply.
*
* @see SoftLayer_Hardware::getPowerSupply
*/
@ApiMethod(instanceRequired = true)
public List getPowerSupply();
/**
* The hardware's primary private IP address.
*
* @see SoftLayer_Hardware::getPrimaryBackendIpAddress
*/
@ApiMethod(instanceRequired = true)
public String getPrimaryBackendIpAddress();
/**
* Information regarding the hardware's primary back-end network component.
*
* @see SoftLayer_Hardware::getPrimaryBackendNetworkComponent
*/
@ApiMethod(instanceRequired = true)
public com.softlayer.api.service.network.Component getPrimaryBackendNetworkComponent();
/**
* The hardware's primary public IP address.
*
* @see SoftLayer_Hardware::getPrimaryIpAddress
*/
@ApiMethod(instanceRequired = true)
public String getPrimaryIpAddress();
/**
* Information regarding the hardware's primary public network component.
*
* @see SoftLayer_Hardware::getPrimaryNetworkComponent
*/
@ApiMethod(instanceRequired = true)
public com.softlayer.api.service.network.Component getPrimaryNetworkComponent();
/**
* Whether the hardware only has access to the private network.
*
* @see SoftLayer_Hardware::getPrivateNetworkOnlyFlag
*/
@ApiMethod(instanceRequired = true)
public Boolean getPrivateNetworkOnlyFlag();
/**
* The total number of processor cores, summed from all processors that are attached to a piece of hardware
*
* @see SoftLayer_Hardware::getProcessorCoreAmount
*/
@ApiMethod(instanceRequired = true)
public Long getProcessorCoreAmount();
/**
* The total number of physical processor cores, summed from all processors that are attached to a piece of hardware
*
* @see SoftLayer_Hardware::getProcessorPhysicalCoreAmount
*/
@ApiMethod(instanceRequired = true)
public Long getProcessorPhysicalCoreAmount();
/**
* Information regarding a piece of hardware's processors.
*
* @see SoftLayer_Hardware::getProcessors
*/
@ApiMethod(instanceRequired = true)
public List getProcessors();
/**
* @see SoftLayer_Hardware::getRack
*/
@ApiMethod(instanceRequired = true)
public Location getRack();
/**
* The RAID controllers contained within a piece of hardware.
*
* @see SoftLayer_Hardware::getRaidControllers
*/
@ApiMethod(instanceRequired = true)
public List getRaidControllers();
/**
* Recent events that impact this hardware.
*
* @see SoftLayer_Hardware::getRecentEvents
*/
@ApiMethod(instanceRequired = true)
public List getRecentEvents();
/**
* User credentials to issue commands and/or interact with the server's remote management card.
*
* @see SoftLayer_Hardware::getRemoteManagementAccounts
*/
@ApiMethod(instanceRequired = true)
public List getRemoteManagementAccounts();
/**
* A hardware's associated remote management component. This is normally IPMI.
*
* @see SoftLayer_Hardware::getRemoteManagementComponent
*/
@ApiMethod(instanceRequired = true)
public com.softlayer.api.service.network.Component getRemoteManagementComponent();
/**
* @see SoftLayer_Hardware::getResourceConfigurations
*/
@ApiMethod(instanceRequired = true)
public List getResourceConfigurations();
/**
* @see SoftLayer_Hardware::getResourceGroupMemberReferences
*/
@ApiMethod(instanceRequired = true)
public List getResourceGroupMemberReferences();
/**
* @see SoftLayer_Hardware::getResourceGroupRoles
*/
@ApiMethod(instanceRequired = true)
public List getResourceGroupRoles();
/**
* The resource groups in which this hardware is a member.
*
* @see SoftLayer_Hardware::getResourceGroups
*/
@ApiMethod(instanceRequired = true)
public List getResourceGroups();
/**
* A hardware's routers.
*
* @see SoftLayer_Hardware::getRouters
*/
@ApiMethod(instanceRequired = true)
public List getRouters();
/**
* Collection of scale assets this hardware corresponds to.
*
* @see SoftLayer_Hardware::getScaleAssets
*/
@ApiMethod(instanceRequired = true)
public List getScaleAssets();
/**
* Information regarding a piece of hardware's vulnerability scan requests.
*
* @see SoftLayer_Hardware::getSecurityScanRequests
*/
@ApiMethod(instanceRequired = true)
public List getSecurityScanRequests();
/**
* Information regarding the server room in which the hardware is located.
*
* @see SoftLayer_Hardware::getServerRoom
*/
@ApiMethod(instanceRequired = true)
public Location getServerRoom();
/**
* Information regarding the piece of hardware's service provider.
*
* @see SoftLayer_Hardware::getServiceProvider
*/
@ApiMethod(instanceRequired = true)
public Provider getServiceProvider();
/**
* Information regarding a piece of hardware's installed software.
*
* @see SoftLayer_Hardware::getSoftwareComponents
*/
@ApiMethod(instanceRequired = true)
public List getSoftwareComponents();
/**
* Information regarding the billing item for a spare pool server.
*
* @see SoftLayer_Hardware::getSparePoolBillingItem
*/
@ApiMethod(instanceRequired = true)
public com.softlayer.api.service.billing.item.Hardware getSparePoolBillingItem();
/**
* SSH keys to be installed on the server during provisioning or an OS reload.
*
* @see SoftLayer_Hardware::getSshKeys
*/
@ApiMethod(instanceRequired = true)
public List getSshKeys();
/**
* @see SoftLayer_Hardware::getStorageGroups
*/
@ApiMethod(instanceRequired = true)
public List getStorageGroups();
/**
* A piece of hardware's private storage network components. [Deprecated]
*
* @see SoftLayer_Hardware::getStorageNetworkComponents
*/
@ApiMethod(instanceRequired = true)
public List getStorageNetworkComponents();
/**
* @see SoftLayer_Hardware::getTagReferences
*/
@ApiMethod(instanceRequired = true)
public List getTagReferences();
/**
* @see SoftLayer_Hardware::getTopLevelLocation
*/
@ApiMethod(instanceRequired = true)
public Location getTopLevelLocation();
/**
* An account's associated upgrade request object, if any.
*
* @see SoftLayer_Hardware::getUpgradeRequest
*/
@ApiMethod(instanceRequired = true)
public Request getUpgradeRequest();
/**
* The network device connected to a piece of hardware.
*
* @see SoftLayer_Hardware::getUplinkHardware
*/
@ApiMethod(instanceRequired = true)
public Hardware getUplinkHardware();
/**
* Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.
*
* @see SoftLayer_Hardware::getUplinkNetworkComponents
*/
@ApiMethod(instanceRequired = true)
public List getUplinkNetworkComponents();
/**
* An array containing a single string of custom user data for a hardware order. Max size is 16 kb.
*
* @see SoftLayer_Hardware::getUserData
*/
@ApiMethod(instanceRequired = true)
public List getUserData();
/**
* Information regarding the virtual chassis for a piece of hardware.
*
* @see SoftLayer_Hardware::getVirtualChassis
*/
@ApiMethod(instanceRequired = true)
public com.softlayer.api.service.hardware.Group getVirtualChassis();
/**
* Information regarding the virtual chassis siblings for a piece of hardware.
*
* @see SoftLayer_Hardware::getVirtualChassisSiblings
*/
@ApiMethod(instanceRequired = true)
public List getVirtualChassisSiblings();
/**
* A piece of hardware's virtual host record.
*
* @see