SoftLayer_Hardware_Router


SoftLayer_Hardware_Router

Description

This service provides access to the device responsible for routing a particular SoftLayer Router.

seeAlso

Methods

allowAccessToNetworkStorage

Allow access to a SoftLayer_Network_Storage volume from this device.

allowAccessToNetworkStorageList

Allow access to multiple SoftLayer_Network_Storage volumes from this device.

captureImage

Captures an Image of the hard disk on the physical machine.

closeAlarm

Returns monitoring alarm detailed history

createObject

Create a new server

deleteObject

Delete a server

deleteSoftwareComponentPasswords

Delete software component passwords.

deleteTag

Delete a tag

editSoftwareComponentPasswords

Edit the properties of software component passwords.

executeRemoteScript

Download and run remote script from uri on the hardware. Requires https for script to be executed after download.

findByIpAddress

Find hardware by its primary public or private IP (ipv4) address.

generateOrderTemplate

Obtain an order container for a given template object

getAccount

Retrieve the account associated with a piece of hardware.

getActiveComponents

Retrieve a piece of hardware's active physical components.

getActiveNetworkMonitorIncident

Retrieve a piece of hardware's active network monitoring incidents.

getAlarmHistory

Returns monitoring alarm detailed history

getAllowedHost

Retrieve the SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.

getAllowedNetworkStorage

Retrieve the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.

getAllowedNetworkStorageReplicas

Retrieve the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.

getAntivirusSpywareSoftwareComponent

Retrieve information regarding an antivirus/spyware software component object.

getAttachedNetworkStorages

Return a list of SoftLayer_Network_Storage volumes authorized to this device.

getAttributes

Retrieve information regarding a piece of hardware's specific attributes.

getAvailableNetworkStorages

Return a list of SoftLayer_Network_Storage volumes that can be authorized to this device.

getAverageDailyPublicBandwidthUsage

Retrieve the average daily public bandwidth usage for the current billing cycle.

getBackendIncomingBandwidth

Retrieve the amount of incoming private network bandwidth used by a server over a period of time.

getBackendNetworkComponents

Retrieve a piece of hardware's back-end or private network components.

getBackendOutgoingBandwidth

Retrieve the amount of outgoing private network bandwidth used by a server over a period of time.

getBackendRouters

Retrieve a hardware's backend or private router.

getBandwidthAllocation

Retrieve a hardware's allotted bandwidth (measured in GB).

getBandwidthAllotmentDetail

Retrieve a hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.

getBenchmarkCertifications

Retrieve information regarding a piece of hardware's benchmark certifications.

getBillingItem

Retrieve information regarding the billing item for a server.

getBillingItemFlag

Retrieve a flag indicating that a billing item exists.

getBlockCancelBecauseDisconnectedFlag

Retrieve determines whether the hardware is ineligible for cancellation because it is disconnected.

getBoundSubnets

Retrieve associated subnets for a router object.

getBusinessContinuanceInsuranceFlag

Retrieve status indicating whether or not a piece of hardware has business continuance insurance.

getChildrenHardware

Retrieve child hardware.

getComponents

Retrieve a piece of hardware's components.

getContinuousDataProtectionSoftwareComponent

Retrieve a continuous data protection/server backup software component object.

getCreateObjectOptions

Determine options available when creating a server

getCurrentBillableBandwidthUsage

Retrieve the current billable public outbound bandwidth for this hardware for the current billing cycle.

getCurrentBillingTotal

Get the billing total for this instance's usage up to this point. This total includes all bandwidth charges.

getDailyAverage

calculate the average daily network traffic used by a server in gigabytes.

getDatacenter

Retrieve information regarding the datacenter in which a piece of hardware resides.

getDatacenterName

Retrieve the name of the datacenter in which a piece of hardware resides.

getDaysInSparePool

Retrieve number of day(s) a server have been in spare pool.

getDownlinkHardware

Retrieve all hardware that has uplink network connections to a piece of hardware.

getDownlinkNetworkHardware

Retrieve all hardware that has uplink network connections to a piece of hardware.

getDownlinkServers

Retrieve information regarding all servers attached to a piece of network hardware.

getDownlinkVirtualGuests

Retrieve information regarding all virtual guests attached to a piece of network hardware.

getDownstreamHardwareBindings

Retrieve all hardware downstream from a network device.

getDownstreamNetworkHardware

Retrieve all network hardware downstream from the selected piece of hardware.

getDownstreamNetworkHardwareWithIncidents

Retrieve all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware.

getDownstreamServers

Retrieve information regarding all servers attached downstream to a piece of network hardware.

getDownstreamVirtualGuests

Retrieve information regarding all virtual guests attached to a piece of network hardware.

getDriveControllers

Retrieve the drive controllers contained within a piece of hardware.

