Unsupported content This version of the product has reached end of support. The documentation is available for your convenience. However, you must be logged in to access it. You will not be able to leave comments.

Cloud API reference

The following table summarizes the classes that compose the Cloud API. Click on a class name to see a detailed description of the class and its constituent APIs. For information about working with the topics in this section, see Using-the-API-reference-sections.

Class name

Description

Provider configuration parameter

Provider configuration parameter value

 

 

 

 

 

 

 

 

 

 

 

 

 

Contract line for an add-on

 

 

 

Application software that can be installed

Attribute of a cloud class

 

 

Basic CPU metrics

Basic memory metrics

 

 

Block storage

 

 

 

 

 

 

Represents a business services in BMC Remedy Service Request Management

Represents the items present in the cart.

Superclass of all classes in the model

Execution error

Abstract superclass of all classes in the model

 

Value of a container parameter

Superclass for all cloud resources provided by BMC Cloud Lifecycle Management

Superclass for all classes that exist in the cloud

 

Instantiation of an OSGi service on a node

Cloud service definition

Software version information

Physical, virtual, and external compute capability

Represents the network interface for a compute container

Superclass for all types of infrastructure compute resources

Superclass for all cloud compute resources

Network container configuration blueprint

Value of a container parameter

Contract for a service offering instance

Line item in a contract for a specific service offering instance

Internal cloud service

 

 

 

 

 

 

Deployment topology for a functional model

Deployment parameter value

 

 

Network attached storage formatted with a file system

Virtual firewall

Firewall network interface

Firewall rule for an IP address

 

 

 

 

Logical run-time instantiation of a component described in a functional model

Instantiation of a connection described in a functional model

Describes the software components that make up a service offering

 

Inbound firewall rule

 

Abstract superclass of all resources that are provided by a resource provider other than BMC Cloud Lifecycle Management

Software item from the BMC Atrium Product Catalog

Software item from the BMC Atrium Product Catalog

Configuration of a cloud installation

 

 

 

 

IP address

Collection of IP addresses

Load balancer pool entry

Load balancer pool parameter value

Virtual load balancer

Network interface for a load balancer

Logical set of devices that work as a group to receive and process traffic

Load balancing service network interface

Locally attached storage

Physical location

 

 

 

Logical communication path

 

Logical data center

 

 

 

 

 

Firewall network interface

 

 

 

 

 

 

Logical data center organization

Virtual firewall

Firewall network interface

 

 

 

 

Firewall rule for an IP address

Logical data center user map

Logical hosting environment

Logical hosting environment

 

Logical hosting environment

Logical hosting environment

Logical hosting environment

 

Logical hosting environment

 

 

 

Logical network

 

Logical hosting environment

Logical hosting environment

 

 

 

 

Logical hosting environment

Level 3 application execution environment

 

 

Management infrastructure

 

Name-value pair

 

Collection of virtual local area networks

Network container

Interface between a compute container and the network

Network path

Superclass for all cloud network resources

Node in the cloud deployment

 


Installed instance of an operating system

Operation that can be performed on a cloud class

 

 

 

Service modification option

Valid choice for an option

Business organization

Outbound firewall rule

Operation parameter

Physical server resource made available to the cloud

Set of physical devices

Placement policy

Placement policy category

 

 

Placement policy attribute

 

 

Placement policy type

Cost information for a service offering

 

Operation implemented by a provider

Component or system that provides a cloud class

Definition of a provider

 

Search criteria

Alias reference for a query

Query column

Query count

Query exists

Query literal

Null literal

Logical operator for a query

Node in a query

Property reference for a query

Selection in a query

Simple condition for a query

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Relationship between two cloud classes

 

 

 

 

 

 

 

 

 

 

 

Resource hosting environment

 

 

Resource hosting environment

 

 

Resource network

 

Resource network interface

Resource network path

Resource hosting environment

Resource quota for an organization

 

 

 

 

 

 

 

 

 

 

 

Logical collection of compute resources, storage resources, and network resources

Resource hosting environment

Resource hosting environment

 

 

 

 

 

 

 

 

 

Result of a search request

Contract line for a selected option

 

 

 

 

 

 

 

 

 

Superclass for all server classes

Network interface for a server

Service offered to end users

Service offering contract line

Instantiation of a particular service offering

 

 

 

 

 

 

 

 

 

 

Software resources

 

 

 

Fixed membership resource pool

Connects compute resources to attached storage

 

Superclass for all cloud storage resources

 

 

 

Switch

 

 

 

Switch port

Cloud object metadata

Set of tags

Discrete activity performed by the system

Discrete activity performed by the system

Task execution error

 

 

 

 

 

 

 

 

 

 

 

Aggregation of virtual hosts

Data store attached to a cluster

Virtual guest

Virtual guest template

Physical server used to host virtual guests

Software that manages virtual clusters, virtual hosts, and virtual guests

Collection of resources

 

Level 3 application execution environment