cinder package

Subpackages

• cinder.api package
  • Subpackages
    • cinder.api.contrib package
      • Submodules
      • Module contents
    • cinder.api.middleware package
      • Submodules
      • Module contents
    • cinder.api.openstack package
      • Submodules
      • Module contents
    • cinder.api.schemas package
      • Submodules
      • Module contents
    • cinder.api.v2 package
      • Subpackages
      • Submodules
      • Module contents
    • cinder.api.v3 package
      • Subpackages
      • Submodules
      • Module contents
    • cinder.api.validation package
      • Submodules
      • Module contents
    • cinder.api.views package
      • Submodules
      • Module contents
  • Submodules
    • cinder.api.api_utils module
      • GenericProjectInfo
      • add_visible_admin_metadata()
      • get_project()
      • is_none_string()
      • remove_invalid_filter_options()
      • validate_integer()
      • validate_project_and_authorize()
      • walk_class_hierarchy()
    • cinder.api.common module
      • METADATA_TYPES
      • ViewBuilder
      • convert_filter_attributes()
      • get_cluster_host()
      • get_enabled_resource_filters()
      • get_pagination_params()
      • get_request_url()
      • get_sort_params()
      • get_time_comparison_operators()
      • limited()
      • process_general_filtering()
      • reject_invalid_filters()
      • remove_version_from_href()
    • cinder.api.extensions module
      • ControllerExtension
      • ExtensionDescriptor
      • ExtensionManager
      • ExtensionsResource
      • ResourceExtension
      • extension_authorizer()
      • load_standard_extensions()
    • cinder.api.microversions module
      • get_api_version()
      • get_mv_header()
      • get_prior_version()
    • cinder.api.urlmap module
      • Accept
      • URLMap
      • parse_list_header()
      • parse_options_header()
      • unquote_header_value()
      • urlmap_factory()
    • cinder.api.versions module
      • Versions
      • VersionsController
      • create_resource()
  • Module contents
    • root_app_factory()
• cinder.backup package
  • Submodules
    • cinder.backup.api module
      • API
    • cinder.backup.chunkeddriver module
      • ChunkedBackupDriver
    • cinder.backup.driver module
      • BackupDriver
      • BackupMetadataAPI
    • cinder.backup.manager module
      • BackupManager
    • cinder.backup.rpcapi module
      • BackupAPI
  • Module contents
    • API()
• cinder.brick package
  • Subpackages
    • cinder.brick.local_dev package
      • Submodules
      • Module contents
  • Module contents
• cinder.cmd package
  • Submodules
    • cinder.cmd.api module
      • main()
    • cinder.cmd.backup module
      • main()
    • cinder.cmd.manage module
      • BackupCommands
      • BaseCommand
      • ClusterCommands
      • ConfigCommands
      • ConsistencyGroupCommands
      • DbCommands
      • HostCommands
      • QuotaCommands
      • ServiceCommands
      • UtilCommands
      • VersionCommands
      • VolumeCommands
      • add_command_parsers()
      • args()
      • fetch_func_args()
      • get_arg_string()
      • main()
      • methods_of()
      • missing_action()
    • cinder.cmd.rtstool module
      • RtstoolError
      • RtstoolImportError
      • add_initiator()
      • create()
      • delete()
      • delete_initiator()
      • get_targets()
      • main()
      • parse_optional_create()
      • restore_from_file()
      • save_to_file()
      • usage()
      • verify_rtslib()
    • cinder.cmd.scheduler module
      • main()
    • cinder.cmd.status module
      • Checks
      • main()
    • cinder.cmd.volume module
      • main()
    • cinder.cmd.volume_usage_audit module
      • main()
  • Module contents
• cinder.common package
  • Submodules
    • cinder.common.config module
      • set_external_library_defaults()
      • set_middleware_defaults()
    • cinder.common.constants module
    • cinder.common.sqlalchemyutils module
      • paginate_query()
  • Module contents
• cinder.compute package
  • Submodules
    • cinder.compute.nova module
      • API
      • novaclient()
  • Module contents
    • API()
