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 SoftLayer

Connection Parameters

Name
Required?
Description

Username

Required

API Key

Required

Thread Pool Size

Maximum number of threads used to perform collection.

Minimum Event Severity

Events with a severity level below this minimum will not be returned.

Enable HTTP Logging

Whether 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 History

The 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

Name
Description

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.

Id

The 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

Name
Description

End Date

When this event will end.

Id

The id of the Event Notification.

Notification Occurrence Event Type

The type of event such as 'PLANNED' maintenance, `UNPLANNED_INCIDENT', or ANNOUNCEMENT.

Start Date

When this event started.

Subject

Brief description of this event.

Summary First Line

The first line of the summarized details of the event. For the full summary and a list of affected devices access the SoftLayer portal.

Hardware

Name
Description

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 Average

The 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

Datacenter

The datacenter the device resides in

Fully Qualified Domain Name

The FQDN of the device

Hardware Status

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

Hostname

Hostname of the device

Id

The Id of the device

Is Hourly Billed

Whether or not this device is billed on an hourly basis

Is Monitoring Enabled

True only if the monitoring service on this device is enabled.

Largest Single CPU Maximum Utilization

The 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 Status

The status of this device's monitoring agent robot.

Network Status

Network status of hardware

Primary Backend IP Address

Primary backend IP address of the device

Primary Public IP Address

Primary 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

Name
Description

Create Date

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

Id

The 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 Code

An 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

Name
Description

ADC Type

The 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 Limit

The connection limit for this virtual IP address.

Connection Limit Units

The units for the connection limit.

CPU Average

The 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

Datacenter

The datacenter the device resides in

Fully Qualified Domain Name

The FQDN of the device

Hardware Id

The Id of this load balancer's hardware.

Hardware Status

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

Hostname

Hostname of the device

Id

The Id of the device

IP Address

The IP address of this load balancer.

Is High Availability

Denotes whether the virtual IP is configured within a high availability cluster.

Is Hourly Billed

Whether or not this device is billed on an hourly basis

Is Monitoring Enabled

True only if the monitoring service on this device is enabled.

Is SSL Active

Determines if the VIP currently has SSL acceleration enabled.

Is SSL Enabled

Determines if the VIP is allowed to utilize SSL acceleration.

Largest Single CPU Maximum Utilization

The 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 Status

The status of this device's monitoring agent robot.

Network Status

Network status of hardware

Primary Backend IP Address

Primary backend IP address of the device

Primary Public IP Address

Primary 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

Name
Description

Active Connections

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

Datacenter

Datacenter, where load balancer is located

Description

Description of this load balancer.

Hostname

Address (Host name) of a load balancer.

Members Down

Number of members in DOWN health state.

Members Up

Number of members in UP health state.

Name

The name of this load balancer

Operating Status

The operation status 'ONLINE' or 'OFFLINE' of a load balancer.

Provisioning Status

The provisioning status of a load balancer.

Throughput (Bits per Second)

The rate of total throughput of this service.

UUID

The UUID of this load balancer.

Monitoring Agent

Name
Description

Configuration Template Name

The name of the configuration template currently in use by this monitoring agent.

Device Id

A foreign key. The Id of the device this agent is monitoring

Id

The internal identifier of the monitoring agent.

Name

The name of this monitoring agent.

Status

The status of this monitoring agent.

Network Storage

Name
Description

Capacity (Gigabytes)

A Storage account's capacity.

Description

A description of the Storage object.

File Mount Address

The NFS Network Mount Address Name for a given File Storage Volume.

Id

The internal identifier of the network storage.

NAS Type

A Storage account's type. Valid examples are "NAS", "LOCKBOX", "ISCSI", "EVAULT", and "HUB".

Provisioned IOPS

The number of IOPs provisioned for this volume.

Storage Tier Level

A 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

Name
Description

Address Space

Identifier which distinguishes whether the subnet is public or private address space.

Broadcast Address

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

CIDR

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

Gateway

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

Id

The internal identifier of the subnet.

Netmask

A 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 Identifier

A subnet's network identifier. This is the first IP address of a subnet and may not be assigned to a network interface.

Subnet Type

A 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 Addresses

The number of IP addresses contained within this subnet.

Version

This is the Internet Protocol version. Current values may be either 4 or 6.

VLAN Id

A subnet's associated VLAN's internal identifier.

Virtual Guest

Name
Description

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 Average

The average CPU usage across all cores for the time interval ending at the reported timestamp. The value is in the closed interval [0,1].

Datacenter

The datacenter the device resides in

Dedicated Host

The dedicated host associated with this guest

Fully Qualified Domain Name

The FQDN of the device

Hostname

Hostname of the device

Id

The Id of the device

Is Hourly Billed

Whether or not this device is billed on an hourly basis

Is Monitoring Enabled

True only if the monitoring service on this device is enabled.

Is Over Allocation

Whether the bandwidth usage for this computing instance for the current billing cycle exceeds the allocation.

Is Projected To Be Over Allocation

Whether 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 Utilization

The 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 State

The 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 Available

The 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 Status

The status of this device's monitoring agent robot.

Operating System Name

Operating system name.

Operating System Version

Operating system version

Power State

The 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 Address

Primary backend IP address of the device

Primary Public IP Address

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

Status

Status 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

Name
Description

Id

The id of the VLAN.

Network Space

Identifier to denote whether a VLAN is used for public or private connectivity.

Primary Router Datacenter Name

The name of the datacenter where this VLAN's primary router is located.

Primary Router Id

The Id of this VLAN's primary router.

Primary Subnet Id

A 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 Id

The 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 Number

A 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