cinder.volume package

Subpackages

• cinder.volume.flows package
  • Subpackages
    • cinder.volume.flows.api package
      • Submodules
      • Module contents
    • cinder.volume.flows.manager package
      • Submodules
      • Module contents
  • Submodules
    • cinder.volume.flows.common module
      • error_out()
      • make_pretty_name()
      • restore_source_status()
  • Module contents
• cinder.volume.targets package
  • Submodules
    • cinder.volume.targets.cxt module
      • CxtAdm
    • cinder.volume.targets.driver module
      • Target
    • cinder.volume.targets.fake module
      • FakeTarget
    • cinder.volume.targets.iscsi module
      • ISCSITarget
      • SanISCSITarget
    • cinder.volume.targets.lio module
      • LioAdm
    • cinder.volume.targets.nvmeof module
      • NVMeOF
      • UnsupportedNVMETProtocol
    • cinder.volume.targets.nvmet module
      • NVMET
      • NVMETTargetAddError
      • NVMETTargetDeleteError
    • cinder.volume.targets.scst module
      • SCSTAdm
    • cinder.volume.targets.spdknvmf module
      • SpdkNvmf
    • cinder.volume.targets.tgt module
      • TgtAdm
  • Module contents

Submodules

• cinder.volume.api module
  • API
    • API.AVAILABLE_MIGRATION_STATUS
    • API.accept_transfer()
    • API.attach()
    • API.attachment_create()
    • API.attachment_delete()
    • API.attachment_deletion_allowed()
    • API.attachment_update()
    • API.begin_detaching()
    • API.calculate_resource_count()
    • API.check_volume_filters()
    • API.copy_volume_to_image()
    • API.create()
    • API.create_snapshot()
    • API.create_snapshot_force()
    • API.create_snapshot_in_db()
    • API.create_snapshots_in_db()
    • API.create_volume_metadata()
    • API.delete()
    • API.delete_snapshot()
    • API.delete_snapshot_metadata()
    • API.delete_volume_metadata()
    • API.detach()
    • API.extend()
    • API.extend_attached_volume()
    • API.failover()
    • API.freeze_host()
    • API.get()
    • API.get_all()
    • API.get_all_snapshots()
    • API.get_list_volumes_image_metadata()
    • API.get_manageable_snapshots()
    • API.get_manageable_volumes()
    • API.get_snapshot()
    • API.get_snapshot_metadata()
    • API.get_volume()
    • API.get_volume_image_metadata()
    • API.get_volume_metadata()
    • API.get_volume_summary()
    • API.get_volumes_image_metadata()
    • API.initialize_connection()
    • API.is_service_request()
    • API.list_availability_zones()
    • API.manage_existing()
    • API.manage_existing_snapshot()
    • API.migrate_volume()
    • API.migrate_volume_completion()
    • API.reimage()
    • API.reserve_volume()
    • API.retype()
    • API.revert_to_snapshot()
    • API.roll_detaching()
    • API.terminate_connection()
    • API.thaw_host()
    • API.unreserve_volume()
    • API.update()
    • API.update_readonly_flag()
    • API.update_snapshot()
    • API.update_snapshot_metadata()
    • API.update_volume_admin_metadata()
    • API.update_volume_metadata()
  • HostAPI
    • HostAPI.set_host_enabled()
• cinder.volume.configuration module
  • BackendGroupConfiguration
    • BackendGroupConfiguration.append_config_values()
    • BackendGroupConfiguration.get()
    • BackendGroupConfiguration.safe_get()
    • BackendGroupConfiguration.set_default()
  • Configuration
    • Configuration.append_config_values()
    • Configuration.safe_get()
  • DefaultGroupConfiguration
    • DefaultGroupConfiguration.append_config_values()
    • DefaultGroupConfiguration.safe_get()