• cinder.db package
  • Submodules
    • cinder.db.api module
      • Case
      • Condition
      • Not
      • attachment_destroy()
      • attachment_specs_delete()
      • attachment_specs_exist()
      • attachment_specs_get()
      • attachment_specs_update_or_create()
      • backup_create()
      • backup_destroy()
      • backup_get()
      • backup_get_all()
      • backup_get_all_active_by_window()
      • backup_get_all_by_host()
      • backup_get_all_by_project()
      • backup_get_all_by_volume()
      • backup_metadata_get()
      • backup_metadata_update()
      • backup_update()
      • calculate_resource_count()
      • cg_creating_from_src()
      • cg_has_cgsnapshot_filter()
      • cg_has_volumes_filter()
      • cgsnapshot_create()
      • cgsnapshot_creating_from_src()
      • cgsnapshot_destroy()
      • cgsnapshot_get()
      • cgsnapshot_get_all()
      • cgsnapshot_get_all_by_group()
      • cgsnapshot_get_all_by_project()
      • cgsnapshot_update()
      • cleanup_expired_messages()
      • cluster_create()
      • cluster_destroy()
      • cluster_get()
      • cluster_get_all()
      • cluster_update()
      • conditional_update()
      • consistencygroup_create()
      • consistencygroup_destroy()
      • consistencygroup_get()
      • consistencygroup_get_all()
      • consistencygroup_get_all_by_project()
      • consistencygroup_include_in_cluster()
      • consistencygroup_update()
      • dispose_engine()
      • driver_initiator_data_get()
      • driver_initiator_data_insert_by_key()
      • get_all_projects_with_default_type()
      • get_booleans_for_table()
      • get_by_id()
      • get_model_for_versioned_object()
      • get_projects()
      • get_snapshot_summary()
      • get_volume_summary()
      • group_create()
      • group_creating_from_src()
      • group_destroy()
      • group_get()
      • group_get_all()
      • group_get_all_by_project()
      • group_has_group_snapshot_filter()
      • group_has_volumes_filter()
      • group_include_in_cluster()
      • group_snapshot_create()
      • group_snapshot_creating_from_src()
      • group_snapshot_destroy()
      • group_snapshot_get()
      • group_snapshot_get_all()
      • group_snapshot_get_all_by_group()
      • group_snapshot_get_all_by_project()
      • group_snapshot_update()
      • group_type_access_add()
      • group_type_access_get_all()
      • group_type_access_remove()
      • group_type_create()
      • group_type_destroy()
      • group_type_get()
      • group_type_get_all()
      • group_type_get_by_name()
      • group_type_specs_delete()
      • group_type_specs_get()
      • group_type_specs_update_or_create()
      • group_type_update()
      • group_types_get_by_name_or_id()
      • group_update()
      • group_volume_type_mapping_create()
      • image_volume_cache_create()
      • image_volume_cache_delete()
      • image_volume_cache_get_all()
      • image_volume_cache_get_and_update_last_used()
      • image_volume_cache_get_by_volume_id()
      • image_volume_cache_include_in_cluster()
      • is_backend_frozen()
      • is_orm_value()
      • message_create()
      • message_destroy()
      • message_get()
      • message_get_all()
      • project_default_volume_type_get()
      • project_default_volume_type_set()
      • project_default_volume_type_unset()
      • purge_deleted_rows()
      • qos_specs_associate()
      • qos_specs_associations_get()
      • qos_specs_create()
      • qos_specs_delete()
      • qos_specs_disassociate()
      • qos_specs_disassociate_all()
      • qos_specs_get()
      • qos_specs_get_all()
      • qos_specs_get_by_name()
      • qos_specs_item_delete()
      • qos_specs_update()
      • quota_class_create()
      • quota_class_destroy()
      • quota_class_destroy_all_by_name()
      • quota_class_get()
      • quota_class_get_all_by_name()
      • quota_class_get_defaults()
      • quota_class_update()
      • quota_class_update_resource()
      • quota_create()
      • quota_destroy()
      • quota_destroy_by_project()
      • quota_get()
      • quota_get_all_by_project()
      • quota_reserve()
      • quota_update()
      • quota_update_resource()
      • quota_usage_get()
      • quota_usage_get_all_by_project()
      • quota_usage_update_resource()
      • remove_temporary_admin_metadata_data_migration()
      • reservation_commit()
      • reservation_expire()
      • reservation_rollback()
      • reset_active_backend()
      • resource_exists()
      • service_create()
      • service_destroy()
      • service_get()
      • service_get_all()
      • service_get_by_uuid()
      • service_update()
      • snapshot_create()
      • snapshot_data_get_for_project()
      • snapshot_destroy()
      • snapshot_get()
      • snapshot_get_all()
      • snapshot_get_all_active_by_window()
      • snapshot_get_all_by_host()
      • snapshot_get_all_by_project()
      • snapshot_get_all_for_cgsnapshot()
      • snapshot_get_all_for_group_snapshot()
      • snapshot_get_all_for_volume()
      • snapshot_get_latest_for_volume()
      • snapshot_metadata_delete()
      • snapshot_metadata_get()
      • snapshot_metadata_update()
      • snapshot_update()
      • transfer_accept()
      • transfer_create()
      • transfer_destroy()
      • transfer_get()
      • transfer_get_all()
      • transfer_get_all_by_project()
      • volume_admin_metadata_delete()
      • volume_admin_metadata_get()
      • volume_admin_metadata_update()
      • volume_attach()
      • volume_attached()
      • volume_attachment_get()
      • volume_attachment_get_all()
      • volume_attachment_get_all_by_host()
      • volume_attachment_get_all_by_instance_uuid()
      • volume_attachment_get_all_by_project()
      • volume_attachment_get_all_by_volume_id()
      • volume_attachment_update()
      • volume_create()
      • volume_data_get_for_host()
      • volume_data_get_for_project()
      • volume_destroy()
      • volume_detached()
      • volume_encryption_metadata_get()
      • volume_get()
      • volume_get_all()
      • volume_get_all_active_by_window()
      • volume_get_all_by_generic_group()
      • volume_get_all_by_group()
      • volume_get_all_by_host()
      • volume_get_all_by_project()
      • volume_glance_metadata_bulk_create()
      • volume_glance_metadata_copy_from_volume_to_volume()
      • volume_glance_metadata_copy_to_snapshot()
      • volume_glance_metadata_copy_to_volume()
      • volume_glance_metadata_create()
      • volume_glance_metadata_delete_by_snapshot()
      • volume_glance_metadata_delete_by_volume()
      • volume_glance_metadata_get()
      • volume_glance_metadata_get_all()
      • volume_glance_metadata_list_get()
      • volume_has_attachments_filter()
      • volume_has_other_project_snp_filter()
      • volume_has_snapshots_filter()
      • volume_has_snapshots_in_a_cgsnapshot_filter()
      • volume_has_undeletable_snapshots_filter()
      • volume_include_in_cluster()
      • volume_metadata_delete()
      • volume_metadata_get()
      • volume_metadata_update()
      • volume_qos_allows_retype()
      • volume_snapshot_glance_metadata_get()
      • volume_type_access_add()
      • volume_type_access_get_all()
      • volume_type_access_remove()
      • volume_type_create()
      • volume_type_destroy()
      • volume_type_encryption_create()
      • volume_type_encryption_delete()
      • volume_type_encryption_get()
      • volume_type_encryption_update()
      • volume_type_encryption_volume_get()
      • volume_type_extra_specs_delete()
      • volume_type_extra_specs_get()
      • volume_type_extra_specs_update_or_create()
      • volume_type_get()
      • volume_type_get_all()
      • volume_type_get_all_by_group()
      • volume_type_get_by_name()
      • volume_type_qos_associate()
      • volume_type_qos_associations_get()
      • volume_type_qos_disassociate()
      • volume_type_qos_disassociate_all()
      • volume_type_qos_specs_get()
      • volume_type_update()
      • volume_types_get_by_name_or_id()
      • volume_update()
      • volume_update_all_by_service()
      • volume_update_status_based_on_attachment()
      • volumes_update()
      • worker_claim_for_cleanup()
      • worker_create()
      • worker_destroy()
      • worker_get()
      • worker_get_all()
      • worker_update()
    • cinder.db.base module
      • Base
    • cinder.db.migration module
      • db_sync()
      • db_version()
  • Module contents
