karbor.api.v1 package

Submodules

karbor.api.v1.copies module

The copy api.

class karbor.api.v1.copies.CopiesController

Bases: karbor.api.openstack.wsgi.Controller

The copy API controller for the OpenStack API.

create(req, provider_id, body)

Creates a new copy.

wsgi_actions = {}

wsgi_extensions = []

class karbor.api.v1.copies.CopiesViewBuilder

Bases: karbor.api.common.ViewBuilder

Model a server API response as a python dictionary.

detail(request, copy)

Detailed view of a single copy.

karbor.api.v1.copies.create_resource()

karbor.api.v1.operation_logs module

The operation_logs api.

class karbor.api.v1.operation_logs.OperationLogViewBuilder

Bases: karbor.api.common.ViewBuilder

Model a server API response as a python dictionary.

detail(request, operation_log)

Detailed view of a single operation_log.

detail_list(request, operation_logs, operation_log_count=None)

Detailed view of a list of operation_logs.

class karbor.api.v1.operation_logs.OperationLogsController

Bases: karbor.api.openstack.wsgi.Controller

The operation_log API controller for the OpenStack API.

index(req)

Returns a list of operation_logs.

show(req, id)

Return data about the given OperationLogs.

wsgi_actions = {}

wsgi_extensions = []

karbor.api.v1.operation_logs.create_resource()

karbor.api.v1.plans module

The plans api.

class karbor.api.v1.plans.PlanViewBuilder

Bases: karbor.api.common.ViewBuilder

Model a server API response as a python dictionary.

detail(request, plan)

Detailed view of a single plan.

detail_list(request, plans, plan_count=None)

Detailed view of a list of plans.

class karbor.api.v1.plans.PlansController

Bases: karbor.api.openstack.wsgi.Controller

The Plans API controller for the OpenStack API.

create(req, body)

Creates a new plan.

delete(req, id)

Delete a plan.

index(req)

Returns a list of plans, transformed through view builder.

show(req, id)

Return data about the given plan.

update(req, id, body)

Update a plan.

validate_plan_parameters(context, plan)

validate_plan_resources(plan)

wsgi_actions = {}

wsgi_extensions = []

karbor.api.v1.plans.create_resource()

karbor.api.v1.protectables module

The protectables api.

class karbor.api.v1.protectables.ProtectableViewBuilder

Bases: karbor.api.common.ViewBuilder

Model a server API response as a python dictionary.

detail(request, instance)

Detailed view of a single instance.

detail_list(request, instances, instance_count=None)

Detailed view of a list of instances.

show(request, protectable_type)

Detailed view of a single protectable_type.

class karbor.api.v1.protectables.ProtectablesController

Bases: karbor.api.openstack.wsgi.Controller

The Protectables API controller for the OpenStack API.

index(req)

Returns a list of protectable_types,

transformed through view builder.

instances_index(req, protectable_type)

Return data about the given protectable_type.

instances_show(req, protectable_type, protectable_id)

Return a instance about the given protectable_type and id.

show(req, id)

Return data about the given protectable_type.

wsgi_actions = {}

wsgi_extensions = []

karbor.api.v1.protectables.create_resource()

karbor.api.v1.providers module

The providers api.

class karbor.api.v1.providers.CheckpointViewBuilder

Bases: karbor.api.common.ViewBuilder

Model a server API response as a python dictionary.

detail(request, checkpoint)

Detailed view of a single checkpoint.

detail_list(request, checkpoints, checkpoint_count=None)

Detailed view of a list of checkpoints.

class karbor.api.v1.providers.ProviderViewBuilder

Bases: karbor.api.common.ViewBuilder

Model a server API response as a python dictionary.

detail(request, provider)

Detailed view of a single provider.

detail_list(request, providers, provider_count=None)

Detailed view of a list of providers.

class karbor.api.v1.providers.ProvidersController

Bases: karbor.api.openstack.wsgi.Controller

The Providers API controller for the OpenStack API.

checkpoints_create(req, provider_id, body)

Creates a new checkpoint.

checkpoints_delete(req, provider_id, checkpoint_id)

Delete a checkpoint.

checkpoints_index(req, provider_id)

Returns a list of checkpoints, transformed through view builder.

checkpoints_show(req, provider_id, checkpoint_id)

Return data about the given checkpoint id.

checkpoints_update(req, provider_id, checkpoint_id, body)

Reset a checkpoint’s state

index(req)

Returns a list of providers, transformed through view builder.

show(req, id)

Return data about the given provider id.

wsgi_actions = {}

wsgi_extensions = []

karbor.api.v1.providers.create_resource()

karbor.api.v1.quota_classes module

The Quota Class api.

class karbor.api.v1.quota_classes.QuotaClassesController

Bases: karbor.api.openstack.wsgi.Controller

The Quota Class API controller for the OpenStack API.

show(req, id)

Return data about the given quota class id.

update(req, id, body)

wsgi_actions = {}

wsgi_extensions = []