getEvaultNetworkStorage

Retrieve information regarding a piece of hardware's associated EVault network storage service account.

getFirewallServiceComponent

Retrieve information regarding a piece of hardware's firewall services.

getFixedConfigurationPreset

Retrieve defines the fixed components in a fixed configuration bare metal server.

getFrontendIncomingBandwidth

Retrieve the amount of incoming public network bandwidth used by a server over a period of time.

getFrontendNetworkComponents

Retrieve a piece of hardware's front-end or public network components.

getFrontendOutgoingBandwidth

Retrieve the amount of outgoing public network bandwidth used by a server over a period of time.

getFrontendRouters

Retrieve a hardware's frontend or public router.

getGlobalIdentifier

Retrieve a hardware's universally unique identifier.

getHardDrives

Retrieve the hard drives contained within a piece of hardware.

getHardwareChassis

Retrieve the chassis that a piece of hardware is housed in.

getHardwareFunction

Retrieve a hardware's function.

getHardwareFunctionDescription

Retrieve a hardware's function.

getHardwareStatus

Retrieve a hardware's status.

getHasTrustedPlatformModuleBillingItemFlag

Retrieve determine in hardware object has TPM enabled.

getHostIpsSoftwareComponent

Retrieve information regarding a host IPS software component object.

getHourlyBandwidth

Retrieves bandwidth hourly over a 24-hour period for the specified hardware.

getHourlyBillingFlag

Retrieve a server's hourly billing status.

getInboundBandwidthUsage

Retrieve the sum of all the inbound network traffic data for the last 30 days.

getInboundPublicBandwidthUsage

Retrieve the total public inbound bandwidth for this hardware for the current billing cycle.

getLastTransaction

Retrieve information regarding the last transaction a server performed.

getLatestNetworkMonitorIncident

Retrieve a piece of hardware's latest network monitoring incident.

getLocalDiskStorageCapabilityFlag

Retrieve a flag indicating that a VLAN on the router can be assigned to a host that has local disk functionality.

getLocation

Retrieve where a piece of hardware is located within SoftLayer's location hierarchy.

getLockboxNetworkStorage

Retrieve information regarding a lockbox account associated with a server.

getManagedResourceFlag

Retrieve a flag indicating that the hardware is a managed resource.

getMemory

Retrieve information regarding a piece of hardware's memory.

getMemoryCapacity

Retrieve the amount of memory a piece of hardware has, measured in gigabytes.

getMetricTrackingObject

Retrieve a piece of hardware's metric tracking object.

getMonitoringActiveAlarms

Returns open monitoring alarms for a given time period

getMonitoringAgents

Retrieve information regarding the monitoring agents associated with a piece of hardware.

getMonitoringClosedAlarms

Returns closed monitoring alarms for a given time period

getMonitoringRobot

Retrieve information regarding the hardware's monitoring robot.

getMonitoringServiceComponent

Retrieve information regarding a piece of hardware's network monitoring services.

getMonitoringServiceEligibilityFlag

Retrieve the monitoring service flag eligibility status for a piece of hardware.

getMonitoringServiceFlag

Retrieve the service flag status for a piece of hardware.

getMotherboard

Retrieve information regarding a piece of hardware's motherboard.

getNetworkCards

Retrieve information regarding a piece of hardware's network cards.

getNetworkComponents

Retrieve returns a hardware's network components.

getNetworkGatewayMember

Retrieve the gateway member if this device is part of a network gateway.

getNetworkGatewayMemberFlag

Retrieve whether or not this device is part of a network gateway.

getNetworkMonitorAttachedDownHardware

Retrieve all servers with failed monitoring that are attached downstream to a piece of hardware.

getNetworkMonitorAttachedDownVirtualGuests

Retrieve virtual guests that are attached downstream to a hardware that have failed monitoring

getNetworkMonitorIncidents

Retrieve the status of all of a piece of hardware's network monitoring incidents.

getNetworkMonitors

Retrieve information regarding a piece of hardware's network monitors.

getNetworkStatus

Retrieve the value of a hardware's network status attribute.

getNetworkStatusAttribute

Retrieve the hardware's related network status attribute.

getNetworkStorage

Retrieve information regarding a piece of hardware's associated network storage service account.

getNextBillingCycleBandwidthAllocation

Retrieve a hardware's allotted bandwidth for the next billing cycle (measured in GB).

getNvRamCapacity

Retrieve the amount of non-volatile memory a piece of hardware has, measured in gigabytes.

getObject

Retrieve a SoftLayer_Hardware_Router record.

getOperatingSystem

Retrieve information regarding a piece of hardware's operating system.

getOperatingSystemReferenceCode

Retrieve a hardware's operating system software description.

getOutboundBandwidthUsage

Retrieve the sum of all the outbound network traffic data for the last 30 days.