• cinder.group package
  • Submodules
    • cinder.group.api module
      • API
  • Module contents
• cinder.image package
  • Subpackages
    • cinder.image.accelerators package
      • Submodules
      • Module contents
  • Submodules
    • cinder.image.accelerator module
      • AccelBase
      • ImageAccel
      • is_gzip_compressed()
    • cinder.image.cache module
      • ImageVolumeCache
    • cinder.image.format_inspector module
      • CaptureRegion
      • FileInspector
      • ImageFormatError
      • InfoWrapper
      • QEDInspector
      • QcowInspector
      • TraceDisabled
      • VDIInspector
      • VHDInspector
      • VHDXInspector
      • VMDKInspector
      • chunked_reader()
      • detect_file_format()
      • get_inspector()
    • cinder.image.glance module
      • GlanceClientWrapper
      • GlanceImageService
      • get_api_servers()
      • get_default_image_service()
      • get_remote_image_service()
    • cinder.image.image_utils module
      • TemporaryImages
      • check_available_space()
      • check_image_conversion_disable()
      • check_image_format()
      • check_qcow2_image()
      • check_qemu_img_version()
      • check_virtual_size()
      • check_vmdk_image()
      • chown_if_needed()
      • cleanup_temporary_file()
      • coalesce_chain()
      • coalesce_vhd()
      • convert_image()
      • create_temporary_file()
      • decode_cipher()
      • discover_vhd_chain()
      • extract_targz()
      • fetch()
      • fetch_to_raw()
      • fetch_to_vhd()
      • fetch_to_volume_format()
      • fetch_verify_image()
      • filter_out_reserved_namespaces_metadata()
      • fix_vhd_chain()
      • fixup_disk_format()
      • from_qemu_img_disk_format()
      • get_qemu_data()
      • get_qemu_img_version()
      • get_vhd_size()
      • is_xenserver_format()
      • qemu_img_info()
      • replace_xenserver_image_with_coalesced_vhd()
      • resize_image()
      • resize_vhd()
      • set_vhd_parent()
      • temporary_dir()
      • temporary_file()
      • upload_volume()
      • validate_stores_id()
      • verify_glance_image_signature()
  • Module contents
• cinder.interface package
  • Submodules
    • cinder.interface.backup_chunked_driver module
      • BackupChunkedDriver
    • cinder.interface.backup_driver module
      • BackupDriver
    • cinder.interface.base module
      • CinderInterface
    • cinder.interface.fczm_driver module
      • FibreChannelZoneManagerDriver
    • cinder.interface.util module
      • DriverInfo
      • get_backup_drivers()
      • get_fczm_drivers()
      • get_volume_drivers()
    • cinder.interface.volume_consistencygroup_driver module
      • VolumeConsistencyGroupDriver
    • cinder.interface.volume_driver module
      • VolumeDriverCore
    • cinder.interface.volume_group_driver module
      • VolumeGroupDriver
    • cinder.interface.volume_manageable_driver module
      • VolumeListManageableDriver
      • VolumeManagementDriver
    • cinder.interface.volume_snapshot_revert module
      • VolumeSnapshotRevertDriver
    • cinder.interface.volume_snapshotmanagement_driver module
      • VolumeSnapshotManagementDriver
  • Module contents
    • backupdriver()
    • fczmdriver()
    • volumedriver()
• cinder.keymgr package
  • Submodules
    • cinder.keymgr.conf_key_mgr module
      • ConfKeyManager
    • cinder.keymgr.migration module
      • KeyMigrator
      • migrate_fixed_key()
    • cinder.keymgr.transfer module
      • KeyTransfer
      • transfer_accept()
      • transfer_create()
      • transfer_delete()
  • Module contents
• cinder.message package
  • Submodules
    • cinder.message.api module
      • API
    • cinder.message.defined_messages module
      • EventIds
      • get_message_text()
    • cinder.message.message_field module
      • Action
      • Detail
      • Resource
      • translate_action()
      • translate_detail()
      • translate_detail_id()
  • Module contents
