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
`Action`
`ActionCatalog`
`ActionCatalogEntry`
`ActionCatalogEntryInputParam`
`ActionCatalogGroup`
`ActionCatalogGroupInputParam`
`ActionGroup`
`ActionGroupInputParam`
`ActionInputParam`
`ActionMetaData`
`ActionMetaDataNameValuePair`
`ActionSequence`
`Activity`
`AddOnContractLine`	Contract line for an add-on
`AggregateExpression`
`ApplicationContainer`
`ApplicationContainerIndex`
`ApplicationSoftware`	Application software that can be installed
`Attribute`	Attribute of a cloud class
`AuditRecord`
`AuditResource`
`BaseCPUSensor`	Basic CPU metrics
`BaseMemorySensor`	Basic memory metrics
`BasePolicy`
`BaseTime`
`BlockDevice`	Block storage
`Blueprint`
`BlueprintDocument`
`BlueprintReference`
`BooleanOperationInvocationParameter`
`BooleanValueTime`
`BooleanValueTimeSeries`
`CatalogService`	Represents a business services in BMC Remedy Service Request Management
`CartView`	Represents the items present in the cart.
`CloudClass`	Superclass of all classes in the model
`CloudError`	Execution error
`CloudObject`	Abstract superclass of all classes in the model
`CloudObjectOperationInvocationParameter`
`CloudParameter`	Value of a container parameter
`CloudProvidedResource`	Superclass for all cloud resources provided by BMC Cloud Lifecycle Management
`CloudResource`	Superclass for all classes that exist in the cloud
`CloudResourceIndex`
`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
`CustomContainer`
`CustomContainerIndex`
`CustomField`
`CustomResourceProperty`
`Database`
`DateOperationInvocationParameter`
`DeploymentModel`	Deployment topology for a functional model
`DeploymentParameterValue`	Deployment parameter value
`Document`
`Expression`
`Filesystem`	Network attached storage formatted with a file system
`Firewall`	Virtual firewall
`FirewallNetworkInterface`	Firewall network interface
`FirewallRule`	Firewall rule for an IP address
`FloatOperationInvocationParameter`
`FloatSimpleDurationThreshold`
`FloatValueTime`
`FloatValueTimeSeries`
`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
`GovernancePolicy`
`InboundFirewallRule`	Inbound firewall rule
`Index`
`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
`InstallableResourceDisk`	Software item from the BMC Atrium Product Catalog
`InstallationProfile`	Configuration of a cloud installation
`IntegerOperationInvocationParameter`
`IntegerSimpleDurationThreshold`
`IntegerValueTime`
`IntegerValueTimeSeries`
`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
`Log`
`LogicalAddressPool`
`LogicalAddressSpace`
`LogicalCommunicationPath`	Logical communication path
`LogicalConnector`
`LogicalDataCenter`	Logical data center
`LogicalDataCenterAddressPool`
`LogicalDataCenterAddressSpace`
`LogicalDataCenterBlueprint`
`LogicalDatacenterDatastore`
`LogicalDataCenterDistributedFirewall`
`LogicalDataCenterDistributedFirewallInterface`	Firewall network interface
`LogicalDataCenterDomainNameSystem`
`LogicalDataCenterGateway`
`LogicalDataCenterLoadBalancer`
`LogicalDataCenterLoadBalancerInterface`
`LogicalDataCenterNetwork`
`LogicalDataCenterNetworkGroup`
`LogicalDataCenterOrganization`	Logical data center organization
`LogicalDataCenterPerimeterFirewall`	Virtual firewall
`LogicalDataCenterPerimeterFirewallInterface`	Firewall network interface
`LogicalDataCenterRoute`
`LogicalDataCenterRouteTable`
`LogicalDataCenterServerFarm`
`LogicalDataCenterServerFarmEntry`
`LogicalDataCenterSimpleFirewallRule`	Firewall rule for an IP address
`LogicalDataCenterUserMap`	Logical data center user map
`LogicalDistributedFirewall`	Logical hosting environment
`LogicalDistributedFirewallInterface`	Logical hosting environment
`LogicalDomainNameSystem`
`LogicalFirewall`	Logical hosting environment
`LogicalFirewallInterface`	Logical hosting environment
`LogicalFirewallRule`	Logical hosting environment
`LogicalGateway`
`LogicalHostingEnvironment`	Logical hosting environment
`LogicalHostingEnvironmentBlueprint`
`LogicalLoadBalancer`
`LogicalLoadBalancerInterface`
`LogicalNetwork`	Logical network
`LogicalNetworkGroup`
`LogicalPerimeterFirewall`	Logical hosting environment
`LogicalPerimeterFirewallInterface`	Logical hosting environment
`LogicalRoute`
`LogicalRouteTable`
`LogicalServerFarm`
`LogicalServerFarmEntry`
`LogicalSimpleFirewallRule`	Logical hosting environment
`LogicalZone`	Level 3 application execution environment
`ManagementApplication`
`ManagementHost`
`ManagementInfrastructure`	Management infrastructure
`NameValueMapEntry`
`NameValuePair`	Name-value pair
`NameValuesPair`
`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
`NotificationPolicy`
`offeringView`
`OperatingSystem`	Installed instance of an operating system
`Operation`	Operation that can be performed on a cloud class
`OperationInvocation`
`OperationInvocationParameter`
`OpsManager`
`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
`PolicyDomain`
`PolicyDomainDataset`
`PolicyProperty`	Placement policy attribute
`PolicyRule`
`PolicyRuleGroup`
`PolicyType`	Placement policy type
`Price`	Cost information for a service offering
Privilege
`ProvidedOperation`	Operation implemented by a provider
`Provider`	Component or system that provides a cloud class
`ProviderDefinition`	Definition of a provider
`PutResourcesResult`
`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
`ReferenceActionCatalog`
`ReferenceActionCatalogEntry`
`ReferenceActionCatalogEntryInputParam`
`ReferenceActionCatalogGroup`
`ReferenceActionCatalogGroupInputParam`
`ReferenceActionInputParam`
`ReferenceActionMetaData`
`ReferenceActionMetaDataNameValuePair`
`ReferenceSensorCatalog`
`ReferenceSensorCatalogEntry`
`ReferenceSensorCatalogEntryAttribute`
`ReferenceSensorCatalogEntryAttributeConfigParam`
`ReferenceSensorMetadata`
`ReferenceSensorMetadataNameValuePair`
`RefractoryPeriod`
`Relation`	Relationship between two cloud classes
`RemediationPolicy`
`Request`
`RequestableOffering`
`ResourceActionCatalog`
`ResourceActionCatalogEntry`
`ResourceActionCatalogEntryInputParam`
`ResourceActionCatalogGroup`
`ResourceActionCatalogGroupInputParam`
`ResourceAddressPool`
`ResourceAddressSpace`
`ResourceDataset`
`ResourceDistributedFirewall`	Resource hosting environment
`ResourceDomainNameSystem`
`ResourceGateway`
`ResourceHostingEnvironment`	Resource hosting environment
`ResourceHostingEnvironmentBlueprint`
`ResourceLoadBalancer`
`ResourceNetwork`	Resource network
`ResourceNetworkGroup`
`ResourceNetworkInterface`	Resource network interface
`ResourceNetworkPath`	Resource network path
`ResourcePerimeterFirewall`	Resource hosting environment
`ResourceQuota`	Resource quota for an organization
`ResourceRoute`
`ResourceRouteTable`
`ResourceRule`
`ResourceRuleEvaluationDomain`
`ResourceRuleGroup`
`ResourceSensorCatalog`
`ResourceSensorCatalogEntry`
`ResourceSensorCatalogEntryAttribute`
`ResourceSensorCatalogEntryAttributeConfigParam`
`ResourceServerFarm`
`ResourceServerFarmEntry`
`ResourceSet`	Logical collection of compute resources, storage resources, and network resources
`ResourceSimpleFirewallRule`	Resource hosting environment
`ResourceZone`	Resource hosting environment
`Rule`
`RuleDataset`
`RuleEvaluationDomain`
`RuleGroup`
`RunningSoftware`
`Schedule`
`Script`
`ScriptDocument`
`SearchResult`
`SearchResults`	Result of a search request
`SelectedOptionContractLine`	Contract line for a selected option
`Sensor`
`SensorAttribute`
`SensorAttributeThreshold`
`SensorCatalog`
`SensorCatalogEntry`
`SensorCatalogEntryAttribute`
`SensorCatalogEntryAttributeConfigParam`
`SensorMetadata`
`SensorMetadataNameValuePair`
`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
`ServiceOfferingInstanceBucket`
`SimpleActionSequence`
`SimpleActionSequenceMember`
`SimpleDurationThreshold`
`SimpleNotificationTrigger`
`SimpleRemediationTrigger`
`SimpleTrigger`
`SoftwareContainer`
`SoftwareContainerPoolPlacementAdvice`
`SoftwareHost`
`SoftwareResource`	Software resources
`SoftwareResourceProperty`
`SpecCloudObjectsPair`
`StaticDataset`
`StaticPool`	Fixed membership resource pool
`StorageConnection`	Connects compute resources to attached storage
`StorageIndex`
`StorageResource`	Superclass for all cloud storage resources
`StringOperationInvocationParameter`
`StringValueTime`
`StringValueTimeSeries`
`Switch`	Switch
`SwitchAccessSecurityDevice`
`SwitchAccessSecurityDeviceNetworkInterface`
`SwitchAccessSecurityDeviceRule`
`SwitchPort`	Switch port
`Tag`	Cloud object metadata
`TagGroup`	Set of tags
`Task`	Discrete activity performed by the system
`TaskDetail`	Discrete activity performed by the system
`TaskError`	Task execution error
`Ticket`
`TicketTemplate`
`TicketTemplateMap`
`TimeDuration`
`TimeInterval`
`TimeTrigger`
`Trigger`
`User`
`UserMapProperty`
`ValueTime`
`ValueTimeSeries`
`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
`VLBPoolParameter`
`Zone`	Level 3 application execution environment

Cloud API reference

Comments