getOutboundPublicBandwidthUsage

Retrieve the total public outbound bandwidth for this hardware for the current billing cycle.

getParentBay

Retrieve blade Bay

getParentHardware

Retrieve parent Hardware.

getPointOfPresenceLocation

Retrieve information regarding the Point of Presence (PoP) location in which a piece of hardware resides.

getPowerComponents

Retrieve the power components for a hardware object.

getPowerSupply

Retrieve information regarding a piece of hardware's power supply.

getPrimaryBackendNetworkComponent

Retrieve information regarding the hardware's primary back-end network component.

getPrimaryNetworkComponent

Retrieve information regarding the hardware's primary public network component.

getPrivateBandwidthData

Retrieve a graph of a server's private network usage.

getPrivateNetworkOnlyFlag

Retrieve whether the hardware only has access to the private network.

getProcessorCoreAmount

Retrieve the total number of processor cores, summed from all processors that are attached to a piece of hardware

getProcessorPhysicalCoreAmount

Retrieve the total number of physical processor cores, summed from all processors that are attached to a piece of hardware

getProcessors

Retrieve information regarding a piece of hardware's processors.

getPublicBandwidthData

Retrieve a graph of a server's public network usage.

getRaidControllers

Retrieve the RAID controllers contained within a piece of hardware.

getRecentEvents

Retrieve recent events that impact this hardware.

getRemoteManagementAccounts

Retrieve user credentials to issue commands and/or interact with the server's remote management card.

getRemoteManagementComponent

Retrieve a hardware's associated remote management component. This is normally IPMI.

getResourceGroups

Retrieve the resource groups in which this hardware is a member.

getRouters

Retrieve a hardware's routers.

getSanStorageCapabilityFlag

Retrieve a flag indicating that a VLAN on the router can be assigned to a host that has SAN disk functionality.

getScaleAssets

Retrieve collection of scale assets this hardware corresponds to.

getSecurityScanRequests

Retrieve information regarding a piece of hardware's vulnerability scan requests.

getSensorData

Retrieve a server's hardware state via its internal sensors

getSensorDataWithGraphs

Retrieve server's temperature and fan speed graphs as well the sensor raw data.

getServerFanSpeedGraphs

Retrieve a server's fan speed graphs.

getServerPowerState

Retrieves a server's power state.

getServerRoom

Retrieve information regarding the server room in which the hardware is located.

getServerTemperatureGraphs

Retrieve server's temperature graphs

getServiceProvider

Retrieve information regarding the piece of hardware's service provider.

getSoftwareComponents

Retrieve information regarding a piece of hardware's installed software.

getSparePoolBillingItem

Retrieve information regarding the billing item for a spare pool server.

getSshKeys

Retrieve sSH keys to be installed on the server during provisioning or an OS reload.

getStorageNetworkComponents

Retrieve a piece of hardware's private storage network components. [Deprecated]

getTransactionHistory

Get transaction history for a piece of hardware.

getUpgradeItemPrices

Retrieve a list of upgradable items available to a piece of hardware.

getUpgradeRequest

Retrieve an account's associated upgrade request object, if any.

getUplinkHardware

Retrieve the network device connected to a piece of hardware.

getUplinkNetworkComponents

Retrieve information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.

getUserData

Retrieve an array containing a single string of custom user data for a hardware order. Max size is 16 kb.

getVirtualChassis

Retrieve information regarding the virtual chassis for a piece of hardware.

getVirtualChassisSiblings

Retrieve information regarding the virtual chassis siblings for a piece of hardware.

getVirtualHost

Retrieve a piece of hardware's virtual host record.

getVirtualLicenses

Retrieve information regarding a piece of hardware's virtual software licenses.

getVirtualRack

Retrieve information regarding the bandwidth allotment to which a piece of hardware belongs.

getVirtualRackId

Retrieve the name of the bandwidth allotment belonging to a piece of hardware.

getVirtualRackName

Retrieve the name of the bandwidth allotment belonging to a piece of hardware.

getVirtualizationPlatform

Retrieve a piece of hardware's virtualization platform software.

importVirtualHost

attempt to import the host record for the virtualization platform running on a server

isPingable

Verifies whether or not a server is pingable.

ping

Issues ping command.

powerCycle

Issues power cycle to server.

powerOff

Power off server.

powerOn

Power on server.

rebootDefault

Reboot the server via the default method.

rebootHard

Reboot the server via “hard” reboot.

rebootSoft

Execute a soft reboot to the server.

removeAccessToNetworkStorage

Remove access to a SoftLayer_Network_Storage volume from this device.

removeAccessToNetworkStorageList

Remove access to multiple SoftLayer_Network_Storage volumes from this device.

removeTags

Remove a tag reference

updateIpmiPassword

Update the root IPMI user password