• cinder.objects package
  • Submodules
    • cinder.objects.backup module
      • Backup
      • BackupDeviceInfo
      • BackupImport
      • BackupList
    • cinder.objects.base module
      • CinderComparableObject
      • CinderObject
      • CinderObjectDictCompat
      • CinderObjectRegistry
      • CinderObjectSerializer
      • CinderObjectVersionsHistory
      • CinderPersistentObject
      • ClusteredObject
      • ObjectListBase
    • cinder.objects.cgsnapshot module
      • CGSnapshot
      • CGSnapshotList
    • cinder.objects.cleanable module
      • CinderCleanableObject
    • cinder.objects.cleanup_request module
      • CleanupRequest
    • cinder.objects.cluster module
      • Cluster
      • ClusterList
    • cinder.objects.consistencygroup module
      • ConsistencyGroup
      • ConsistencyGroupList
    • cinder.objects.dynamic_log module
      • LogLevel
      • LogLevelList
    • cinder.objects.fields module
      • BackupStatus
      • BackupStatusField
      • BaseCinderEnum
      • ConsistencyGroupStatus
      • ConsistencyGroupStatusField
      • DictOfNullableField
      • GroupSnapshotStatus
      • GroupSnapshotStatusField
      • GroupStatus
      • GroupStatusField
      • QoSConsumerField
      • QoSConsumerValues
      • ReplicationStatus
      • ReplicationStatusField
      • SnapshotStatus
      • SnapshotStatusField
      • VolumeAttachStatus
      • VolumeAttachStatusField
      • VolumeMigrationStatus
      • VolumeMigrationStatusField
      • VolumeStatus
      • VolumeStatusField
    • cinder.objects.group module
      • Group
      • GroupList
    • cinder.objects.group_snapshot module
      • GroupSnapshot
      • GroupSnapshotList
    • cinder.objects.group_type module
      • GroupType
      • GroupTypeList
    • cinder.objects.manageableresources module
      • ManageableObject
      • ManageableSnapshot
      • ManageableSnapshotList
      • ManageableVolume
      • ManageableVolumeList
    • cinder.objects.qos_specs module
      • QualityOfServiceSpecs
      • QualityOfServiceSpecsList
    • cinder.objects.request_spec module
      • RequestSpec
      • VolumeProperties
    • cinder.objects.service module
      • Service
      • ServiceList
    • cinder.objects.snapshot module
      • Snapshot
      • SnapshotList
    • cinder.objects.volume module
      • MetadataObject
      • Volume
      • VolumeList
    • cinder.objects.volume_attachment module
      • VolumeAttachment
      • VolumeAttachmentList
    • cinder.objects.volume_type module
      • VolumeType
      • VolumeTypeList
  • Module contents
    • register_all()
• cinder.policies package
  • Submodules
    • cinder.policies.attachments module
      • list_rules()
    • cinder.policies.backup_actions module
      • list_rules()
    • cinder.policies.backups module
      • list_rules()
    • cinder.policies.base module
      • CinderDeprecatedRule
      • list_rules()
    • cinder.policies.capabilities module
      • list_rules()
    • cinder.policies.clusters module
      • list_rules()
    • cinder.policies.default_types module
      • list_rules()
    • cinder.policies.group_actions module
      • list_rules()
    • cinder.policies.group_snapshot_actions module
      • list_rules()
    • cinder.policies.group_snapshots module
      • list_rules()
    • cinder.policies.group_types module
      • list_rules()
    • cinder.policies.groups module
      • list_rules()
    • cinder.policies.hosts module
      • list_rules()
    • cinder.policies.limits module
      • list_rules()
    • cinder.policies.manageable_snapshots module
      • list_rules()
    • cinder.policies.manageable_volumes module
      • list_rules()
    • cinder.policies.messages module
      • list_rules()
    • cinder.policies.qos_specs module
      • list_rules()
    • cinder.policies.quota_class module
      • list_rules()
    • cinder.policies.quotas module
      • list_rules()
    • cinder.policies.scheduler_stats module
      • list_rules()
    • cinder.policies.services module
      • list_rules()
    • cinder.policies.snapshot_actions module
      • list_rules()
    • cinder.policies.snapshot_metadata module
      • list_rules()
    • cinder.policies.snapshots module
      • list_rules()
    • cinder.policies.type_extra_specs module
      • list_rules()
    • cinder.policies.volume_access module
      • list_rules()
    • cinder.policies.volume_actions module
      • list_rules()
    • cinder.policies.volume_metadata module
      • list_rules()
    • cinder.policies.volume_transfer module
      • list_rules()
    • cinder.policies.volume_type module
      • list_rules()
    • cinder.policies.volumes module
      • list_rules()
    • cinder.policies.workers module
      • list_rules()
  • Module contents
    • list_rules()
• cinder.privsep package
  • Subpackages
    • cinder.privsep.targets package
      • Submodules
      • Module contents
  • Submodules
    • cinder.privsep.cgroup module
    • cinder.privsep.format_inspector module
    • cinder.privsep.fs module
    • cinder.privsep.lvm module
    • cinder.privsep.path module
  • Module contents
• cinder.scheduler package
  • Subpackages
    • cinder.scheduler.evaluator package
      • Submodules
      • Module contents
    • cinder.scheduler.filters package
      • Submodules
      • Module contents
    • cinder.scheduler.flows package
      • Submodules
      • Module contents
    • cinder.scheduler.weights package
      • Submodules
      • Module contents
  • Submodules
    • cinder.scheduler.base_filter module
      • BaseFilter
      • BaseFilterHandler
    • cinder.scheduler.base_handler module
      • BaseHandler
    • cinder.scheduler.base_weight module
      • BaseWeigher
      • BaseWeightHandler
      • WeighedObject
      • normalize()
    • cinder.scheduler.driver module
      • Scheduler
      • generic_group_update_db()
      • volume_update_db()
    • cinder.scheduler.filter_scheduler module
      • FilterScheduler
    • cinder.scheduler.host_manager module
      • BackendState
      • HostManager
      • PoolState
      • ReadOnlyDict
    • cinder.scheduler.manager module
      • SchedulerManager
      • append_operation_type()
    • cinder.scheduler.rpcapi module
      • SchedulerAPI
    • cinder.scheduler.scheduler_options module
      • SchedulerOptions
  • Module contents
• cinder.transfer package
  • Submodules
    • cinder.transfer.api module
      • API
  • Module contents
• cinder.volume package
  • Subpackages
    • cinder.volume.flows package
      • Subpackages
      • Submodules
      • Module contents
    • cinder.volume.targets package
      • Submodules
      • Module contents
  • Submodules
    • cinder.volume.api module
      • API
      • HostAPI
    • cinder.volume.configuration module
      • BackendGroupConfiguration
      • Configuration
      • DefaultGroupConfiguration
    • cinder.volume.driver module
      • BaseVD
      • CloneableImageVD
      • FibreChannelDriver
      • ISCSIDriver
      • ISERDriver
      • ManageableSnapshotsVD
      • ManageableVD
      • MigrateVD
      • ProxyVD
      • VolumeDriver
    • cinder.volume.driver_utils module
      • VolumeDriverUtils
    • 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
      • 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
    • cinder.volume.throttling module
      • BlkioCgroup
      • Throttle
    • cinder.volume.volume_migration module
      • VolumeMigration
      • VolumeMigrationList
    • 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()