• cinder.volume.driver module
  • BaseVD
    • BaseVD.REPLICATION_FEATURE_CHECKERS
    • BaseVD.SUPPORTED
    • BaseVD.SUPPORTS_ACTIVE_ACTIVE
    • BaseVD.VERSION
    • BaseVD.accept_transfer()
    • BaseVD.after_volume_copy()
    • BaseVD.backup_use_temp_snapshot()
    • BaseVD.before_volume_copy()
    • BaseVD.check_for_setup_error()
    • BaseVD.clean_snapshot_file_locks()
    • BaseVD.clean_volume_file_locks()
    • BaseVD.clear_download()
    • BaseVD.clone_image()
    • BaseVD.copy_image_to_encrypted_volume()
    • BaseVD.copy_image_to_volume()
    • BaseVD.copy_volume_to_image()
    • BaseVD.create_cloned_volume()
    • BaseVD.create_export()
    • BaseVD.create_export_snapshot()
    • BaseVD.create_group()
    • BaseVD.create_group_from_src()
    • BaseVD.create_group_snapshot()
    • BaseVD.create_volume()
    • BaseVD.create_volume_from_backup()
    • BaseVD.delete_group()
    • BaseVD.delete_group_snapshot()
    • BaseVD.delete_volume()
    • BaseVD.disable_replication()
    • BaseVD.do_setup()
    • BaseVD.enable_replication()
    • BaseVD.ensure_export()
    • BaseVD.extend_volume()
    • BaseVD.failover()
    • BaseVD.failover_completed()
    • BaseVD.failover_host()
    • BaseVD.failover_replication()
    • BaseVD.freeze_backend()
    • BaseVD.get_backup_device()
    • BaseVD.get_default_filter_function()
    • BaseVD.get_default_goodness_function()
    • BaseVD.get_driver_options()
    • BaseVD.get_filter_function()
    • BaseVD.get_goodness_function()
    • BaseVD.get_pool()
    • BaseVD.get_replication_error_status()
    • BaseVD.get_version()
    • BaseVD.get_volume_stats()
    • BaseVD.init_capabilities()
    • BaseVD.initialize_connection()
    • BaseVD.initialize_connection_snapshot()
    • BaseVD.initialized
    • BaseVD.manage_existing()
    • BaseVD.migrate_volume()
    • BaseVD.remove_export()
    • BaseVD.remove_export_snapshot()
    • BaseVD.retype()
    • BaseVD.secure_file_operations_enabled()
    • BaseVD.set_initialized()
    • BaseVD.set_throttle()
    • BaseVD.snapshot_revert_use_temp_snapshot()
    • BaseVD.supported
    • BaseVD.supports_replication_feature()
    • BaseVD.terminate_connection()
    • BaseVD.terminate_connection_snapshot()
    • BaseVD.thaw_backend()
    • BaseVD.unmanage()
    • BaseVD.update_group()
    • BaseVD.update_migrated_volume()
    • BaseVD.update_provider_info()
    • BaseVD.validate_connector()
    • BaseVD.validate_connector_has_setting()
  • CloneableImageVD
    • CloneableImageVD.clone_image()
  • FibreChannelDriver
    • FibreChannelDriver.initialize_connection()
    • FibreChannelDriver.validate_connector()
    • FibreChannelDriver.validate_connector_has_setting()
  • ISCSIDriver
    • ISCSIDriver.initialize_connection()
    • ISCSIDriver.terminate_connection()
    • ISCSIDriver.validate_connector()
  • ISERDriver
    • ISERDriver.initialize_connection()
  • ManageableSnapshotsVD
    • ManageableSnapshotsVD.get_manageable_snapshots()
    • ManageableSnapshotsVD.manage_existing_snapshot()
    • ManageableSnapshotsVD.manage_existing_snapshot_get_size()
    • ManageableSnapshotsVD.unmanage_snapshot()
  • ManageableVD
    • ManageableVD.get_manageable_volumes()
    • ManageableVD.manage_existing()
    • ManageableVD.manage_existing_get_size()
    • ManageableVD.unmanage()
  • MigrateVD
    • MigrateVD.migrate_volume()
  • ProxyVD
  • VolumeDriver
    • VolumeDriver.accept_transfer()
    • VolumeDriver.check_for_setup_error()
    • VolumeDriver.clear_download()
    • VolumeDriver.clone_image()
    • VolumeDriver.create_cgsnapshot()
    • VolumeDriver.create_consistencygroup()
    • VolumeDriver.create_consistencygroup_from_src()
    • VolumeDriver.create_export()
    • VolumeDriver.create_export_snapshot()
    • VolumeDriver.create_snapshot()
    • VolumeDriver.create_volume()
    • VolumeDriver.create_volume_from_snapshot()
    • VolumeDriver.delete_cgsnapshot()
    • VolumeDriver.delete_consistencygroup()
    • VolumeDriver.delete_snapshot()
    • VolumeDriver.delete_volume()
    • VolumeDriver.ensure_export()
    • VolumeDriver.extend_volume()
    • VolumeDriver.get_manageable_snapshots()
    • VolumeDriver.get_manageable_volumes()
    • VolumeDriver.get_pool()
    • VolumeDriver.initialize_connection()
    • VolumeDriver.initialize_connection_snapshot()
    • VolumeDriver.local_path()
    • VolumeDriver.manage_existing()
    • VolumeDriver.manage_existing_get_size()
    • VolumeDriver.manage_existing_snapshot()
    • VolumeDriver.manage_existing_snapshot_get_size()
    • VolumeDriver.migrate_volume()
    • VolumeDriver.remove_export()
    • VolumeDriver.remove_export_snapshot()
    • VolumeDriver.retype()
    • VolumeDriver.revert_to_snapshot()
    • VolumeDriver.terminate_connection()
    • VolumeDriver.terminate_connection_snapshot()
    • VolumeDriver.unmanage()
    • VolumeDriver.unmanage_snapshot()
    • VolumeDriver.update_consistencygroup()
