Placement API

updated: None

Placement API

The Placement Class

The placement high-level interface is available through the placement member of a Connection object. The placement member will only be added if the service is detected.

Resource Classes

class openstack.placement.v1._proxy.Proxy(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)
create_resource_class(**attrs)

Create a new resource class from attributes.

Parameters:attrs – Keyword arguments which will be used to create a ResourceClass, comprised of the properties on the ResourceClass class.
Returns:The results of resource class creation
Return type:ResourceClass
delete_resource_class(resource_class, ignore_missing=True)

Delete a resource class

Parameters:
  • resource_class – The value can be either the ID of a resource class or an ResourceClass, instance.
  • ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource class does not exist. When set to True, no exception will be set when attempting to delete a nonexistent resource class.
Returns:

None
update_resource_class(resource_class, **attrs)

Update a resource class

Parameters:resource_class – The value can be either the ID of a resource class or an ResourceClass, instance.
Attrs kwargs:The attributes to update on the resource class represented by resource_class.
Returns:The updated resource class
Return type:ResourceClass
get_resource_class(resource_class)

Get a single resource_class.

Parameters:resource_class – The value can be either the ID of a resource class or an ResourceClass, instance.
Returns:An instance of ResourceClass
Raises:ResourceNotFound when no resource class matching the criteria could be found.
resource_classes(**query)

Retrieve a generator of resource classs.

Parameters:query (kwargs) – Optional query parameters to be sent to restrict the resource classs to be returned.
Returns:A generator of resource class instances.

Resource Providers

class openstack.placement.v1._proxy.Proxy(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)
create_resource_provider(**attrs)

Create a new resource provider from attributes.

Parameters:attrs – Keyword arguments which will be used to create a ResourceProvider, comprised of the properties on the ResourceProvider class.
Returns:The results of resource provider creation
Return type:ResourceProvider
delete_resource_provider(resource_provider, ignore_missing=True)

Delete a resource provider

Parameters:
  • resource_provider – The value can be either the ID of a resource provider or an ResourceProvider, instance.
  • ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource provider does not exist. When set to True, no exception will be set when attempting to delete a nonexistent resource provider.
Returns:

None
update_resource_provider(resource_provider, **attrs)

Update a resource provider

Parameters:resource_provider – The value can be either the ID of a resource provider or an ResourceProvider, instance.
Attrs kwargs:The attributes to update on the resource provider represented by resource_provider.
Returns:The updated resource provider
Return type:ResourceProvider
get_resource_provider(resource_provider)

Get a single resource_provider.

Parameters:resource_provider – The value can be either the ID of a resource provider or an ResourceProvider, instance.
Returns:An instance of ResourceProvider
Raises:ResourceNotFound when no resource provider matching the criteria could be found.
find_resource_provider(name_or_id, ignore_missing=True)

Find a single resource_provider.

Parameters:
  • name_or_id – The name or ID of a resource provider.
  • ignore_missing (bool) – When set to False ResourceNotFound will be raised when the resource does not exist. When set to True, None will be returned when attempting to find a nonexistent resource.
Returns:

An instance of ResourceProvider
Raises:

ResourceNotFound when no resource provider matching the criteria could be found.
resource_providers(**query)

Retrieve a generator of resource providers.

Parameters:query (kwargs) – Optional query parameters to be sent to restrict the resource providers to be returned.
Returns:A generator of resource provider instances.
updated: None
Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

questions?