• cinder.wsgi package
  • Submodules
    • cinder.wsgi.common module
      • Application
      • Middleware
      • Request
    • cinder.wsgi.eventlet_server module
      • Server
    • cinder.wsgi.wsgi module
      • initialize_application()
  • Module contents
• cinder.zonemanager package
  • Submodules
    • cinder.zonemanager.fc_common module
      • FCCommon
    • cinder.zonemanager.fc_san_lookup_service module
      • FCSanLookupService
    • cinder.zonemanager.fc_zone_manager module
      • ZoneManager
    • cinder.zonemanager.fczm_constants module
    • cinder.zonemanager.utils module
      • add_fc_zone()
      • create_lookup_service()
      • create_zone_manager()
      • get_formatted_wwn()
      • remove_fc_zone()
  • Module contents

Submodules

• cinder.context module
  • RequestContext
    • RequestContext.authorize()
    • RequestContext.connection
    • RequestContext.deepcopy()
    • RequestContext.elevated()
    • RequestContext.from_dict()
    • RequestContext.get_auth_plugin()
    • RequestContext.read_deleted
    • RequestContext.session
    • RequestContext.to_dict()
    • RequestContext.to_policy_values()
    • RequestContext.transaction
    • RequestContext.transaction_ctx
  • get_admin_context()
  • get_internal_tenant_context()
• cinder.coordination module
  • Coordinator
    • Coordinator.get_lock()
    • Coordinator.remove_lock()
    • Coordinator.start()
    • Coordinator.stop()
  • synchronized()
  • synchronized_remove()