• cinder.volume.driver_utils module
  • VolumeDriverUtils
    • VolumeDriverUtils.get_driver_initiator_data()
    • VolumeDriverUtils.insert_driver_initiator_data()
• cinder.volume.group_types module
  • add_group_type_access()
  • create()
  • destroy()
  • get_all_group_types()
  • get_default_cgsnapshot_type()
  • get_default_group_type()
  • get_group_type()
  • get_group_type_by_name()
  • get_group_type_specs()
  • is_default_cgsnapshot_type()
  • is_public_group_type()
  • remove_group_type_access()
  • update()
• cinder.volume.manager module
  • VolumeManager
    • VolumeManager.FAILBACK_SENTINEL
    • VolumeManager.RPC_API_VERSION
    • VolumeManager.accept_transfer()
    • VolumeManager.attach_volume()
    • VolumeManager.attachment_delete()
    • VolumeManager.attachment_update()
    • VolumeManager.copy_volume_to_image()
    • VolumeManager.create_group()
    • VolumeManager.create_group_from_src()
    • VolumeManager.create_group_snapshot()
    • VolumeManager.create_snapshot()
    • VolumeManager.create_volume()
    • VolumeManager.delete_group()
    • VolumeManager.delete_group_snapshot()
    • VolumeManager.delete_snapshot()
    • VolumeManager.delete_volume()
    • VolumeManager.detach_volume()
    • VolumeManager.disable_replication()
    • VolumeManager.driver_delete_snapshot()
    • VolumeManager.driver_delete_volume()
    • VolumeManager.enable_replication()
    • VolumeManager.extend_volume()
    • VolumeManager.failover()
    • VolumeManager.failover_completed()
    • VolumeManager.failover_host()
    • VolumeManager.failover_replication()
    • VolumeManager.finish_failover()
    • VolumeManager.freeze_host()
    • VolumeManager.get_backup_device()
    • VolumeManager.get_capabilities()
    • VolumeManager.get_manageable_snapshots()
    • VolumeManager.get_manageable_volumes()
    • VolumeManager.init_host()
    • VolumeManager.init_host_with_rpc()
    • VolumeManager.initialize_connection()
    • VolumeManager.initialize_connection_snapshot()
    • VolumeManager.is_working()
    • VolumeManager.list_replication_targets()
    • VolumeManager.manage_existing()
    • VolumeManager.manage_existing_snapshot()
    • VolumeManager.migrate_volume()
    • VolumeManager.migrate_volume_completion()
    • VolumeManager.publish_service_capabilities()
    • VolumeManager.reimage()
    • VolumeManager.remove_export()
    • VolumeManager.remove_export_snapshot()
    • VolumeManager.retype()
    • VolumeManager.revert_to_snapshot()
    • VolumeManager.secure_file_operations_enabled()
    • VolumeManager.target
    • VolumeManager.terminate_connection()
    • VolumeManager.terminate_connection_snapshot()
    • VolumeManager.thaw_host()
    • VolumeManager.update_group()
    • VolumeManager.update_migrated_volume()
  • clean_snapshot_locks()
  • clean_volume_locks()
• cinder.volume.qos_specs module
  • associate_qos_with_type()
  • create()
  • delete()
  • delete_keys()
  • disassociate_all()
  • disassociate_qos_specs()
  • get_all_specs()
  • get_associations()
  • get_qos_specs()
  • update()