class karbor.api.v1.quota_classes.QuotaClassesViewBuilder

Bases: karbor.api.common.ViewBuilder

Model a Quota Class API response as a python dictionary.

detail_list(request, quota, quota_class=None)

Detailed view of a single quota class.

karbor.api.v1.quota_classes.create_resource()

karbor.api.v1.quotas module

The Quotas api.

class karbor.api.v1.quotas.QuotasController

Bases: karbor.api.openstack.wsgi.Controller

The Quotas API controller for the OpenStack API.

defaults(req, id)

Return data about the given quotas.

delete(req, id)

detail(req, id)

Return data about the given quota.

show(req, id)

Return data about the given quota id.

update(req, id, body)

wsgi_actions = {}

wsgi_extensions = []

class karbor.api.v1.quotas.QuotasViewBuilder

Bases: karbor.api.common.ViewBuilder

Model a Quotas API response as a python dictionary.

detail_list(request, quota, project_id=None)

Detailed view of a single quota.

karbor.api.v1.quotas.create_resource()

karbor.api.v1.restores module

The restores api.

class karbor.api.v1.restores.RestoreViewBuilder

Bases: karbor.api.common.ViewBuilder

Model a server API response as a python dictionary.

detail(request, restore)

Detailed view of a single restore.

detail_list(request, restores, restore_count=None)

Detailed view of a list of restores.

class karbor.api.v1.restores.RestoresController

Bases: karbor.api.openstack.wsgi.Controller

The Restores API controller for the OpenStack API.

create(req, body)

Creates a new restore.

index(req)

Returns a list of restores, transformed through view builder.

show(req, id)

Return data about the given restore.

wsgi_actions = {}

wsgi_extensions = []

karbor.api.v1.restores.create_resource()

karbor.api.v1.router module

class karbor.api.v1.router.APIRouter(mapper)

Bases: oslo_service.wsgi.Router

classmethod factory(global_conf, **local_conf)

karbor.api.v1.scheduled_operations module

The scheduled operations api.

class karbor.api.v1.scheduled_operations.ScheduledOperationController

Bases: karbor.api.openstack.wsgi.Controller

The Scheduled Operation API controller for the OpenStack API.

create(req, body)

Creates a new scheduled operation.

delete(req, id)

Delete a scheduled operation.

index(req)

Returns a list of operations, transformed through view builder.

show(req, id)

Return data about the given operation.

wsgi_actions = {}

wsgi_extensions = []

class karbor.api.v1.scheduled_operations.ScheduledOperationViewBuilder

Bases: karbor.api.common.ViewBuilder

Model a server API response as a python dictionary.

detail(request, operation)

Detailed view of a single scheduled operation.

detail_list(request, operations)

Detailed view of a list of operations.

karbor.api.v1.scheduled_operations.create_resource()

karbor.api.v1.services module

The service management api.

class karbor.api.v1.services.ServiceController

Bases: karbor.api.openstack.wsgi.Controller

The Service Management API controller for the OpenStack API.

index(req)

Returns a list of services

transformed through view builder.

update(req, id, body)

Enable/Disable scheduling for a service

wsgi_actions = {}

wsgi_extensions = []

class karbor.api.v1.services.ServiceViewBuilder

Bases: karbor.api.common.ViewBuilder

Model a server API response as a python dictionary.

detail(request, service)

Detailed view of a single service.

detail_list(request, services, service_count=None)

Detailed view of a list of services.

karbor.api.v1.services.create_resource()

karbor.api.v1.triggers module

The triggers api.

class karbor.api.v1.triggers.TriggerViewBuilder

Bases: karbor.api.common.ViewBuilder

Model a trigger API response as a python dictionary.

detail(request, trigger)

Detailed view of a single trigger.

detail_list(request, triggers)

Detailed view of a list of triggers.

class karbor.api.v1.triggers.TriggersController

Bases: karbor.api.openstack.wsgi.Controller

The Triggers API controller for the OpenStack API.

create(req, body)

Creates a new trigger.

delete(req, id)

Delete a trigger.

index(req)

Returns a list of triggers, transformed through view builder.

show(req, id)

Return data about the given trigger.

update(req, id, body)

Update a trigger

wsgi_actions = {}

wsgi_extensions = []

karbor.api.v1.triggers.create_resource()

karbor.api.v1.verifications module

The verification api.

class karbor.api.v1.verifications.VerificationViewBuilder

Bases: karbor.api.common.ViewBuilder

Model a server API response as a python dictionary.

detail(request, verification)

Detailed view of a single verification.

detail_list(request, verifications, verification_count=None)

Detailed view of a list of verifications.

class karbor.api.v1.verifications.VerificationsController

Bases: karbor.api.openstack.wsgi.Controller

The verifications API controller for the OpenStack API.

create(req, body)

Creates a new verification.

index(req)

Returns a list of verifications.

show(req, id)

Return data about the given verification.

wsgi_actions = {}

wsgi_extensions = []

karbor.api.v1.verifications.create_resource()

Module contents