• cinder.exception module
  • APIException
    • APIException.message
  • APITimeout
    • APITimeout.message
  • AdminRequired
    • AdminRequired.message
  • AttachmentSpecsNotFound
    • AttachmentSpecsNotFound.message
  • BackupDriverException
    • BackupDriverException.message
  • BackupInvalidCephArgs
    • BackupInvalidCephArgs.message
  • BackupLimitExceeded
    • BackupLimitExceeded.message
  • BackupMetadataNotFound
    • BackupMetadataNotFound.message
  • BackupMetadataUnsupportedVersion
    • BackupMetadataUnsupportedVersion.message
  • BackupNotFound
    • BackupNotFound.message
  • BackupOperationError
    • BackupOperationError.message
  • BackupRBDOperationFailed
    • BackupRBDOperationFailed.message
  • BackupRestoreCancel
    • BackupRestoreCancel.message
  • BadHTTPResponseStatus
    • BadHTTPResponseStatus.message
  • BadResetResourceStatus
    • BadResetResourceStatus.message
  • CappedVersionUnknown
    • CappedVersionUnknown.message
  • CgSnapshotNotFound
    • CgSnapshotNotFound.message
  • CinderAcceleratorError
    • CinderAcceleratorError.message
  • CinderException
    • CinderException.code
    • CinderException.headers
    • CinderException.message
    • CinderException.safe
  • CleanableInUse
    • CleanableInUse.message
  • ClusterExists
    • ClusterExists.message
  • ClusterHasHosts
    • ClusterHasHosts.message
  • ClusterNotFound
    • ClusterNotFound.message
  • ConfigNotFound
    • ConfigNotFound.message
  • ConflictNovaUsingAttachment
    • ConflictNovaUsingAttachment.code
    • ConflictNovaUsingAttachment.message
    • ConflictNovaUsingAttachment.safe
  • ConsistencyGroupNotFound
    • ConsistencyGroupNotFound.message
  • ConvertedException
  • DeviceUnavailable
    • DeviceUnavailable.message
  • DriverInitiatorDataExists
    • DriverInitiatorDataExists.message
  • DriverNotInitialized
    • DriverNotInitialized.message
  • Duplicate
  • EncryptedBackupOperationFailed
    • EncryptedBackupOperationFailed.message
  • EvaluatorParseException
    • EvaluatorParseException.message
  • ExportFailure
    • ExportFailure.message
  • ExtendVolumeError
    • ExtendVolumeError.message
  • FCSanLookupServiceException
    • FCSanLookupServiceException.message
  • FCZoneDriverException
    • FCZoneDriverException.message
  • FailedCmdWithDump
    • FailedCmdWithDump.message
  • FileNotFound
    • FileNotFound.message
  • GlanceConnectionFailed
    • GlanceConnectionFailed.message
  • GlanceMetadataExists
    • GlanceMetadataExists.message
  • GlanceMetadataNotFound
    • GlanceMetadataNotFound.message
  • GlanceStoreNotFound
    • GlanceStoreNotFound.message
  • GlanceStoreReadOnly
    • GlanceStoreReadOnly.message
  • GroupLimitExceeded
    • GroupLimitExceeded.message
  • GroupNotFound
    • GroupNotFound.message
  • GroupSnapshotNotFound
    • GroupSnapshotNotFound.message
  • GroupTypeAccessExists
    • GroupTypeAccessExists.message
  • GroupTypeAccessNotFound
    • GroupTypeAccessNotFound.message
  • GroupTypeCreateFailed
    • GroupTypeCreateFailed.message
  • GroupTypeExists
    • GroupTypeExists.message
  • GroupTypeInUse
    • GroupTypeInUse.message
  • GroupTypeNotFound
    • GroupTypeNotFound.message
  • GroupTypeNotFoundByName
    • GroupTypeNotFoundByName.message
  • GroupTypeSpecsNotFound
    • GroupTypeSpecsNotFound.message
  • GroupTypeUpdateFailed
    • GroupTypeUpdateFailed.message
  • GroupVolumeTypeMappingExists
    • GroupVolumeTypeMappingExists.message
  • HostNotFound
    • HostNotFound.message
  • ISCSITargetAttachFailed
    • ISCSITargetAttachFailed.message
  • ISCSITargetCreateFailed
    • ISCSITargetCreateFailed.message
  • ISCSITargetDetachFailed
    • ISCSITargetDetachFailed.message
  • ISCSITargetHelperCommandFailed
    • ISCSITargetHelperCommandFailed.message
  • ISCSITargetRemoveFailed
    • ISCSITargetRemoveFailed.message
  • ImageCompressionNotAllowed
    • ImageCompressionNotAllowed.message
  • ImageConversionNotAllowed
    • ImageConversionNotAllowed.message
  • ImageCopyFailure
    • ImageCopyFailure.message
  • ImageDownloadFailed
    • ImageDownloadFailed.message
  • ImageLimitExceeded
    • ImageLimitExceeded.message
  • ImageNotAuthorized
    • ImageNotAuthorized.message
  • ImageNotFound
    • ImageNotFound.message
  • ImageSignatureVerificationException
    • ImageSignatureVerificationException.message
  • ImageTooBig
    • ImageTooBig.message
  • ImageUnacceptable
    • ImageUnacceptable.message
  • Invalid
    • Invalid.code
    • Invalid.message
  • InvalidAPIVersionString
    • InvalidAPIVersionString.message
  • InvalidAuthKey
    • InvalidAuthKey.message
  • InvalidAvailabilityZone
    • InvalidAvailabilityZone.message
  • InvalidBackup
    • InvalidBackup.message
  • InvalidCgSnapshot
    • InvalidCgSnapshot.message
  • InvalidConfigurationValue
    • InvalidConfigurationValue.message
  • InvalidConnectorException
    • InvalidConnectorException.message
  • InvalidConsistencyGroup
    • InvalidConsistencyGroup.message
  • InvalidContentType
    • InvalidContentType.message
  • InvalidGlobalAPIVersion
    • InvalidGlobalAPIVersion.message
  • InvalidGroup
    • InvalidGroup.message
  • InvalidGroupSnapshot
    • InvalidGroupSnapshot.message
  • InvalidGroupSnapshotStatus
    • InvalidGroupSnapshotStatus.message
  • InvalidGroupStatus
    • InvalidGroupStatus.message
  • InvalidGroupType
    • InvalidGroupType.message
  • InvalidHost
    • InvalidHost.message
  • InvalidImageRef
    • InvalidImageRef.message
  • InvalidInput
    • InvalidInput.message
  • InvalidMetadataType
    • InvalidMetadataType.message
  • InvalidName
    • InvalidName.message
  • InvalidParameterValue
    • InvalidParameterValue.message
  • InvalidQoSSpecs
    • InvalidQoSSpecs.message
  • InvalidQuotaValue
    • InvalidQuotaValue.message
  • InvalidReplicationTarget
    • InvalidReplicationTarget.message
  • InvalidReservationExpiration
    • InvalidReservationExpiration.message
  • InvalidResults
    • InvalidResults.message
  • InvalidSignatureImage
    • InvalidSignatureImage.message
  • InvalidSnapshot
    • InvalidSnapshot.message
  • InvalidTypeAvailabilityZones
    • InvalidTypeAvailabilityZones.message
  • InvalidUUID
    • InvalidUUID.message
  • InvalidVolume
    • InvalidVolume.message
  • InvalidVolumeAttachMode
    • InvalidVolumeAttachMode.message
  • InvalidVolumeMetadata
    • InvalidVolumeMetadata.message
  • InvalidVolumeMetadataSize
    • InvalidVolumeMetadataSize.message
  • InvalidVolumeType
    • InvalidVolumeType.message
  • KeyManagerError
    • KeyManagerError.message
  • LockCreationFailed
    • LockCreationFailed.message
  • MalformedRequestBody
    • MalformedRequestBody.message
  • MalformedResponse
    • MalformedResponse.message
  • ManageExistingAlreadyManaged
    • ManageExistingAlreadyManaged.message
  • ManageExistingInvalidReference
    • ManageExistingInvalidReference.message
  • ManageExistingVolumeTypeMismatch
    • ManageExistingVolumeTypeMismatch.message
  • MessageNotFound
    • MessageNotFound.message
  • MetadataAbsent
    • MetadataAbsent.message
  • MetadataCopyFailure
    • MetadataCopyFailure.message
  • MetadataUpdateFailure
    • MetadataUpdateFailure.message
  • NfsException
    • NfsException.message
  • NfsNoSharesMounted
    • NfsNoSharesMounted.message
  • NfsNoSuitableShareFound
    • NfsNoSuitableShareFound.message
  • NoValidBackend
    • NoValidBackend.message
  • NotAuthorized
    • NotAuthorized.code
    • NotAuthorized.message
  • NotFound
    • NotFound.code
    • NotFound.message
    • NotFound.safe
  • NotSupportedOperation
    • NotSupportedOperation.code
    • NotSupportedOperation.message
  • OverQuota
    • OverQuota.message
  • ParameterNotFound
    • ParameterNotFound.message
  • PolicyNotAuthorized
    • PolicyNotAuthorized.message
  • ProgrammingError
    • ProgrammingError.message
  • ProjectQuotaNotFound
    • ProjectQuotaNotFound.message
  • QoSSpecsAssociateFailed
    • QoSSpecsAssociateFailed.message
  • QoSSpecsCreateFailed
    • QoSSpecsCreateFailed.message
  • QoSSpecsDisassociateFailed
    • QoSSpecsDisassociateFailed.message
  • QoSSpecsExists
    • QoSSpecsExists.message
  • QoSSpecsInUse
    • QoSSpecsInUse.message
  • QoSSpecsKeyNotFound
    • QoSSpecsKeyNotFound.message
  • QoSSpecsNotFound
    • QoSSpecsNotFound.message
  • QoSSpecsUpdateFailed
    • QoSSpecsUpdateFailed.message
  • QuotaClassNotFound
    • QuotaClassNotFound.message
  • QuotaError
    • QuotaError.code
    • QuotaError.headers
    • QuotaError.message
    • QuotaError.safe
  • QuotaNotFound
    • QuotaNotFound.message
  • QuotaResourceUnknown
    • QuotaResourceUnknown.message
  • QuotaUsageNotFound
    • QuotaUsageNotFound.message
  • RPCTimeout
    • RPCTimeout.code
    • RPCTimeout.message
  • RekeyNotSupported
    • RekeyNotSupported.message
  • RemoteFSConcurrentRequest
    • RemoteFSConcurrentRequest.message
  • RemoteFSException
    • RemoteFSException.message
  • RemoteFSInvalidBackingFile
    • RemoteFSInvalidBackingFile.message
  • RemoteFSNoSharesMounted
    • RemoteFSNoSharesMounted.message
  • RemoteFSNoSuitableShareFound
    • RemoteFSNoSuitableShareFound.message
  • RemoveExportException
    • RemoveExportException.message
  • ReplicationError
    • ReplicationError.message
  • ReplicationGroupError
    • ReplicationGroupError.message
  • RequirementMissing
    • RequirementMissing.message
  • SSHInjectionThreat
    • SSHInjectionThreat.message
  • SchedulerHostFilterNotFound
    • SchedulerHostFilterNotFound.message
  • SchedulerHostWeigherNotFound
    • SchedulerHostWeigherNotFound.message
  • ServerNotFound
    • ServerNotFound.message
  • ServiceNotFound
  • ServiceTooOld
    • ServiceTooOld.message
  • ServiceUnavailable
    • ServiceUnavailable.message
  • ServiceUserTokenNoAuth
    • ServiceUserTokenNoAuth.message
  • SnapshotIsBusy
    • SnapshotIsBusy.message
  • SnapshotLimitExceeded
    • SnapshotLimitExceeded.message
  • SnapshotLimitReached
    • SnapshotLimitReached.message
  • SnapshotMetadataNotFound
    • SnapshotMetadataNotFound.message
  • SnapshotNotFound
    • SnapshotNotFound.message
  • SnapshotUnavailable
    • SnapshotUnavailable.message
  • SwiftConnectionFailed
    • SwiftConnectionFailed.message
  • TargetUpdateFailed
    • TargetUpdateFailed.message
  • TransferNotFound
    • TransferNotFound.message
  • UnableToFailOver
    • UnableToFailOver.message
  • UnavailableDuringUpgrade
    • UnavailableDuringUpgrade.message
  • UnexpectedOverQuota
    • UnexpectedOverQuota.message
  • UnknownCmd
    • UnknownCmd.message
  • ValidationError
    • ValidationError.message
  • VersionNotFoundForAPIMethod
    • VersionNotFoundForAPIMethod.message
  • VolumeAttached
    • VolumeAttached.message
  • VolumeAttachmentNotFound
    • VolumeAttachmentNotFound.message
  • VolumeBackendAPIException
    • VolumeBackendAPIException.message
  • VolumeBackupSizeExceedsAvailableQuota
    • VolumeBackupSizeExceedsAvailableQuota.message
  • VolumeDeviceNotFound
    • VolumeDeviceNotFound.message
  • VolumeDriverException
    • VolumeDriverException.message
  • VolumeGroupCreationFailed
    • VolumeGroupCreationFailed.message
  • VolumeGroupNotFound
    • VolumeGroupNotFound.message
  • VolumeIsBusy
    • VolumeIsBusy.message
  • VolumeLimitExceeded
    • VolumeLimitExceeded.message
  • VolumeMetadataBackupExists
    • VolumeMetadataBackupExists.message
  • VolumeMetadataNotFound
    • VolumeMetadataNotFound.message
  • VolumeMigrationFailed
    • VolumeMigrationFailed.message
  • VolumeNotDeactivated
    • VolumeNotDeactivated.message
  • VolumeNotFound
    • VolumeNotFound.message
  • VolumeSizeExceedsAvailableQuota
    • VolumeSizeExceedsAvailableQuota.message
  • VolumeSizeExceedsLimit
    • VolumeSizeExceedsLimit.message
  • VolumeSnapshotNotFound
    • VolumeSnapshotNotFound.message
  • VolumeTypeAccessExists
    • VolumeTypeAccessExists.message
  • VolumeTypeAccessNotFound
    • VolumeTypeAccessNotFound.message
  • VolumeTypeCreateFailed
    • VolumeTypeCreateFailed.message
  • VolumeTypeDefaultDeletionError
    • VolumeTypeDefaultDeletionError.message
  • VolumeTypeDefaultMisconfiguredError
    • VolumeTypeDefaultMisconfiguredError.message
  • VolumeTypeDeletionError
    • VolumeTypeDeletionError.message
  • VolumeTypeEncryptionExists
    • VolumeTypeEncryptionExists.message
  • VolumeTypeEncryptionNotFound
    • VolumeTypeEncryptionNotFound.message
  • VolumeTypeExists
    • VolumeTypeExists.message
  • VolumeTypeExtraSpecsNotFound
    • VolumeTypeExtraSpecsNotFound.message
  • VolumeTypeInUse
    • VolumeTypeInUse.message
  • VolumeTypeNotFound
    • VolumeTypeNotFound.message
  • VolumeTypeNotFoundByName
    • VolumeTypeNotFoundByName.message
  • VolumeTypeProjectDefaultNotFound
    • VolumeTypeProjectDefaultNotFound.message
  • VolumeTypeUpdateFailed
    • VolumeTypeUpdateFailed.message
  • WorkerExists
    • WorkerExists.message
  • WorkerNotFound
    • WorkerNotFound.message
  • ZoneManagerException
    • ZoneManagerException.message
  • ZoneManagerNotInitialized
    • ZoneManagerNotInitialized.message