• cinder.volume.rpcapi module
  • VolumeAPI
    • VolumeAPI.BINARY
    • VolumeAPI.RPC_API_VERSION
    • VolumeAPI.RPC_DEFAULT_VERSION
    • VolumeAPI.TOPIC
    • VolumeAPI.accept_transfer()
    • VolumeAPI.attach_volume()
    • VolumeAPI.attachment_delete()
    • VolumeAPI.attachment_update()
    • VolumeAPI.copy_volume_to_image()
    • VolumeAPI.create_group()
    • VolumeAPI.create_group_from_src()
    • VolumeAPI.create_group_snapshot()
    • VolumeAPI.create_snapshot()
    • VolumeAPI.create_volume()
    • VolumeAPI.delete_group()
    • VolumeAPI.delete_group_snapshot()
    • VolumeAPI.delete_snapshot()
    • VolumeAPI.delete_volume()
    • VolumeAPI.detach_volume()
    • VolumeAPI.disable_replication()
    • VolumeAPI.do_cleanup()
    • VolumeAPI.enable_replication()
    • VolumeAPI.extend_volume()
    • VolumeAPI.failover()
    • VolumeAPI.failover_completed()
    • VolumeAPI.failover_replication()
    • VolumeAPI.freeze_host()
    • VolumeAPI.get_backup_device()
    • VolumeAPI.get_capabilities()
    • VolumeAPI.get_log_levels()
    • VolumeAPI.get_manageable_snapshots()
    • VolumeAPI.get_manageable_volumes()
    • VolumeAPI.initialize_connection()
    • VolumeAPI.initialize_connection_snapshot()
    • VolumeAPI.list_replication_targets()
    • VolumeAPI.manage_existing()
    • VolumeAPI.manage_existing_snapshot()
    • VolumeAPI.migrate_volume()
    • VolumeAPI.migrate_volume_completion()
    • VolumeAPI.publish_service_capabilities()
    • VolumeAPI.reimage()
    • VolumeAPI.remove_export()
    • VolumeAPI.remove_export_snapshot()
    • VolumeAPI.retype()
    • VolumeAPI.revert_to_snapshot()
    • VolumeAPI.secure_file_operations_enabled()
    • VolumeAPI.set_log_levels()
    • VolumeAPI.terminate_connection()
    • VolumeAPI.terminate_connection_snapshot()
    • VolumeAPI.thaw_host()
    • VolumeAPI.update_group()
    • VolumeAPI.update_migrated_volume()
• cinder.volume.throttling module
  • BlkioCgroup
    • BlkioCgroup.subcommand()
  • Throttle
    • Throttle.DEFAULT
    • Throttle.get_default()
    • Throttle.set_default()
    • Throttle.subcommand()
• cinder.volume.volume_migration module
  • VolumeMigration
    • VolumeMigration.from_volume()
    • VolumeMigration.save()
  • VolumeMigrationList
    • VolumeMigrationList.append()
• cinder.volume.volume_types module
  • add_volume_type_access()
  • create()
  • destroy()
  • get_all_types()
  • get_by_name_or_id()
  • get_default_volume_type()
  • get_volume_type()
  • get_volume_type_by_name()
  • get_volume_type_encryption()
  • get_volume_type_extra_specs()
  • get_volume_type_qos_specs()
  • is_encrypted()
  • is_public_volume_type()
  • notify_about_volume_type_access_usage()
  • provision_filter_on_size()
  • remove_volume_type_access()
  • update()
  • volume_types_diff()
  • volume_types_encryption_changed()
• cinder.volume.volume_utils module
  • TraceWrapperMetaclass
  • TraceWrapperWithABCMetaclass
  • append_host()
  • brick_attach_volume_encryptor()
  • brick_detach_volume_encryptor()
  • brick_get_connector()
  • brick_get_connector_properties()
  • brick_get_encryptor()
  • check_already_managed_volume()
  • check_encryption_provider()
  • check_for_odirect_support()
  • check_image_metadata()
  • clear_volume()
  • clone_encryption_key()
  • convert_config_string_to_dict()
  • copy_image_to_volume()
  • copy_volume()
  • create_encryption_key()
  • delete_encryption_key()
  • enable_bootable_flag()
  • extract_availability_zones_from_volume_type()
  • extract_host()
  • extract_id_from_snapshot_name()
  • extract_id_from_volume_name()
  • generate_password()
  • generate_username()
  • get_all_physical_volumes()
  • get_all_volume_groups()
  • get_backend_configuration()
  • get_base_image_ref()
  • get_max_over_subscription_ratio()
  • get_volume_image_metadata()
  • group_get_by_id()
  • hosts_are_equivalent()
  • image_conversion_dir()
  • is_all_zero()
  • is_boolean_str()
  • is_group_a_cg_snapshot_type()
  • is_group_a_type()
  • is_multiattach_spec()
  • is_replicated_spec()
  • log_unsupported_driver_warning()
  • matching_backend_name()
  • notify_about_backup_usage()
  • notify_about_capacity_usage()
  • notify_about_cgsnapshot_usage()
  • notify_about_consistencygroup_usage()
  • notify_about_group_snapshot_usage()
  • notify_about_group_usage()
  • notify_about_snapshot_usage()
  • notify_about_volume_usage()
  • null_safe_str()
  • paginate_entries_list()
  • require_driver_initialized()
  • resolve_hostname()
  • sanitize_host()
  • sanitize_hostname()
  • setup_tracing()
  • supports_thin_provisioning()
  • trace()
  • trace_api()
  • trace_method()
  • update_backup_error()
  • upload_volume()

Module contents

API(*args, **kwargs)