Bindplane

The Bindplane Developer Hub

Welcome to the Bindplane developer hub. You'll find comprehensive guides and documentation to help you start working with Bindplane as quickly as possible, as well as support if you get stuck. Let's jump right in!

IBM Cloud

Monitor IBM Cloud Performance and Services

Data Collection Setup

Collect metrics via the SoftLayer REST API from the IBM Cloud

Network Requirements

Port: 443 (TCP) to https://api.softlayer.com

Example REST API Call

https://api.softlayer.com/rest/v3.1/

Example Test connection to the IBM Cloud API

Least Privileged User

Login as your IBM Cloud User and then find or generate the API Username and Key using the following instructions:

API Keys When managing your environment using the SoftLayer Customer Portal:

Using an existing API Key

  • Access the customer portal by using your unique credentials.
  • Select Account > Users > User List from the menu bar.
  • In the User List choose View under the API Key column for the user you will be using.
  • Use the information after "API Key for" as the Username and the line below as the API Key as in the example below.

Screen Shot of Username and API Key when using http://control.softlayer.com/

Creating a New API Key

  • Access the customer portal by using your unique credentials.
  • Select Account > Users > User List from the menu bar.
  • In the User List choose Generate under the API Key column for the user you will be using.

Click Generate to create a new API Key

  • In the User List choose View under the API Key column for the user you will be using.
  • Use the information after "API Key for" as the Username and the line below as the API Key as in the example below.

Screen Shot of Username and API Key when using http://control.softlayer.com/

API Keys When managing your environment using the IBM Cloud Portal:

Login as your IBM Cloud User and find or generate the API Username and Key using the following instructions:

Using an existing API Key

  • Access the customer portal by using your unique credentials.
  • From the navigation bar select Manage > Access (IAM).

IBM Cloud Control Panel Access (IAM)

  • From the Access (IAM) menu on right choose IBM Cloud API Keys.
  • Click the ellipsis at the end of the "Classic infrastructure API key" row.
  • From pop up menu choose Details.
  • Copy the "API user name" and the "API Key" into your BindPlane configuration.

Creating a New API Key

  • Access the customer portal by using your unique credentials.
  • From the navigation bar select Manage > Access (IAM).
  • From the Access (IAM) menu on right choose IBM Cloud API Keys.
  • Click the "Create a classic infrastructure API Key" and close the box with the API Key
  • Click the ellipsis at the end of the "Classic infrastructure API key" row.
  • From pop up menu choose Details.
  • Copy the "API user name" and the "API Key" into your BindPlane configuration.

For more information on user creation see: Managing Access to Resources

For more information around the Access Key generation, see: SoftLayer API

For more information on IBM Cloud API Keys see: Managing user API Keys

Connection Parameters

NameRequired?Description
UsernameRequired
API KeyRequired
Thread Pool SizeMaximum number of threads used to perform collection.
Minimum Event SeverityEvents with a severity level below this minimum will not be returned.
Enable HTTP LoggingWhether or not to output the http requests/responses to a log file.
Resource Level Timeout (seconds)The number of seconds to wait for all API calls for a single resource to complete.
Minutes to Go Back for Alarm HistoryThe number of minutes to subtract from the current time to determine a value to use as a lower bound on the query for monitoring alarm history. Note that the offset between the local timezone and UTF-6 should be added to the actual number of minutes desired.

Metrics

Account

NameDescription
Balance (United States Dollars)The account balance of a SoftLayer customer account. An account's balance is the amount of money owed to SoftLayer by the account holder, returned as a floating point number with two decimal places, measured in US Dollars ($USD). A negative account balance means the account holder has overpaid and is owed money by SoftLayer.
IdThe account id.
Next Invoice Total Amount (United States Dollars)The pre-tax total amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.
Next Invoice Total One Time Amount (United States Dollars)The total one-time charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.
Next Invoice Total One Time Tax Amount (United States Dollars)The total one-time tax amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.
Next Invoice Total Recurring Amount (United States Dollars)The total recurring charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.
Next Invoice Total Recurring Tax Amount (United States Dollars)The total recurring tax amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.

Event Notification

