Items with tag softlayer_hardware

    csharp

    go

    java

    • Working with Network Vlan
      This example below lists a few of the common ways of interacting with VLANs, including how to order, list, cancel Vlan, and list routers by datacenter.

    perl

    php

    python

    reference

    • allowAccessToNetworkStorage
      This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.
    • allowAccessToNetworkStorageList
      This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.
    • captureImage
      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.
    • createObject
      <style type='text/css'>.create_object > li > div { padding-top: .5em; padding-bottom: .5em}</style> 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](/reference/services/SoftLayer_Hardware/getObject), checking the <code>provisionDate</code> property. When <code>provisionDate</code> is not null, the server will be ready. Be sure to use the <code>globalIdentifier</code> as your initialization parameter. <b>Warning:</b> Servers created via this method will incur charges on your account. For testing input parameters see [SoftLayer_Hardware::generateOrderTemplate](/reference/services/SoftLayer_Hardware/generateOrderTemplate). <b>Input</b> - [SoftLayer_Hardware](/reference/datatypes/SoftLayer_Hardware) <ul class='create_object'> <li><code>hostname</code> <div>Hostname for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> <li><code>domain</code> <div>Domain for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> <li><code>processorCoreAmount</code> <div>The number of logical CPU cores to allocate.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - int</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>memoryCapacity</code> <div>The amount of memory to allocate in gigabytes.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - int</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>hourlyBillingFlag</code> <div>Specifies the billing type for the server.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - boolean</li> <li>When true the server will be billed on hourly usage, otherwise it will be billed on a monthly basis.</li> </ul> <br /> </li> <li><code>operatingSystemReferenceCode</code> <div>An identifier for the operating system to provision the server with.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <br /> </li> <li><code>datacenter.name</code> <div>Specifies which datacenter the server is to be provisioned in.</div><ul> <li><b>Required</b></li> <li><b>Type</b> - string</li> <li>The <code>datacenter</code> property is a [SoftLayer_Location](/reference/datatypes/SoftLayer_Location) structure with the <code>name</code> field set.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'datacenter': { 'name': 'dal05' } }</http> <br /> </li> <li><code>networkComponents.maxSpeed</code> <div>Specifies the connection speed for the server's network components.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Default</b> - The highest available zero cost port speed will be used.</li> <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure. The <code>maxSpeed</code> property must be set to specify the network uplink speed, in megabits per second, of the server.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'networkComponents': [ { 'maxSpeed': 1000 } ] }</http> <br /> </li> <li><code>networkComponents.redundancyEnabledFlag</code> <div>Specifies whether or not the server's network components should be in redundancy groups.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - bool</li> <li><b>Default</b> - <code>false</code></li> <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure. When the <code>redundancyEnabledFlag</code> property is true the server's network components will be in redundancy groups.</li> </ul> <http title='Example'>{ 'networkComponents': [ { 'redundancyEnabledFlag': false } ] }</http> <br /> </li> <li><code>privateNetworkOnlyFlag</code> <div>Specifies whether or not the server only has access to the private network</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - boolean</li> <li><b>Default</b> - <code>false</code></li> <li>When true this flag specifies that a server is to only have access to the private network.</li> </ul> <br /> </li> <li><code>primaryNetworkComponent.networkVlan.id</code> <div>Specifies the network vlan which is to be used for the frontend interface of the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Description</b> - The <code>primaryNetworkComponent</code> property is a [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure with the <code>networkVlan</code> property populated with a [SoftLayer_Network_Vlan](/reference/datatypes/SoftLayer_Network_Vlan) structure. The <code>id</code> property must be set to specify the frontend network vlan of the server.</li> </ul> <http title='Example'>{ 'primaryNetworkComponent': { 'networkVlan': { 'id': 1 } } }</http> <br /> </li> <li><code>primaryBackendNetworkComponent.networkVlan.id</code> <div>Specifies the network vlan which is to be used for the backend interface of the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - int</li> <li><b>Description</b> - The <code>primaryBackendNetworkComponent</code> property is a [SoftLayer_Network_Component](/reference/datatypes/SoftLayer_Network_Component) structure with the <code>networkVlan</code> property populated with a [SoftLayer_Network_Vlan](/reference/datatypes/SoftLayer_Network_Vlan) structure. The <code>id</code> property must be set to specify the backend network vlan of the server.</li> </ul> <http title='Example'>{ 'primaryBackendNetworkComponent': { 'networkVlan': { 'id': 2 } } }</http> <br /> </li> <li><code>fixedConfigurationPreset.keyName</code> <div></div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> <li><b>Description</b> - The <code>fixedConfigurationPreset</code> property is a [SoftLayer_Product_Package_Preset](/reference/datatypes/SoftLayer_Product_Package_Preset) structure. The <code>keyName</code> property must be set to specify preset to use.</li> <li>If a fixed configuration preset is used <code>processorCoreAmount</code>, <code>memoryCapacity</code> and <code>hardDrives</code> properties must not be set.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'fixedConfigurationPreset': { 'keyName': 'SOME_KEY_NAME' } }</http> <br /> </li> <li><code>userData.value</code> <div>Arbitrary data to be made available to the server.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> <li><b>Description</b> - The <code>userData</code> property is an array with a single [SoftLayer_Hardware_Attribute](/reference/datatypes/SoftLayer_Hardware_Attribute) structure with the <code>value</code> property set to an arbitrary value.</li> <li>This value can be retrieved via the [SoftLayer_Resource_Metadata::getUserMetadata](/reference/services/SoftLayer_Resource_Metadata/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.</li> </ul> <http title='Example'>{ 'userData': [ { 'value': 'someValue' } ] }</http> <br /> </li> <li><code>hardDrives</code> <div>Hard drive settings for the server</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - SoftLayer_Hardware_Component</li> <li><b>Default</b> - The largest available capacity for a zero cost primary disk will be used.</li> <li><b>Description</b> - The <code>hardDrives</code> property is an array of [SoftLayer_Hardware_Component](/reference/datatypes/SoftLayer_Hardware_Component) structures.</i> <li>Each hard drive must specify the <code>capacity</code> property.</li> <li>See [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) for available options.</li> </ul> <http title='Example'>{ 'hardDrives': [ { 'capacity': 500 } ] }</http> <br /> </li> <li id='hardware-create-object-ssh-keys'><code>sshKeys</code> <div>SSH keys to install on the server upon provisioning.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - array of [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key)</li> <li><b>Description</b> - The <code>sshKeys</code> property is an array of [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key) structures with the <code>id</code> property set to the value of an existing SSH key.</li> <li>To create a new SSH key, call [SoftLayer_Security_Ssh_Key::createObject](/reference/services/SoftLayer_Security_Ssh_Key/createObject) on the [SoftLayer_Security_Ssh_Key](/reference/datatypes/SoftLayer_Security_Ssh_Key) service.</li> <li>To obtain a list of existing SSH keys, call [SoftLayer_Account::getSshKeys](/reference/services/SoftLayer_Account/getSshKeys) on the [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) service. </ul> <http title='Example'>{ 'sshKeys': [ { 'id': 123 } ] }</http> <br /> </li> <li><code>postInstallScriptUri</code> <div>Specifies the uri location of the script to be downloaded and run after installation is complete.</div><ul> <li><b>Optional</b></li> <li><b>Type</b> - string</li> </ul> <br /> </li> </ul> <h1>REST Example</h1> <http title='Request'>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> <http title='Response'>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 } </http>
    • deleteObject
      This method will cancel a server effective immediately. For servers billed hourly, the charges will stop immediately after the method returns.
    • deleteSoftwareComponentPasswords
      Delete software component passwords.
    • deleteTag
      Delete an existing tag. If there are any references on the tag, an exception will be thrown.
    • editSoftwareComponentPasswords
      Edit the properties of a software component password such as the username, password, and notes.
    • executeRemoteScript
      Download and run remote script from uri on the hardware.
    • findByIpAddress
      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.
    • generateOrderTemplate
      Obtain an [SoftLayer_Container_Product_Order_Hardware_Server](/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server) that can be sent to [SoftLayer_Product_Order::verifyOrder](/reference/services/SoftLayer_Product_Order/verifyOrder) or [SoftLayer_Product_Order::placeOrder](/reference/services/SoftLayer_Product_Order/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](/reference/services/SoftLayer_Hardware/createObject) for specifics on the requirements of the template object parameter.
    • getAccount
      The account associated with a piece of hardware.
    • getActiveComponents
      A piece of hardware's active physical components.
    • getActiveNetworkMonitorIncident
      A piece of hardware's active network monitoring incidents.
    • getAllowedHost
      The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.
    • getAllowedNetworkStorage
      The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.
    • getAllowedNetworkStorageReplicas
      The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.
    • getAllPowerComponents
    • getAntivirusSpywareSoftwareComponent
      Information regarding an antivirus/spyware software component object.
    • getAttachedNetworkStorages
      This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Hardware.
    • getAttributes
      Information regarding a piece of hardware's specific attributes.
    • getAvailableBillingTermChangePrices
      Retrieves a list of available term prices to this hardware. Currently, price terms are only available for increasing term length to monthly billed servers.
    • getAvailableNetworkStorages
      This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Hardware.
    • getAverageDailyPublicBandwidthUsage
      The average daily public bandwidth usage for the current billing cycle.
    • getBackendIncomingBandwidth
      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.
    • getBackendNetworkComponents
      A piece of hardware's back-end or private network components.
    • getBackendOutgoingBandwidth
      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.
    • getBackendRouters
      A hardware's backend or private router.
    • getBandwidthAllocation
      A hardware's allotted bandwidth (measured in GB).
    • getBandwidthAllotmentDetail
      A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.
    • getBenchmarkCertifications
      Information regarding a piece of hardware's benchmark certifications.
    • getBillingItem
      Information regarding the billing item for a server.
    • getBillingItemFlag
      A flag indicating that a billing item exists.
    • getBlockCancelBecauseDisconnectedFlag
      Determines whether the hardware is ineligible for cancellation because it is disconnected.
    • getBusinessContinuanceInsuranceFlag
      Status indicating whether or not a piece of hardware has business continuance insurance.
    • getChildrenHardware
      Child hardware.
    • getComponentDetailsXML
    • getComponents
      A piece of hardware's components.
    • getContinuousDataProtectionSoftwareComponent
      A continuous data protection/server backup software component object.
    • getCreateObjectOptions
      There are many options that may be provided while ordering a server, this method can be used to determine what these options are. Detailed information on the return value can be found on the data type page for [SoftLayer_Container_Hardware_Configuration](/reference/datatypes/SoftLayer_Container_Hardware_Configuration).
    • getCurrentBillableBandwidthUsage
      The current billable public outbound bandwidth for this hardware for the current billing cycle.
    • getCurrentBillingDetail
      Get the billing detail for this hardware for the current billing period. This does not include bandwidth usage.
    • getCurrentBillingTotal
      Get the total bill amount in US Dollars ($) for this hardware in the current billing period. This includes all bandwidth used up to the point the method is called on the hardware.
    • getDailyAverage
      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.
    • getDatacenter
      Information regarding the datacenter in which a piece of hardware resides.
    • getDatacenterName
      The name of the datacenter in which a piece of hardware resides.
    • getDaysInSparePool
      Number of day(s) a server have been in spare pool.
    • getDownlinkHardware
      All hardware that has uplink network connections to a piece of hardware.
    • getDownlinkNetworkHardware
      All hardware that has uplink network connections to a piece of hardware.
    • getDownlinkServers
      Information regarding all servers attached to a piece of network hardware.
    • getDownlinkVirtualGuests
      Information regarding all virtual guests attached to a piece of network hardware.
    • getDownstreamHardwareBindings
      All hardware downstream from a network device.
    • getDownstreamNetworkHardware
      All network hardware downstream from the selected piece of hardware.
    • getDownstreamNetworkHardwareWithIncidents
      All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED]
    • getDownstreamServers
      Information regarding all servers attached downstream to a piece of network hardware.
    • getDownstreamVirtualGuests
      Information regarding all virtual guests attached to a piece of network hardware.
    • getDriveControllers
      The drive controllers contained within a piece of hardware.
    • getEvaultNetworkStorage
      Information regarding a piece of hardware's associated EVault network storage service account.
    • getFirewallServiceComponent
      Information regarding a piece of hardware's firewall services.
    • getFixedConfigurationPreset
      Defines the fixed components in a fixed configuration bare metal server.
    • getFrontendIncomingBandwidth
      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).
    • getFrontendNetworkComponents
      A piece of hardware's front-end or public network components.
    • getFrontendOutgoingBandwidth
      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).
    • getFrontendRouters
      A hardware's frontend or public router.
    • getFutureBillingItem
      Information regarding the future billing item for a server.
    • getGlobalIdentifier
      A hardware's universally unique identifier.
    • getHardDrives
      The hard drives contained within a piece of hardware.
    • getHardwareChassis
      The chassis that a piece of hardware is housed in.
    • getHardwareFunction
      A hardware's function.
    • getHardwareFunctionDescription
      A hardware's function.
    • getHardwareState
      A hardware's power/transaction state.
    • getHardwareStatus
      A hardware's status.
    • getHasTrustedPlatformModuleBillingItemFlag
      Determine in hardware object has TPM enabled.
    • getHostIpsSoftwareComponent
      Information regarding a host IPS software component object.
    • getHourlyBandwidth
      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.
    • getHourlyBillingFlag
      A server's hourly billing status.
    • getInboundBandwidthUsage
      The sum of all the inbound network traffic data for the last 30 days.
    • getInboundPublicBandwidthUsage
      The total public inbound bandwidth for this hardware for the current billing cycle.
    • getIsBillingTermChangeAvailableFlag
      Whether or not this hardware object is eligible to change to term billing.
    • getLastTransaction
      Information regarding the last transaction a server performed.
    • getLatestNetworkMonitorIncident
      A piece of hardware's latest network monitoring incident.
    • getLocation
      Where a piece of hardware is located within SoftLayer's location hierarchy.
    • getLocationPathString
    • getLockboxNetworkStorage
      Information regarding a lockbox account associated with a server.
    • getManagedResourceFlag
      A flag indicating that the hardware is a managed resource.
    • getMemory
      Information regarding a piece of hardware's memory.
    • getMemoryCapacity
      The amount of memory a piece of hardware has, measured in gigabytes.
    • getMetricTrackingObject
      A piece of hardware's metric tracking object.
    • getModules
    • getMonitoringRobot
    • getMonitoringServiceComponent
      Information regarding a piece of hardware's network monitoring services.
    • getMonitoringServiceEligibilityFlag
    • getMotherboard
      Information regarding a piece of hardware's motherboard.
    • getNetworkCards
      Information regarding a piece of hardware's network cards.
    • getNetworkComponents
      Returns a hardware's network components.
    • getNetworkGatewayMember
      The gateway member if this device is part of a network gateway.
    • getNetworkGatewayMemberFlag
      Whether or not this device is part of a network gateway.
    • getNetworkManagementIpAddress
      A piece of hardware's network management IP address.
    • getNetworkMonitorAttachedDownHardware
      All servers with failed monitoring that are attached downstream to a piece of hardware.
    • getNetworkMonitorAttachedDownVirtualGuests
      Virtual guests that are attached downstream to a hardware that have failed monitoring
    • getNetworkMonitorIncidents
      The status of all of a piece of hardware's network monitoring incidents.
    • getNetworkMonitors
      Information regarding a piece of hardware's network monitors.
    • getNetworkStatus
      The value of a hardware's network status attribute. [DEPRECATED]
    • getNetworkStatusAttribute
      The hardware's related network status attribute. [DEPRECATED]
    • getNetworkStorage
      Information regarding a piece of hardware's associated network storage service account.
    • getNetworkVlans
      The network virtual LANs (VLANs) associated with a piece of hardware's network components.
    • getNextBillingCycleBandwidthAllocation
      A hardware's allotted bandwidth for the next billing cycle (measured in GB).
    • getNotesHistory
    • getNvRamCapacity
      The amount of non-volatile memory a piece of hardware has, measured in gigabytes.
    • getNvRamComponentModels
    • getObject
      getObject retrieves the SoftLayer_Hardware object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware service. You can only retrieve the account that your portal user is assigned to.
    • getOperatingSystem
      Information regarding a piece of hardware's operating system.
    • getOperatingSystemReferenceCode
      A hardware's operating system software description.
    • getOutboundBandwidthUsage
      The sum of all the outbound network traffic data for the last 30 days.
    • getOutboundPublicBandwidthUsage
      The total public outbound bandwidth for this hardware for the current billing cycle.
    • getParentBay
      Blade Bay
    • getParentHardware
      Parent Hardware.
    • getPointOfPresenceLocation
      Information regarding the Point of Presence (PoP) location in which a piece of hardware resides.
    • getPowerComponents
      The power components for a hardware object.
    • getPowerSupply
      Information regarding a piece of hardware's power supply.
    • getPrimaryBackendIpAddress
      The hardware's primary private IP address.
    • getPrimaryBackendNetworkComponent
      Information regarding the hardware's primary back-end network component.
    • getPrimaryIpAddress
      The hardware's primary public IP address.
    • getPrimaryNetworkComponent
      Information regarding the hardware's primary public network component.
    • getPrivateBandwidthData
      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.
    • getPrivateNetworkOnlyFlag
      Whether the hardware only has access to the private network.
    • getProcessorCoreAmount
      The total number of processor cores, summed from all processors that are attached to a piece of hardware
    • getProcessorPhysicalCoreAmount
      The total number of physical processor cores, summed from all processors that are attached to a piece of hardware
    • getProcessors
      Information regarding a piece of hardware's processors.
    • getPublicBandwidthData
      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.
    • getRack
    • getRaidControllers
      The RAID controllers contained within a piece of hardware.
    • getRecentEvents
      Recent events that impact this hardware.
    • getRemoteManagementAccounts
      User credentials to issue commands and/or interact with the server's remote management card.
    • getRemoteManagementComponent
      A hardware's associated remote management component. This is normally IPMI.
    • getResourceConfigurations
    • getResourceGroupMemberReferences
    • getResourceGroupRoles
    • getResourceGroups
      The resource groups in which this hardware is a member.
    • getRouters
      A hardware's routers.
    • getScaleAssets
      [DEPRECATED] Collection of scale assets this hardware corresponds to.
    • getSecurityScanRequests
      Information regarding a piece of hardware's vulnerability scan requests.
    • getSensorData
      The '''getSensorData''' method retrieves a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures various information, including system temperatures, voltages and other local server settings. Sensor data is cached for 30 second; calls made to this method for the same server within 30 seconds of each other will result in the same data being returned. To ensure that the data retrieved retrieves snapshot of varied data, make calls greater than 30 seconds apart.
    • getSensorDataWithGraphs
      The '''getSensorDataWithGraphs''' method retrieves the raw data returned from the server's remote management card. Along with raw data, graphs for the CPU and system temperatures and fan speeds are also returned. For more details on what information is returned, refer to the ''getSensorData'' method.
    • getServerFanSpeedGraphs
      The '''getServerFanSpeedGraphs''' method retrieves the server's fan speeds and displays the speeds using tachometer graphs. data used to construct these graphs is retrieved from the server's remote management card. Each graph returned will have an associated title.
    • getServerPowerState
      The '''getPowerState''' method retrieves the power state for the selected server. The server's power status is retrieved from its remote management card. This method returns 'on', for a server that has been powered on, or 'off' for servers powered off.
    • getServerRoom
      Information regarding the server room in which the hardware is located.
    • getServerTemperatureGraphs
      The '''getServerTemperatureGraphs''' retrieves the server's temperatures and displays the various temperatures using thermometer graphs. Temperatures retrieved are CPU temperature(s) and system temperatures. Data used to construct the graphs is retrieved from the server's remote management card. All graphs returned will have an associated title.
    • getServiceProvider
      Information regarding the piece of hardware's service provider.
    • getSoftwareComponents
      Information regarding a piece of hardware's installed software.
    • getSparePoolBillingItem
      Information regarding the billing item for a spare pool server.
    • getSshKeys
      SSH keys to be installed on the server during provisioning or an OS reload.
    • getStorageGroups
    • getStorageNetworkComponents
      A piece of hardware's private storage network components. [Deprecated]
    • getTagReferences
    • getTopLevelLocation
    • getTransactionHistory
      This method will query transaction history for a piece of hardware.
    • getUpgradeableActiveComponents
      A piece of hardware's active upgradeable physical components.
    • getUpgradeItemPrices
      Retrieve a list of upgradeable items available to this piece of hardware. Currently, getUpgradeItemPrices retrieves upgrades available for a server's memory, hard drives, network port speed, bandwidth allocation and GPUs.
    • getUpgradeRequest
      An account's associated upgrade request object, if any.
    • getUplinkHardware
      The network device connected to a piece of hardware.
    • getUplinkNetworkComponents
      Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.
    • getUserData
      An array containing a single string of custom user data for a hardware order. Max size is 16 kb.
    • getVirtualChassis
      Information regarding the virtual chassis for a piece of hardware.
    • getVirtualChassisSiblings
      Information regarding the virtual chassis siblings for a piece of hardware.
    • getVirtualHost
      A piece of hardware's virtual host record.
    • getVirtualizationPlatform
      A piece of hardware's virtualization platform software.
    • getVirtualLicenses
      Information regarding a piece of hardware's virtual software licenses.
    • getVirtualRack
      Information regarding the bandwidth allotment to which a piece of hardware belongs.
    • getVirtualRackId
      The name of the bandwidth allotment belonging to a piece of hardware.
    • getVirtualRackName
      The name of the bandwidth allotment belonging to a piece of hardware.
    • importVirtualHost
      The '''importVirtualHost''' method attempts to import the host record for the virtualization platform running on a server.
    • isPingable
      The '''isPingable''' method issues a ping command to the selected server and returns the result of the ping command. This boolean return value displays ''true'' upon successful ping or ''false'' for a failed ping.
    • ping
      Issues a ping command to the server and returns the ping response.
    • powerCycle
      The '''powerCycle''' method completes a power off and power on of the server successively in one command. The power cycle command is equivalent to unplugging the server from the power strip and then plugging the server back in. '''This method should only be used when all other options have been exhausted'''. Additional remote management commands may not be executed if this command was successfully issued within the last 20 minutes to avoid server failure. Remote management commands include: rebootSoft rebootHard powerOn powerOff powerCycle
    • powerOff
      This method will power off the server via the server's remote management card.
    • powerOn
      The '''powerOn''' method powers on a server via its remote management card. This boolean return value returns ''true'' upon successful execution and ''false'' if unsuccessful. Other remote management commands may not be issued in this command was successfully completed within the last 20 minutes to avoid server failure. Remote management commands include: rebootSoft rebootHard powerOn powerOff powerCycle
    • rebootDefault
      The '''rebootDefault''' method attempts to reboot the server by issuing a soft reboot, or reset, command to the server's remote management card. if the reset attempt is unsuccessful, a power cycle command will be issued via the power strip. The power cycle command is equivalent to unplugging the server from the power strip and then plugging the server back in. If the reset was successful within the last 20 minutes, another remote management command cannot be completed to avoid server failure. Remote management commands include: rebootSoft rebootHard powerOn powerOff powerCycle
    • rebootHard
      The '''rebootHard''' method reboots the server by issuing a cycle command to the server's remote management card. A hard reboot is equivalent to pressing the ''Reset'' button on a server - it is issued immediately and will not allow processes to shut down prior to the reboot. Completing a hard reboot may initiate system disk checks upon server reboot, causing the boot up to take longer than normally expected. Remote management commands are unable to be executed if a reboot has been issued successfully within the last 20 minutes to avoid server failure. Remote management commands include: rebootSoft rebootHard powerOn powerOff powerCycle
    • rebootSoft
      The '''rebootSoft''' method reboots the server by issuing a reset command to the server's remote management card via soft reboot. When executing a soft reboot, servers allow all processes to shut down completely before rebooting. Remote management commands are unable to be issued within 20 minutes of issuing a successful soft reboot in order to avoid server failure. Remote management commands include: rebootSoft rebootHard powerOn powerOff powerCycle
    • refreshDeviceStatus
    • removeAccessToNetworkStorage
      This method is used to remove access to s SoftLayer_Network_Storage volumes that supports host- or network-level access control.
    • removeAccessToNetworkStorageList
      This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.
    • removeTags
      Remove a tag reference
    • setTags
    • SoftLayer_Hardware
      The SoftLayer_Hardware data type contains general information relating to a single SoftLayer hardware.
    • SoftLayer_Hardware
      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.
    • updateIpmiPassword
      This method will update the root IPMI password on this SoftLayer_Hardware.

    rest

    ruby