SoftLayer_Hardware_Router


SoftLayer_Hardware_Router

Description

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

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.

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

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.

getAntivirusSpywareSoftwareComponent

Information regarding an antivirus/spyware software component object.

getAttachedNetworkStorages

Return a list of SoftLayer_Network_Storage volumes authorized to this device.

getAttributes

Information regarding a piece of hardware’s specific attributes.

getAvailableBillingTermChangePrices

Retrieves a list of available term prices available to this of hardware.

getAvailableNetworkStorages

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

getAverageDailyPublicBandwidthUsage

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

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

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.

getBoundSubnets

Associated subnets for a router object.

getBusinessContinuanceInsuranceFlag

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

getChildrenHardware

Child hardware.

getComponents

A piece of hardware’s components.

getContinuousDataProtectionSoftwareComponent

A continuous data protection/server backup software component object.

getCreateObjectOptions

Determine options available when creating a server

getCurrentBillableBandwidthUsage

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

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

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

getFrontendNetworkComponents

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

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

Retrieves bandwidth hourly over a 24-hour period for the specified 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.

getIsCloudReadyNodeCertified

Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute.

getLastTransaction

Information regarding the last transaction a server performed.

getLatestNetworkMonitorIncident

A piece of hardware’s latest network monitoring incident.

getLocalDiskStorageCapabilityFlag

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

getLocation

Where a piece of hardware is located within SoftLayer’s location hierarchy.

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.

getMonitoringServiceComponent

Information regarding a piece of hardware’s network monitoring services.

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).

getNvRamCapacity

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

getObject

Retrieve a SoftLayer_Hardware_Router record.

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 usage.

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 usage.

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.

getResourceGroups

The resource groups in which this hardware is a member.

getRouters

A hardware’s routers.

getSanStorageCapabilityFlag

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

getSecurityScanRequests

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

Information regarding the server room in which the hardware is located.

getServerTemperatureGraphs

Retrieve server’s temperature graphs

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.

getStorageNetworkComponents

A piece of hardware’s private storage network components. [Deprecated]

getTransactionHistory

Get transaction history for a piece of hardware.

getUpgradeItemPrices

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

getUpgradeRequest

An account’s associated upgrade request object, if any.

getUpgradeableActiveComponents

A piece of hardware’s active upgradeable physical components.

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.

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.

getVirtualizationPlatform

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