Unsupported content

 

This version of the documentation is no longer supported. However, the documentation is available for your convenience. 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

AccessAttribute

Provider configuration parameter

AccessAttributeValue

Provider configuration parameter value

AddOnContractLine

Contract line for an add-on

ApplicationSoftware

Application software that can be installed

Attribute

Attribute of a cloud class

BaseCPUSensor

Basic CPU metrics

BaseMemorySensor

Basic memory metrics

BlockDevice

Block storage

CloudClass

Superclass of all classes in the model

CloudError

Execution error

CloudObject

Abstract superclass of all classes in the model

CloudProvidedResource

Superclass for all cloud resources provided by BMC Cloud Lifecycle Management

CloudResource

Superclass for all classes that exist in the cloud

CloudService

Instantiation of an OSGi service on a node

CloudServiceDefinition

Cloud service definition

CloudVersion

Software version information

ComputeContainer

Physical, virtual, and external compute capability

ComputeContainerNetworkInterface

Represents the network interface for a compute container

ComputeInfrastructure

Superclass for all types of infrastructure compute resources

ComputeResource

Superclass for all cloud compute resources

ContainerBlueprint

Network container configuration blueprint

ContainerParameterValue

Value of a container parameter

Contract

Contract for a service offering instance

ContractLine

Line item in a contract for a specific service offering instance

CoreCloudService

Internal cloud service

DeploymentModel

Deployment topology for a functional model

DeploymentParameterValue

Deployment parameter value

Filesystem

Network attached storage formatted with a file system

Firewall

Virtual firewall

FirewallNetworkInterface

Firewall network interface

FirewallRule

Firewall rule for an IP address

FunctionalComponent

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

FunctionalComponentConnection

Instantiation of a connection described in a functional model

FunctionalModel

Describes the software components that make up a service offering

InboundFirewallRule

Inbound firewall rule

InfrastructureProvidedResource

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

InstallableResource

Software item from the BMC Atrium Product Catalog

InstallationProfile

Configuration of a cloud installation

IPAddress

IP address

IPAddressPool

Collection of IP addresses

LBPoolEntry

Load balancer pool entry

LBPoolParameterValue

Load balancer pool parameter value

LoadBalancer

Virtual load balancer

LoadBalancerNetworkInterface

Network interface for a load balancer

LoadBalancerPool

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

LoadBalancingServiceNetworkInterface

Load balancing service network interface

LocalDisk

Locally attached storage

Location

Physical location

LogicalCommunicationPath

Logical communication path

LogicalDataCenter

Logical data center

LogicalDataCenterOrganization

Logical data center organization

LogicalDataCenterUserMap

Logical data center user map

LogicalHostingEnvironment

Logical hosting environment

LogicalNetwork

Logical network

ManagementInfrastructure

Management infrastructure

NameValuePair

Name-value pair

Network

Collection of virtual local area networks

NetworkContainer

Network container

NetworkInterface

Interface between a compute container and the network

NetworkPath

Network path

NetworkResource

Superclass for all cloud network resources

Node

Node in the cloud deployment

OperatingSystem

Installed instance of an operating system

Operation

Operation that can be performed on a cloud class

Option

Service modification option

OptionChoice

Valid choice for an option

Organization

Business organization

OutboundFirewallRule

Outbound firewall rule

Parameter

Operation parameter

PhysicalServer

Physical server resource made available to the cloud

Pod

Set of physical devices

Policy

Placement policy

PolicyCategory

Placement policy category

PolicyProperty

Placement policy attribute

PolicyType

Placement policy type

Price

Cost information for a service offering

ProvidedOperation

Operation implemented by a provider

Provider

Component or system that provides a cloud class

ProviderDefinition

Definition of a provider

Query

Search criteria

QueryAliasReference

Alias reference for a query

QueryColumn

Query column

QueryCount

Query count

QueryExists

Query exists

QueryLiteral

Query literal

QueryLiteralNull

Null literal

QueryLogical

Logical operator for a query

QueryNode

Node in a query

QueryPropertyReference

Property reference for a query

QuerySelect

Selection in a query

QuerySimpleCondition

Simple condition for a query

Relation

Relationship between two cloud classes

ResourceHostingEnvironment

Resource hosting environment

ResourceNetwork

Resource network

ResourceNetworkInterface

Resource network interface

ResourceNetworkPath

Resource network path

ResourceQuota

Resource quota for an organization

ResourceSet

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

SearchResults

Result of a search request

SelectedOptionContractLine

Contract line for a selected option

Server

Superclass for all server classes

ServerNetworkInterface

Network interface for a server

ServiceOffering

Service offered to end users

ServiceOfferingContractLine

Service offering contract line

ServiceOfferingInstance

Instantiation of a particular service offering

SoftwareResource

Software resources

StaticPool

Fixed membership resource pool

StorageConnection

Connects compute resources to attached storage

StorageResource

Superclass for all cloud storage resources

Switch

Switch

SwitchAccessSecurityDevice

A distributed firewall for providing access-level security, such as a Virtual Security Gateway

SwitchAccessSecurityDeviceNetworkInterface

The access control list (collection of rules) for a firewall

SwitchAccessSecurityDeviceRule

A rule entry in an access control list

SwitchPort

Switch port

Tag

Cloud object metadata

TagGroup

Set of tags

Task

Discrete activity performed by the system

TaskError

Task execution error

TenantNetworkPath

Tenant network path

VirtualCluster

Aggregation of virtual hosts

VirtualDatastore

Data store attached to a cluster

VirtualGuest

Virtual guest

VirtualGuestTemplate

Virtual guest template

VirtualHost

Physical server used to host virtual guests

VirtualInfrastructureManager

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

VirtualResourcePool

Collection of resources

Zone

Level 3 application execution environment

Was this page helpful? Yes No Submitting... Thank you

Comments