ballerinax/bmc.truesightpresentationserver Ballerina library

1.5.2

Overview

The BMC Hardware Sentry TrueSight Presentation Server API v1.0 connector(https://docs.bmc.com/docs/display/tsps107/Getting+started) OpenAPI specification.

The BMC Hardware Sentry TrueSight Presentation Server API provides the capability to access data from various TrueSight products to provide a consolidated set of views for monitoring the infrastructure, real and synthetic applications, and capacity planning.

Key Features

Programmatic access to create and manage resources via REST API
Manage user accounts and profiles
Secure authentication with API key or OAuth support

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Create a user account.
Obtaining tokens
1. Obtain your token by following this link.

Clients

bmc.truesightpresentationserver: Client

Isolated

This is a generated connector for BMC Hardware Sentry TrueSight Presentation Server REST API v1.0 OpenAPI specification.
The BMC Hardware Sentry TrueSight Presentation Server API provides the capability to access data from various TrueSight products to provide a consolidated set of views for monitoring the infrastructure, real and synthetic applications, and capacity planning.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create a user account in BMC Hardware Sentry TrueSight Presentation Server and obtain tokens following this guide.

init (ApiKeysConfig apiKeyConfig, string serviceUrl, ConnectionConfig config)

apiKeyConfig ApiKeysConfig - API keys for authorization

serviceUrl string - URL of the target service

config ConnectionConfig {} - The configurations to be used when initializing the connector

collectNow

Isolated FunctionRemote Function

function collectNow(int deviceId, string monitorClass) returns ActionResponse|error

Triggers a new collect on a specific device.

Parameters

deviceId int - The ID of the device.

monitorClass string - The Monitor Class of the device.

Return Type

ActionResponse|error - Successful operation

rediscover

Isolated FunctionRemote Function

function rediscover(int deviceId) returns ActionResponse|error

Triggers a new discovery on a specific device.

Parameters

deviceId int - The ID of the device.

Return Type

ActionResponse|error - Successful operation

reinitialize

Isolated FunctionRemote Function

function reinitialize(int deviceId, ReinitializeActionConfiguration payload) returns ActionResponse|error

Sends a 'Reinitialize KM' command.

Parameters

deviceId int - The ID of the device.

payload ReinitializeActionConfiguration - The request body as a JSON payload.

Return Type

ActionResponse|error - Successful operation

remove

Isolated FunctionRemote Function

function remove(int deviceId, string monitorClass, string monitorSid) returns ActionResponse|error

Removes a specific instance from the monitoring environment.

Parameters

deviceId int - The ID of the device.

monitorClass string - The Monitor Class of the device.

monitorSid string - The Monitor SID of the device.

Return Type

ActionResponse|error - Successful operation

reset

Isolated FunctionRemote Function

function reset(int deviceId, string monitorClass, string monitorSid) returns ActionResponse|error

Resets the Error Count parameter.

Parameters

deviceId int - The ID of the device.

monitorClass string - The Monitor Class of the device.

monitorSid string - The Monitor SID of the device.

Return Type

ActionResponse|error - Successful operation

getApplications

Isolated FunctionRemote Function

function getApplications(string page, int 'limit, string direction, string sort) returns ResultPage|error

Gets summarized information about all monitored applications.

Parameters

page string (default "0") - The page number to retrieve (first page is 0).

'limit int (default 100) - The maximum number of entries per page.

direction string (default "asc") - The sorting order (case insensitive).

sort string (default "name") - The column to sort by (case insensitive).

Return Type

ResultPage|error - Successful operation

getOneApplication

Isolated FunctionRemote Function

function getOneApplication(string applicationId) returns ApplicationSummary|error

Gets detailed information for a specific application.

Parameters

applicationId string - The ID of the application.

Return Type

ApplicationSummary|error - Successful operation

getDeviceMonitors

Isolated FunctionRemote Function

function getDeviceMonitors(int deviceId) returns Response|error

Gets the Monitors for a specific device.

Parameters

deviceId int - The ID of the device.

Return Type

Response|error - Successful operation

getDevices

Isolated FunctionRemote Function

function getDevices(string page, int 'limit, string direction, string sort, string? groupId, string? applicationId, string? serviceId) returns ResultPage|error

Gets summarized information about all monitored devices.

Parameters

page string (default "0") - The page number to retrieve (first page is 0).

'limit int (default 100) - The maximum number of entries per page.

direction string (default "asc") - The sorting order (case insensitive).

sort string (default "name") - The column to sort by (case insensitive).

groupId string? (default ()) - The ID of the group.

applicationId string? (default ()) - The ID of the application.

serviceId string? (default ()) - The ID of the service.

Return Type

ResultPage|error - Successful operation

getDevicesSummary

Isolated FunctionRemote Function

function getDevicesSummary() returns GlobalSummary|error

Gets overall information for all devices.

Return Type

GlobalSummary|error - Successful operation

getDevice

Isolated FunctionRemote Function

function getDevice(int deviceId) returns DeviceSummary|error

Gets detailed information about a specific device.

Parameters

deviceId int - The ID of the device.

Return Type

DeviceSummary|error - Successful operation

getDeviceAgent

Isolated FunctionRemote Function

function getDeviceAgent(int deviceId) returns DeviceAgent|error

Gets detailed information about an Agent.

Parameters

deviceId int - The ID of the device.

Return Type

DeviceAgent|error - Successful operation

getAgentDevices

Isolated FunctionRemote Function

function getAgentDevices(int deviceId) returns ResultPage|error

Gets a list of all the devices monitored by an Agent.

Parameters

deviceId int - The ID of the device.

Return Type

ResultPage|error - Successful operation

getDeviceParameterHistory

Isolated FunctionRemote Function

function getDeviceParameterHistory(int deviceId, string parameterName, string monitorType, int? 'from, int? to, string? monitorSid) returns ResultPage|error

Gets data history for a parameter of a specific device over a given period.

Parameters

deviceId int - The ID of the device.

parameterName string - The name of the parameter.

monitorType string - The unique name of the Monitor type.

'from int? (default ()) - Beginning of the period (Epoch time, in seconds).

to int? (default ()) - End of the period (Epoch time, in seconds).

monitorSid string? (default ()) - The Monitor SID (to filter the list of Monitors).

Return Type

ResultPage|error - Successful operation

getDeviceEnergyUsage

Isolated FunctionRemote Function

function getDeviceEnergyUsage(int deviceId, string rollPeriod, string basis) returns ResultPage|error

Gets the energy usage for a specific device and a given period.

Parameters

deviceId int - The ID of the device.

rollPeriod string (default "ONE_DAY") - The period for which you wish to retrieve energy usage data.

basis string (default "HOURLY") - Subdivision of the period for which you wish to retrieve energy usage data.

Return Type

ResultPage|error - Successful operation

getGroups

Isolated FunctionRemote Function

function getGroups(string page, int 'limit, string direction, string sort) returns ResultPage|error

Gets all group summaries.

Parameters

page string (default "0") - The page number to retrieve (first page is 0).

'limit int (default 100) - The maximum number of entries per page.

direction string (default "asc") - The sorting order (case insensitive).

sort string (default "name") - The column to sort by (case insensitive).

Return Type

ResultPage|error - Successful operation

getOneGroup

Isolated FunctionRemote Function

function getOneGroup(string groupId) returns GroupSummary|error

Gets detailed information about a specific group.

Parameters

groupId string - The ID of the group.

Return Type

GroupSummary|error - Successful operation

updateEnergyCost

Isolated FunctionRemote Function

function updateEnergyCost(string groupId, GroupConfiguration payload) returns GlobalSummary|error

Updates the values of the energy footprint parameter for a specific group.

Parameters

groupId string - The ID of the group.

payload GroupConfiguration - The values you wish to assign.

Return Type

GlobalSummary|error - Successful operation

getHeatingMarginCoverage

Isolated FunctionRemote Function

function getHeatingMarginCoverage(boolean covered, string page, int 'limit, string direction, string sort, string? groupId, string? applicationId, string? serviceId) returns ResultPage|error

Gets the heating margin values for each monitored device, when available.

Parameters

covered boolean (default true) - If set to true, only gets devices whose heating margin information is available. Otherwise, gets any other devices.

page string (default "0") - The page number to retrieve (first page is 0).

'limit int (default 100) - The maximum number of entries per page.

direction string (default "asc") - The sorting order (case insensitive).

sort string (default "name") - The column to sort by (case insensitive).

groupId string? (default ()) - The ID of the group.

applicationId string? (default ()) - The ID of the application.

serviceId string? (default ()) - The ID of the service.

Return Type

ResultPage|error - Successful operation

getHistory

Isolated FunctionRemote Function

function getHistory(string? groupId, string? applicationId, string? serviceId, int? 'from, int? to) returns ResultPage|error

Gets historical data for a specific group, application or service.

Parameters

groupId string? (default ()) - The ID of the group.

applicationId string? (default ()) - The ID of the application.

serviceId string? (default ()) - The ID of the service.

'from int? (default ()) - Beginning of the period (Epoch time, in seconds).

to int? (default ()) - End of the period (Epoch time, in seconds).

Return Type

ResultPage|error - Successful operation

searchDevices

Isolated FunctionRemote Function

function searchDevices(string searchTerms, string? groupId, string? applicationId, string? serviceId, string page, int 'limit) returns ResultPage|error

Searches devices by name, model, manufacturer or serial number.

Parameters

searchTerms string - Space-separated search criteria.

groupId string? (default ()) - The ID of the group.

applicationId string? (default ()) - The ID of the application.

serviceId string? (default ()) - The ID of the service.

page string (default "0") - The page number to retrieve (first page is 0).

'limit int (default 100) - The maximum number of entries per page.

Return Type

ResultPage|error - Successful operation

getServices

Isolated FunctionRemote Function

function getServices(string page, int 'limit, string direction, string sort) returns ResultPage|error

Gets summarized information about all monitored services.

Parameters

page string (default "0") - The page number to retrieve (first page is 0).

'limit int (default 100) - The maximum number of entries per page.

direction string (default "asc") - The sorting order (case insensitive).

sort string (default "name") - The column to sort by (case insensitive).

Return Type

ResultPage|error - Successful operation

getOneService

Isolated FunctionRemote Function

function getOneService(string serviceId) returns ServiceSummary|error

Gets detailed information about a specific service.

Parameters

serviceId string - The ID of the service.

Return Type

ServiceSummary|error - Successful operation

Records

bmc.truesightpresentationserver: ActionResponse

The object encapsulating the output of an operation affecting the PATROL Agent.

Fields

pslOutput? string - The output of the underlying PSL operation.

bmc.truesightpresentationserver: ApiKeysConfig

Closed record

Provides API key configurations needed when communicating with a remote HTTP endpoint.

Fields

authorization string - Represents API Key Authorization

bmc.truesightpresentationserver: ApplicationSummary

Fields

id? string - The ID of the application.

name? string - The name of the application.

deviceSummaries? DeviceSummary[] - The list of devices attached to the application. Note: when using the Applications service, this list is always empty. It is populated only when using the Application Details service.

totalPowerConsumption? decimal - The total power consumption of the devices attached to the application.

totalPowerConsumptionUnit? string - The unit in which the total power consumption of the devices attached to the application is being expressed.

heatingMargin? decimal - The lowest heating margin among the heating margins of the devices attached to the application. Note:This field will only be present if a value could be found.

heatingMarginUnit? string - The unit in which the heating margin of the application is being expressed.

heatingMarginDeviceName? string - The name of the device having the lowest heating margin. Note:This field will only be present if a value could be found.

heatingMarginDeviceUrl? string - The link to the details of the device having the lowest heating margin. Note:This field will only be present if a value could be found.

heatingMarginCoverage? decimal - The percentage of devices attached to the application, whose heating margin could be found. Note:This field will only be present if a value could be found.

oneDayEnergyConsumption? decimal - The quantity of energy consumed by the devices attached to the application during one day.

oneDayCost? decimal - The daily cost of the energy consumed by the devices attached to the application. Note:This field will only be present if a value could be computed.

oneDayEmittedCo2? decimal - The quantity of CO2 emitted by the devices attached to the application during one day. Note:This field will only be present if a value could be computed.

oneDayConfidence? decimal - The confidence score (percentage) for the daily energy consumption, energy cost and CO2 emission values. The lower the confidence score, the more extrapolated the values are.

oneMonthEnergyConsumption? decimal - The quantity of energy consumed by the devices attached to the application during one month.

oneMonthCost? decimal - The monthly cost of the energy consumed by the devices attached to the application. Note:This field will only be present if a value could be computed.

oneMonthEmittedCo2? decimal - The quantity of CO2 emitted by the devices attached to the application during one month. Note:This field will only be present if a value could be computed.

oneMonthConfidence? decimal - The confidence score (percentage) for the monthly energy consumption, energy cost and CO2 emission values. The lower the confidence score, the more extrapolated the values are.

oneYearEnergyConsumption? decimal - The quantity of energy consumed by the devices attached to the application during one year.

oneYearCost? decimal - The yearly cost of the energy consumed by the devices attached to the application. Note:This field will only be present if a value could be computed.

oneYearEmittedCo2? decimal - The quantity of CO2 emitted by the devices attached to the application in one year. Note:This field will only be present if a value could be computed.

oneYearConfidence? decimal - The confidence score (percentage) for the yearly energy consumption, energy cost and CO2 emission values. The lower the confidence score, the more extrapolated the values are.

updateTimestamp? int - The data collection time (as an Epoch time, in seconds).

url? string - The link to the application details.

numberOfDevices? int - The number of devices attached to the application.

energyConsumptionUnit? string - The unit in which all energy consumption values are being expressed.

costUnit? string - The currency in which all energy cost values are being expressed.

emittedCo2Unit? string - The unit in which all CO2 emission values are being expressed.

historyParentIdKey? string - The name of the key used to identify the application in the history table.

bmc.truesightpresentationserver: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields

keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests

chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

proxy? ProxyConfig - Proxy server related options

bmc.truesightpresentationserver: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields

httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client

http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol

http2Settings? ClientHttp2Settings - Configurations related to HTTP/2 protocol

timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection

forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header

poolConfig? PoolConfiguration - Configurations associated with request pooling

cache? CacheConfig - HTTP caching related configurations

compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header

circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker

retryConfig? RetryConfig - Configurations associated with retrying

responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits

secureSocket? ClientSecureSocket - SSL/TLS-related options

proxy? ProxyConfig - Proxy server related options

validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

bmc.truesightpresentationserver: DeviceAgent

Contains all information regarding a specific PATROL Agent.

Fields

os? string - The operating system the PATROL Agent is running on.

name? string - The FQDN of the PATROL Agent.

'version? string - The version of the PATROL Agent.

port? string - The port the PATROL Agent is running on.

id? string - The ID of the PATROL Agent.

connectionStatus? string - The status of the PATROL Agent's connection.

url? string - The link to the 'Monitors' tab of the PATROL Agent.

bmc.truesightpresentationserver: DeviceSummary

Fields

id? int - The ID of the device.

name? string - The ID of the device.

sid? string - The SID of the device.

serverId? int - The ID of the server the device is attached to.

serverName? string - The name of the server the device is attached to.

agentId? int - The ID of the PATROL Agent the device is attached to.

agentName? string - The name of the PATROL Agent the device is attached to.

powerConsumption? decimal - The power consumption of the device.

powerConsumptionUnit? string - The unit in which the power consumption of the device is being expressed.

heatingMargin? decimal - The heating margin of the device. Note:This field will only be present if a value could be found.

heatingMarginUnit? string - The unit in which the heating margin of the device is being expressed. Note:This field will only be present if a value could be found.

collectTime? string - The collection time of the heating margin (as an Epoch time, in seconds). Note:This field will only be present if a value could be found.

deviceUrl? string - The link to the device details.

updateTimestamp? int - The data collection time (as an Epoch time, in seconds).

ambientTemperature? decimal - The ambient temperature of the device.

'type? string -

deviceTSMOKey? string - The TSMOKey of the device.

productVersion? string - The Hardware Sentry KM version of the device's Monitor. Note:This field will only be present if a value could be found.

bmc.truesightpresentationserver: ErrorResponse

Fields

message? string - The error message.

date? string - The timestamp of the error.

code? string - The error's business identifier.

bmc.truesightpresentationserver: GlobalSummary

Fields

id? string - The ID of the global summary (this ID will always be "global").

totalPowerConsumption? decimal - The total power consumption of all the devices.

heatingMargin? decimal - The lowest heating margin among the heating margins of all the devices. Note:This field will only be present if a value could be found.

heatingMarginCoverage? decimal - The percentage of devices whose heating margin could be found. Note:This field will only be present if a value could be found.

heatingMarginDeviceUrl? string - The link to the details of the device having the lowest heating margin. Note:This field will only be present if a value could be found.

heatingMarginDeviceName? string - The name of the device having the lowest heating margin. Note:This field will only be present if a value could be found.

energyCost? decimal - The electricity rate for all devices. This value can be updated by users with sufficient permissions.

co2Emission? decimal - The CO2 emissions for all devices. This value can be updated by users with sufficient permissions.

groupNameFilter? string - Regular expression used to filter the groups for which the power consumption will be reported.

updateTimestamp? int - The data collection time (as an Epoch time, in seconds).

totalPowerConsumptionUnit? string - The unit in which the total power consumption is being expressed.

heatingMarginUnit? string - The unit in which the heating margin is being expressed.

energyCostUnit? string - The unit in which the electricity rate is being expressed.

co2EmissionUnit? string - The unit in which the CO2 emission is being expressed.

editable? boolean - If true, indicates that you do not have sufficient rights to update the global settings. However, you may still have sufficient rights to update a specific group's setting.

bmc.truesightpresentationserver: GroupConfiguration

The deserialized form of the Energy Footprint Update service's request payload.

Fields

energyCost? decimal - Updates the electricity rate (unit: $/kWh).

co2Emission? decimal - Updates the CO2 emission (unit: kg/kWh).

groupNameFilter? string - Updates the regular expression used to filter the groups for which the power consumption should be reported.

bmc.truesightpresentationserver: GroupSummary

Fields

id? string - The ID of the group.

name? string - The name of the group.

serverId? int - The ID of the server the group is attached to.

deviceSummaries? DeviceSummary[] -

totalPowerConsumption? decimal - The total power consumption of the devices attached to the group.

totalPowerConsumptionUnit? string - The unit in which the total power consumption of the devices attached to the group is being expressed.

heatingMargin? decimal - The lowest heating margin among the heating margins of the devices attached to the group. Note:This field will only be present if a value could be found.

heatingMarginUnit? string - The unit in which the heating margin of the group is being expressed.

heatingMarginDeviceName? string - The name of the device having the lowest heating margin. Note:This field will only be present if a value could be found.

heatingMarginDeviceUrl? string - The link to the details of the device having the lowest heating margin. Note:This field will only be present if a value could be found.

heatingMarginCoverage? decimal - The percentage of devices attached to the group, whose heating margin could be found. Note:This field will only be present if a value could be found.

energyCost? decimal - The electricity rate for all devices attached to the group. This value can be updated by users with sufficient permissions.

co2Emission? decimal - The CO2 emissions for all devices attached to the group. This value can be updated by users with sufficient permissions.

oneDayEnergyConsumption? decimal - The quantity of energy consumed by the devices attached to the group during one day.

oneDayCost? decimal - The daily cost of the energy consumed by the devices attached to the group. Note:This field will only be present if a value could be computed.

oneDayEmittedCo2? decimal - The quantity of CO2 emitted by the devices attached to the group during one day. Note:This field will only be present if a value could be computed.

oneDayConfidence? decimal - The confidence score (percentage) for the daily energy consumption, energy cost and CO2 emission values. The lower the confidence score, the more extrapolated the values are.

oneMonthEnergyConsumption? decimal - The quantity of energy consumed by the devices attached to the group during one month.

oneMonthCost? decimal - The monthly cost of the energy consumed by the devices attached to the group. Note:This field will only be present if a value could be computed.

oneMonthEmittedCo2? decimal - The quantity of CO2 emitted by the devices attached to the group during one month. Note:This field will only be present if a value could be computed.

oneMonthConfidence? decimal - The confidence score (percentage) for the monthly energy consumption, energy cost and CO2 emission values. The lower the confidence score, the more extrapolated the values are.

oneYearEnergyConsumption? decimal - The quantity of energy consumed by the devices attached to the group during one year.

oneYearCost? decimal - The yearly cost of the energy consumed by the devices attached to the group. Note:This field will only be present if a value could be computed.

oneYearEmittedCo2? decimal - The quantity of CO2 emitted by the devices attached to the group in one year. Note:This field will only be present if a value could be computed.

oneYearConfidence? decimal - The confidence score (percentage) for the yearly energy consumption, energy cost and CO2 emission values. The lower the confidence score, the more extrapolated the values are.

updateTimestamp? int - The data collection time (as an Epoch time, in seconds).

url? string - The link to the group details.

numberOfDevices? int - The number of devices attached to the group.

energyCostUnit? string - The unit in which th euser-defined electricity rate value is being expressed.

ambientTemperature? decimal - The average ambient temperature based on the ambient temperatures of the devices attached to the group.

ambientTemperatureUnit? string - The unit in which the ambient temperature value is being expressed.

co2EmissionUnit? string - The unit in which the user-defined CO2 emission value is being expressed.

energyConsumptionUnit? string - The unit in which all energy consumption values are being expressed.

costUnit? string - The currency in which all energy cost values are being expressed.

emittedCo2Unit? string - The unit in which all emitted CO2 quantities are being expressed.

historyParentIdKey? string -

editable? boolean - The name of the key used to identify the group in the history table.

bmc.truesightpresentationserver: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields

host string(default "") - Host name of the proxy server

port int(default 0) - Proxy server port

userName string(default "") - Proxy server username

password string(default "") - Proxy server password

bmc.truesightpresentationserver: ReinitializeActionConfiguration

The deserialized form of the Reinitialize service's request payload.

Fields

resetDiscoveryAndPollingIntervals? int - When set to 1, removes all user-defined frequencies for discovery and polling processes to their default values (respectively 1 hour and 2 minutes).

resetAlertAfterNTimes? int - When set to 1, resets the number of times thresholds can be breached before triggering an alert to their default values (1 time) for numeric, discrete, connector status and present parameters.

resetAlertActions? int - When set to 1, removes all manually set Alert Actions and reverts to basic default actions i.e. trigger a PATROL event and annotate a parameter graph.

resetOtherAlertSettings? int - When set to 1, reverts any manually performed configuration changes to the default Hardware Sentry values.

resetDebugMode? int - When set to 1, deactivates the debug mode when it was manually enabled.

resetRemovedPausedObjectList? int - When set to 1, reactivates the monitoring of all paused or removed objects.

resetReportSettings? int - When set to 1, clears the report schedule.

resetJavaSettings? int - When set to 1, removes the custom Java settings (path and credentials). The KM will try to automatically find a suitable JRE.

resetThresholds? int - When set to 1, resets all thresholds.

bmc.truesightpresentationserver: ResultPage

Encapsulates a list of results.

Fields

items? record {}[] - The list of currently accessible results.

total? int - The total number of accessible results, including the results not listed in items.

restrictedRights? boolean - If true, indicates that you are denied access to part of, or all the results.

bmc.truesightpresentationserver: ServiceSummary

Fields

id? string - The ID of the service.

name? string - The name of the service.

providerId? string - The ID of the server providing the service.

deviceSummaries? DeviceSummary[] - The list of devices attached to the service. Note: when using the Services service, this list is always empty. It is populated only when using the Service Details service.

totalPowerConsumption? decimal - The total power consumption of the devices attached to the service.

totalPowerConsumptionUnit? string - The unit in which the total power consumption of the devices attached to the service is being expressed.

heatingMargin? decimal - The lowest heating margin among the heating margins of the devices attached to the service. Note:This field will only be present if a value could be found.

heatingMarginUnit? string - The unit in which the heating margin of the service is being expressed.

heatingMarginDeviceName? string - The name of the device having the lowest heating margin. Note:This field will only be present if a value could be found.

heatingMarginDeviceUrl? string - The link to the details of the device having the lowest heating margin. Note:This field will only be present if a value could be found.

heatingMarginCoverage? decimal - The percentage of devices attached to the service, whose heating margin could be found. Note:This field will only be present if a value could be found.

oneDayEnergyConsumption? decimal - The quantity of energy consumed by the devices attached to the service during one day.

oneDayCost? decimal - The daily cost of the energy consumed by the devices attached to the service. Note:This field will only be present if a value could be computed.

oneDayEmittedCo2? decimal - The quantity of CO2 emitted by the devices attached to the service during one day. Note:This field will only be present if a value could be computed.

oneDayConfidence? decimal - The confidence score (percentage) for the daily energy consumption, energy cost and CO2 emission values. The lower the confidence score, the more extrapolated the values are.

oneMonthEnergyConsumption? decimal - The quantity of energy consumed by the devices attached to the service during one month.

oneMonthCost? decimal - The monthly cost of the energy consumed by the devices attached to the service. Note:This field will only be present if a value could be computed.

oneMonthEmittedCo2? decimal - The quantity of CO2 emitted by the devices attached to the service during one month. Note:This field will only be present if a value could be computed.

oneMonthConfidence? decimal - The confidence score (percentage) for the monthly energy consumption, energy cost and CO2 emission values. The lower the confidence score, the more extrapolated the values are.

oneYearEnergyConsumption? decimal - The quantity of energy consumed by the devices attached to the service during one year.

oneYearCost? decimal - The yearly cost of the energy consumed by the devices attached to the service. Note:This field will only be present if a value could be computed.

oneYearEmittedCo2? decimal - The quantity of CO2 emitted by the devices attached to the service in one year. Note:This field will only be present if a value could be computed.

oneYearConfidence? decimal - The confidence score (percentage) for the yearly energy consumption, energy cost and CO2 emission values. The lower the confidence score, the more extrapolated the values are.

updateTimestamp? int - The data collection time (as an Epoch time, in seconds).

url? string - The link to the service details.

numberOfDevices? int - The number of devices attached to the service.

energyConsumptionUnit? string - The unit in which all energy consumption values are being expressed.

costUnit? string - The currency in which all energy cost values are being expressed.

emittedCo2Unit? string - The unit in which all CO2 emission values are being expressed.

historyParentIdKey? string - The name of the key used to identify the service in the history table.

Import

import ballerinax/bmc.truesightpresentationserver;

Other versions

1.5.2

1.5.1 1.5.0 1.4.0 1.2.0

Metadata

Released date: about 9 hours ago

Version: 1.5.2

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.8.0

GraalVM compatible: Yes

Pull count

Total: 27

Current verison: 0

Weekly downloads

Source repository

Keywords

Type/Connector

Vendor/BMC

Area/Cloud & Infrastructure

IT Operations/Server Monitoring

Cost/Freemium

Contributors

Dependencies

ballerina/url/2.4.0 ballerina/http/2.10.24

Cookie policy

Delete policy

clients

records

ballerinax/bmc.truesightpresentationserver Ballerina library

Overview

Key Features

Prerequisites

Clients

bmc.truesightpresentationserver: Client

Constructor

collectNow

Parameters

Return Type

rediscover

Parameters

Return Type

reinitialize

Parameters

Return Type

remove

Parameters

Return Type

reset

Parameters

Return Type

getApplications

Parameters

Return Type

getOneApplication

Parameters

Return Type

getDeviceMonitors

Parameters

Return Type

getDevices

Parameters

Return Type

getDevicesSummary

Return Type

getDevice

Parameters

Return Type

getDeviceAgent

Parameters

Return Type

getAgentDevices

Parameters

Return Type

getDeviceParameterHistory

Parameters

Return Type

getDeviceEnergyUsage

Parameters

Return Type

getGroups

Parameters

Return Type

getOneGroup

Parameters

Return Type

updateEnergyCost

Parameters

Return Type

getHeatingMarginCoverage

Parameters

Return Type

getHistory

Parameters

Return Type

searchDevices

Parameters

Return Type

getServices

Parameters

Return Type

getOneService

Parameters

Return Type

Records

bmc.truesightpresentationserver: ActionResponse

Fields