• cinder.flow_utils module
  • CinderTask
    • CinderTask.make_name()
  • DynamicLogListener
  • SpecialFormatter
    • SpecialFormatter.format()
• cinder.i18n module
  • enable_lazy()
  • get_available_languages()
  • translate()
• cinder.manager module
  • CleanableManager
    • CleanableManager.do_cleanup()
    • CleanableManager.init_host()
  • Manager
    • Manager.RPC_API_VERSION
    • Manager.get_log_levels()
    • Manager.init_host()
    • Manager.init_host_with_rpc()
    • Manager.is_working()
    • Manager.reset()
    • Manager.service_topic_queue
    • Manager.set_log_levels()
    • Manager.target
  • PeriodicTasks
  • SchedulerDependentManager
    • SchedulerDependentManager.reset()
    • SchedulerDependentManager.update_service_capabilities()
  • ThreadPoolManager
• cinder.opts module
  • list_opts()
• cinder.policy module
  • authorize()
  • check_is_admin()
  • enforce()
  • get_enforcer()
  • get_rules()
  • init()
  • register_rules()
  • reset()
  • set_rules()
• cinder.quota module
  • BaseResource
    • BaseResource.default
    • BaseResource.quota()
  • DbQuotaDriver
    • DbQuotaDriver.commit()
    • DbQuotaDriver.destroy_by_project()
    • DbQuotaDriver.expire()
    • DbQuotaDriver.get_by_class()
    • DbQuotaDriver.get_by_project()
    • DbQuotaDriver.get_class_quotas()
    • DbQuotaDriver.get_default()
    • DbQuotaDriver.get_defaults()
    • DbQuotaDriver.get_project_quotas()
    • DbQuotaDriver.limit_check()
    • DbQuotaDriver.reserve()
    • DbQuotaDriver.rollback()
  • GroupQuotaEngine
    • GroupQuotaEngine.register_resource()
    • GroupQuotaEngine.register_resources()
    • GroupQuotaEngine.resources
  • QuotaEngine
    • QuotaEngine.add_volume_type_opts()
    • QuotaEngine.commit()
    • QuotaEngine.destroy_by_project()
    • QuotaEngine.expire()
    • QuotaEngine.get_by_class()
    • QuotaEngine.get_by_project()
    • QuotaEngine.get_by_project_or_default()
    • QuotaEngine.get_class_quotas()
    • QuotaEngine.get_default()
    • QuotaEngine.get_defaults()
    • QuotaEngine.get_project_quotas()
    • QuotaEngine.limit_check()
    • QuotaEngine.register_resource()
    • QuotaEngine.register_resources()
    • QuotaEngine.reserve()
    • QuotaEngine.resource_names
    • QuotaEngine.resources
    • QuotaEngine.rollback()
  • ReservableResource
  • VolumeTypeQuotaEngine
    • VolumeTypeQuotaEngine.register_resource()
    • VolumeTypeQuotaEngine.register_resources()
    • VolumeTypeQuotaEngine.resources
    • VolumeTypeQuotaEngine.update_quota_resource()
  • VolumeTypeResource
