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

AccessAttributeValue

Provider configuration parameter value

Action

ActionCatalog

ActionCatalogGroup

ActionCatalogGroupInputParam

AddOnContractLine

Contract line for an add-on

ApplicationSoftware

Application software that can be installed

AuditRecord

BaseCPUSensor

Basic CPU metrics

BaseMemorySensor

Basic memory metrics

BlockDevice

Block storage

Blueprint

BlueprintDocument

BlueprintReference

CloudParameter

Value of a container parameter

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

ContainerBlueprint

Network container configuration blueprint

Contract

Contract for a service offering instance

ContractLine

Line item in a contract for a specific service offering instance

Database

EntitlementPackage

Entitlement package to demarcate access to specific {{ServiceOffering}}s.

Filesystem

Network attached storage formatted with a file system

Firewall

Virtual firewall

FirewallNetworkInterface

Firewall network interface

FirewallRule

Firewall rule for an IP address

FloatSimpleDurationThreshold

FunctionalComponent

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

InboundFirewallRule

Inbound firewall rule

InstallableResource

Software item from the BMC Atrium Product Catalog

IntegerSimpleDurationThreshold

IPAddress

IP address

IPAddressPool

Collection of IP addresses

LBPoolEntry

Load balancer pool entry

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

LogicalAddressPool

LogicalAddressSpace

LogicalCommunicationPath

Logical communication path

LogicalDataCenter

Logical data center

LogicalDataCenterNetwork

LogicalDataCenterOrganization

Logical data center organization

LogicalDataCenterUserMap

Logical data center user map

LogicalDistributedFirewall

Logical hosting environment

LogicalDistributedFirewallInterface

Logical hosting environment

LogicalFirewall

Logical hosting environment

LogicalFirewallInterface

Logical hosting environment

LogicalFirewallRule

Logical hosting environment

LogicalHostingEnvironment

Logical hosting environment

LogicalHostingEnvironmentBlueprint

LogicalLoadBalancer

LogicalNetwork

Logical network

LogicalPerimeterFirewall

Logical hosting environment

LogicalPerimeterFirewallInterface

Logical hosting environment

LogicalRoute

LogicalRouteTable

LogicalServerFarm

LogicalServerFarmEntry

LogicalSimpleFirewallRule

Logical hosting environment

LogicalZone

Level 3 application execution environment

Network

Collection of virtual local area networks

NetworkContainer

Network container

NetworkPath

Network path

OperatingSystem

Installed instance of an operating system

Operation

Operation that can be performed on a cloud class

OperationInvocation

OpsManager

Option

Service modification option

OptionChoice

Valid choice for an option

Organization

Business organization

OutboundFirewallRule

Outbound firewall rule

PhysicalServer

Physical server resource made available to the cloud

Pod

Set of physical devices

Policy

Placement policy

PolicyCategory

Placement policy category

PolicyDomain

PolicyType

Placement policy type

ReferenceActionCatalog

ReferenceActionCatalogEntry

ReferenceActionCatalogGroup

ReferenceSensorCatalog

RequestableOffering

ResourceSet

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

RuleGroup

Script

SelectedOptionContractLine

Contract line for a selected option

Sensor

SensorAttribute

SensorCatalog

ServiceOffering

Service offered to end users

ServiceOfferingContractLine

Service offering contract line

ServiceOfferingInstance

Instantiation of a particular service offering

ServiceOfferingInstanceBucket

SoftwareContainer

StaticPool

Fixed membership resource pool

StorageConnection

Connects compute resources to attached storage

StorageResource

Superclass for all cloud storage resources

Switch

Switch

SwitchAccessSecurityDevice

SwitchAccessSecurityDeviceNetworkInterface

SwitchAccessSecurityDeviceRule

SwitchPort

Switch port

Tag

Cloud object metadata

TagGroup

Set of tags

Task

Discrete activity performed by the system

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

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.

Comments