NameDescription
End DateWhen this event will end.
IdThe id of the Event Notification.
Notification Occurrence Event TypeThe type of event such as 'PLANNED' maintenance, `UNPLANNED_INCIDENT', or ANNOUNCEMENT.
Start DateWhen this event started.
SubjectBrief description of this event.
Summary First LineThe first line of the summarized details of the event. For the full summary and a list of affected devices access the SoftLayer portal.

Hardware

NameDescription
Average Daily Usage (Gigabytes)The daily average public bandwidth usage for current billing cycle
Average Memory Usage (Bytes)The average memory used during the time interval ending at the reported timestamp.
Bandwidth Allocation (Gigabytes)The amount of bandwidth allocated for this device
CPU AverageThe average CPU usage across all cores for the time interval ending at the reported timestamp. The value is in the closed interval [0,1].
Current Billable Bandwidth Usage (Gigabytes)The current billable public outbound bandwidth for this hardware for the current billing cycle
DatacenterThe datacenter the device resides in
Fully Qualified Domain NameThe FQDN of the device
Hardware StatusStatus of hardware. Possible values include'ACTIVE': This server is active and in use.
'DEPLOY': Used during server provisioning.
'DEPLOY2': Used during server provisioning.
'MACWAIT': Used during server provisioning.
'RECLAIM': This server has been reclaimed by SoftLayer and is awaiting de-provisioning.
HostnameHostname of the device
IdThe Id of the device
Is Hourly BilledWhether or not this device is billed on an hourly basis
Is Monitoring EnabledTrue only if the monitoring service on this device is enabled.
Largest Single CPU Maximum UtilizationThe value of the highest reported CPU utilization of any single CPU during the time interval ending at the reported timestamp. The value is in the closed interval [0,1]
Maximum Memory Usage (Bytes)The maximum memory used during the time interval ending at the reported timestamp.
Memory Capacity (Gigabytes)The amount of memory a piece of hardware has in Gigabytes
Monitoring Agent Robot StatusThe status of this device's monitoring agent robot.
Network StatusNetwork status of hardware
Primary Backend IP AddressPrimary backend IP address of the device
Primary Public IP AddressPrimary public IP address of the device
Private In Throughput (Kilobits per Second)The rate of inbound private packets.
Private Out Throughput (Kilobits per Second)The rate of outbound private packets.
Public In Throughput (Kilobits per Second)The rate of inbound public packets.
Public Out Throughput (Kilobits per Second)The rate of outbound public packets.

Invoice

NameDescription
Create DateThe date (dd-MMM-yyyy) this invoice was created. This is also typically the same date of each month and corresponds to the account's anniversary. If the date falls on a date not existent in a month such as 31, then the last day of the month is used.
Ending Balance (United States Dollars)A SoftLayer account's balance at the time an invoice is closed. This value is measured in US Dollar ($USD) currency.
IdThe id of the invoice.
Invoice Total Amount (United States Dollars)The total amount of this invoice in US Dollars ($USD).
Invoice Total One Time Amount (United States Dollars)The total one-time charges for this invoice. This is the sum of one-time charges + setup fees + labor fees. This does not include taxes.
Invoice Total One Time Tax Amount (United States Dollars)A sum of all the taxes related to one time charges for this invoice.
Invoice Total Recurring Amount (United States Dollars)The total Recurring amount of this invoice. This amount does not include taxes or one time charges.
Invoice Total Recurring Tax Amount (United States Dollars)The total amount of the recurring taxes on this invoice.
Payment (United States Dollars)The total payment made on this invoice in US Dollars ($USD).
Starting Balance (United States Dollars)An SoftLayer account's balance at the time an invoice is created. This value is measured in US Dollar ($USD) currency.
Status CodeAn invoice's status. The "OPEN" status means SoftLayer has not yet received payment for this invoice. "CLOSED" status means that SoftLayer has received payment and closed the invoice. The "CLOSED_FAILED" status code means SoftLayer closed the invoice without receiving a payment. Invoices are usually set to CLOSED_FAILED status in cases where customer accounts are terminated for non-payment.

Load Balancer

NameDescription
ADC TypeThe type of Application Delivery Controller used by this load balancer.
Average Daily Usage (Gigabytes)The daily average public bandwidth usage for current billing cycle
Average Memory Usage (Bytes)The average memory used during the time interval ending at the reported timestamp.
Bandwidth Allocation (Gigabytes)The amount of bandwidth allocated for this device
Connection LimitThe connection limit for this virtual IP address.
Connection Limit UnitsThe units for the connection limit.
CPU AverageThe average CPU usage across all cores for the time interval ending at the reported timestamp. The value is in the closed interval [0,1].
Current Billable Bandwidth Usage (Gigabytes)The current billable public outbound bandwidth for this hardware for the current billing cycle
DatacenterThe datacenter the device resides in
Fully Qualified Domain NameThe FQDN of the device
Hardware IdThe Id of this load balancer's hardware.
Hardware StatusStatus of hardware. Possible values include'ACTIVE': This server is active and in use.
'DEPLOY': Used during server provisioning.
'DEPLOY2': Used during server provisioning.
'MACWAIT': Used during server provisioning.
'RECLAIM': This server has been reclaimed by SoftLayer and is awaiting de-provisioning.
HostnameHostname of the device
IdThe Id of the device
IP AddressThe IP address of this load balancer.
Is High AvailabilityDenotes whether the virtual IP is configured within a high availability cluster.
Is Hourly BilledWhether or not this device is billed on an hourly basis
Is Monitoring EnabledTrue only if the monitoring service on this device is enabled.
Is SSL ActiveDetermines if the VIP currently has SSL acceleration enabled.
Is SSL EnabledDetermines if the VIP is allowed to utilize SSL acceleration.
Largest Single CPU Maximum UtilizationThe value of the highest reported CPU utilization of any single CPU during the time interval ending at the reported timestamp. The value is in the closed interval [0,1]
Maximum Memory Usage (Bytes)The maximum memory used during the time interval ending at the reported timestamp.
Memory Capacity (Gigabytes)The amount of memory a piece of hardware has in Gigabytes
Monitoring Agent Robot StatusThe status of this device's monitoring agent robot.
Network StatusNetwork status of hardware
Primary Backend IP AddressPrimary backend IP address of the device
Primary Public IP AddressPrimary public IP address of the device
Private In Throughput (Kilobits per Second)The rate of inbound private packets.
Private Out Throughput (Kilobits per Second)The rate of outbound private packets.
Public In Throughput (Kilobits per Second)The rate of inbound public packets.
Public Out Throughput (Kilobits per Second)The rate of outbound public packets.

Load Balancer as a Service

NameDescription
Active ConnectionsNumber of total active established connections.
Connection Rate (Connections per Second)Number of connections per second
Data Processed By Month (Megabytes)The total of all throughput in and out.
DatacenterDatacenter, where load balancer is located
DescriptionDescription of this load balancer.
HostnameAddress (Host name) of a load balancer.
Members DownNumber of members in DOWN health state.
Members UpNumber of members in UP health state.
NameThe name of this load balancer
Operating StatusThe operation status 'ONLINE' or 'OFFLINE' of a load balancer.
Provisioning StatusThe provisioning status of a load balancer.
Throughput (Bits per Second)The rate of total throughput of this service.
UUIDThe UUID of this load balancer.

Monitoring Agent

NameDescription
Configuration Template NameThe name of the configuration template currently in use by this monitoring agent.
Device IdA foreign key. The Id of the device this agent is monitoring
IdThe internal identifier of the monitoring agent.
NameThe name of this monitoring agent.
StatusThe status of this monitoring agent.

Network Storage

NameDescription
Capacity (Gigabytes)A Storage account's capacity.
DescriptionA description of the Storage object.
File Mount AddressThe NFS Network Mount Address Name for a given File Storage Volume.
IdThe internal identifier of the network storage.
NAS TypeA Storage account's type. Valid examples are "NAS", "LOCKBOX", "ISCSI", "EVAULT", and "HUB".
Provisioned IOPSThe number of IOPs provisioned for this volume.
Storage Tier LevelA Tier Level of the Storage object, e.g. LOW_INTENSITY_TIER.
Total Used Space (Bytes)The amount of space used by the volume.
Used Space (Bytes)The amount of space used by the volume.

Subnet

NameDescription
Address SpaceIdentifier which distinguishes whether the subnet is public or private address space.
Broadcast AddressThe last IP address in a subnet is the subnet's broadcast address. This is an IP address that will broadcast network requests to the entire subnet and may not be assigned to a network interface.
CIDRA subnet's Classless Inter-Domain Routing prefix. This is a number between 0 and 32 signifying the number of bits in a subnet's netmask. These bits separate a subnet's network address from it's host addresses. It performs the same function as the netmask property, but is represented as an integer.
GatewayA subnet's gateway address. This is an IP address that belongs to the router on the subnet and may not be assigned to a network interface.
IdThe internal identifier of the subnet.
NetmaskA bitmask in dotted-quad format that is used to separate a subnet's network address from it's host addresses. This performs the same function as the cidr property, but is expressed in a string format.
Network IdentifierA subnet's network identifier. This is the first IP address of a subnet and may not be assigned to a network interface.
Subnet TypeA subnet can be one of several types. PRIMARY, ADDITIONAL_PRIMARY, SECONDARY, ROUTED_TO_VLAN, SECONDARY_ON_VLAN, STORAGE_NETWORK, and STATIC_IP_ROUTED. A "PRIMARY" subnet is the primary network bound to a VLAN within the softlayer network. An "ADDITIONAL_PRIMARY" subnet is bound to a network VLAN to augment the pool of available primary IP addresses that may be assigned to a server. A "SECONDARY" subnet is any of the secondary subnet's bound to a VLAN interface. A "ROUTED_TO_VLAN" subnet is a portable subnet that can be routed to any server on a vlan. A "SECONDARY_ON_VLAN" subnet also doesn't exist as a VLAN interface, but is routed directly to a VLAN instead of a single IP address by SoftLayer's routers.
Total IP AddressesThe number of IP addresses contained within this subnet.
VersionThis is the Internet Protocol version. Current values may be either 4 or 6.
VLAN IdA subnet's associated VLAN's internal identifier.

Virtual Guest

NameDescription
Average Daily Private Bandwidth Usage (Gigabytes)The average daily private bandwidth usage for the current billing cycle.
Average Daily Public Bandwidth Usage (Gigabytes)The average daily public bandwidth usage for the current billing cycle
Average Memory Usage (Bytes)The average memory used during the time interval ending at the reported timestamp.
Bandwidth Allocation (Gigabytes)The amount of bandwidth allocated for this device
CPU AverageThe average CPU usage across all cores for the time interval ending at the reported timestamp. The value is in the closed interval [0,1].
DatacenterThe datacenter the device resides in
Dedicated HostThe dedicated host associated with this guest
Fully Qualified Domain NameThe FQDN of the device
HostnameHostname of the device
IdThe Id of the device
Is Hourly BilledWhether or not this device is billed on an hourly basis
Is Monitoring EnabledTrue only if the monitoring service on this device is enabled.
Is Over AllocationWhether the bandwidth usage for this computing instance for the current billing cycle exceeds the allocation.
Is Projected To Be Over AllocationWhether the bandwidth usage for this computing instance for the current billing cycle is projected to exceed the allocation based on daily average usage.
Largest Single CPU Maximum UtilizationThe value of the highest reported CPU utilization of any single CPU during the time interval ending at the reported timestamp. The value is in the closed interval [0,1]
Last Known Power StateThe last known power state of a virtual guest in the event the guest is turned off outside of IMS or has gone offline.
Maximum CPU AvailableThe maximum amount of CPU resources a computing instance may utilize. Typically the number of cores.
Maximum Memory Available (Megabytes)The maximum amount of memory available.
Maximum Memory Usage (Bytes)The maximum memory used during the time interval ending at the reported timestamp.
Monitoring Agent Robot StatusThe status of this device's monitoring agent robot.
Operating System NameOperating system name.
Operating System VersionOperating system version
Power StateThe current power state of this virtual guest. Values Include
'Halted': This virtual guest power state is Powered off
'Running': This virtual guest power state is Powered on
'Paused': This virtual guest has been paused
'Suspended': This status is set before the VSI is deleted
'Unknown':
Primary Backend IP AddressPrimary backend IP address of the device
Primary Public IP AddressPrimary public IP address of the device
Private In Throughput (Kilobits per Second)The rate of inbound private packets.
Private Out Throughput (Kilobits per Second)The rate of outbound private packets.
Projected Public Bandwidth Usage (Gigabytes)The projected public outbound bandwidth for this computing instance for the current billing cycle, using a basic average calculation of daily usage
Public In Throughput (Kilobits per Second)The rate of inbound public packets.
Public Out Throughput (Kilobits per Second)The rate of outbound public packets.
StatusStatus of virtual guest. Possible values include
'ACTIVE': The virtual guest is active and in use.
'DISABLED': The virtual guest is disabled.
'INACTIVE': The virtual guest is inactive.
'DELETED': The virtual guest has been reclaimed.
'ACTIVE UTILITY': This is for Net Scalers.
'DISCONNECTED': This is used when the network interfaces were disconnected for security reasons.
'RESOURCE RESERVE': This is used when an order has been placed, an instance is reserved, after that, it?s removed.

VLAN

NameDescription
IdThe id of the VLAN.
Network SpaceIdentifier to denote whether a VLAN is used for public or private connectivity.
Primary Router Datacenter NameThe name of the datacenter where this VLAN's primary router is located.
Primary Router IdThe Id of this VLAN's primary router.
Primary Subnet IdA VLAN's primary subnet. Each VLAN has at least one subnet, usually the subnet that is assigned to a server or new IP address block when it's purchased.
Secondary Router IdThe id of the secondary router that a VLAN is associated with. Every SoftLayer VLAN is connected to more than one router for greater network redundancy.
VLAN NumberA VLAN's number as recorded within the SoftLayer network. This is configured directly on SoftLayer's networking equipment and should not be confused with a VLAN's id property

Updated 8 months ago

IBM Cloud


Monitor IBM Cloud Performance and Services

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.