• cinder.quota_utils module
  • get_volume_type_reservation()
  • process_reserve_over_quota()
• cinder.rpc module
  • RequestContextSerializer
    • RequestContextSerializer.deserialize_context()
    • RequestContextSerializer.deserialize_entity()
    • RequestContextSerializer.serialize_context()
    • RequestContextSerializer.serialize_entity()
  • add_extra_exmods()
  • cleanup()
  • clear_extra_exmods()
  • get_allowed_exmods()
  • get_client()
  • get_notifier()
  • get_server()
  • init()
  • set_defaults()
• cinder.service module
  • Launcher
  • Service
    • Service.basic_config_check()
    • Service.create()
    • Service.periodic_tasks()
    • Service.report_state()
    • Service.reset()
    • Service.service_id
    • Service.start()
    • Service.stop()
    • Service.wait()
  • WSGIService
    • WSGIService.reset()
    • WSGIService.start()
    • WSGIService.stop()
    • WSGIService.wait()
  • WindowsProcessLauncher
    • WindowsProcessLauncher.add_process()
    • WindowsProcessLauncher.wait()
  • get_launcher()
  • process_launcher()
  • serve()
  • setup_profiler()
  • wait()
• cinder.service_auth module
  • get_auth_plugin()
  • get_service_auth_plugin()
  • get_service_session()
  • reset_globals()
• cinder.ssh_utils module
  • SSHPool
    • SSHPool.create()
    • SSHPool.get()
    • SSHPool.put()
    • SSHPool.remove()
• cinder.utils module
  • ComparableMixin
  • DoNothing
  • Semaphore
  • api_clean_volume_file_locks()
  • as_int()
  • build_or_str()
  • calculate_capacity_factors()
  • calculate_max_over_subscription_ratio()
  • calculate_virtual_free_capacity()
  • check_exclusive_options()
  • check_metadata_properties()
  • check_ssh_injection()
  • check_string_length()
  • clean_snapshot_file_locks()
  • clean_volume_file_locks()
  • convert_str()
  • create_ordereddict()
  • execute()
  • get_blkdev_major_minor()
  • get_bool_param()
  • get_file_gid()
  • get_file_mode()
  • get_file_size()
  • get_log_levels()
  • get_log_method()
  • get_root_helper()
  • if_notifications_enabled()
  • is_blk_device()
  • last_completed_audit_period()
  • limit_operations()
  • make_dev_path()
  • monkey_patch()
  • notifications_enabled()
  • paths_normcase_equal()
  • retry()
  • retry_if_exit_code
  • robust_file_write()
  • semaphore_factory()
  • service_expired_time()
  • set_log_levels()
  • tempdir()
  • temporary_chown()
  • validate_dictionary_string_length()
• cinder.version module

Module contents

Root Cinder module.