The following is an overview of all available policies in Cinder.
context_is_admin
Default: | role:admin |
---|
Decides what is required for the ‘is_admin:True’ check to succeed.
admin_or_owner
Default: | is_admin:True or (role:admin and is_admin_project:True) or project_id:%(project_id)s |
---|
Default rule for most non-Admin APIs.
admin_api
Default: | is_admin:True or (role:admin and is_admin_project:True) |
---|
Default rule for most Admin APIs.
volume:attachment_create
Default: | <empty string> |
---|---|
Operations: |
|
Create attachment.
volume:attachment_update
Default: |
|
---|---|
Operations: |
|
Update attachment.
volume:attachment_delete
Default: |
|
---|---|
Operations: |
|
Delete attachment.
volume:attachment_complete
Default: |
|
---|---|
Operations: |
|
Mark a volume attachment process as completed (in-use)
volume:multiattach_bootable_volume
Default: |
|
---|---|
Operations: |
|
Allow multiattach of bootable volumes.
message:get_all
Default: |
|
---|---|
Operations: |
|
List messages.
message:get
Default: |
|
---|---|
Operations: |
|
Show message.
message:delete
Default: |
|
---|---|
Operations: |
|
Delete message.
clusters:get_all
Default: |
|
---|---|
Operations: |
|
List clusters.
clusters:get
Default: |
|
---|---|
Operations: |
|
Show cluster.
clusters:update
Default: |
|
---|---|
Operations: |
|
Update cluster.
workers:cleanup
Default: |
|
---|---|
Operations: |
|
Clean up workers.
volume:get_snapshot_metadata
Default: |
|
---|---|
Operations: |
|
Show snapshot’s metadata or one specified metadata with a given key.
volume:update_snapshot_metadata
Default: |
|
---|---|
Operations: |
|
Update snapshot’s metadata or one specified metadata with a given key.
volume:delete_snapshot_metadata
Default: |
|
---|---|
Operations: |
|
Delete snapshot’s specified metadata with a given key.
volume:get_all_snapshots
Default: |
|
---|---|
Operations: |
|
List snapshots.
volume_extension:extended_snapshot_attributes
Default: |
|
---|---|
Operations: |
|
List or show snapshots with extended attributes.
volume:create_snapshot
Default: |
|
---|---|
Operations: |
|
Create snapshot.
volume:get_snapshot
Default: |
|
---|---|
Operations: |
|
Show snapshot.
volume:update_snapshot
Default: |
|
---|---|
Operations: |
|
Update snapshot.
volume:delete_snapshot
Default: |
|
---|---|
Operations: |
|
Delete snapshot.
volume_extension:snapshot_admin_actions:reset_status
Default: |
|
---|---|
Operations: |
|
Reset status of a snapshot.
snapshot_extension:snapshot_actions:update_snapshot_status
Default: | <empty string> |
---|---|
Operations: |
|
Update database fields of snapshot.
volume_extension:snapshot_admin_actions:force_delete
Default: |
|
---|---|
Operations: |
|
Force delete a snapshot.
snapshot_extension:list_manageable
Default: |
|
---|---|
Operations: |
|
List (in detail) of snapshots which are available to manage.
snapshot_extension:snapshot_manage
Default: |
|
---|---|
Operations: |
|
Manage an existing snapshot.
snapshot_extension:snapshot_unmanage
Default: |
|
---|---|
Operations: |
|
Stop managing a snapshot.
backup:get_all
Default: |
|
---|---|
Operations: |
|
List backups.
backup:backup_project_attribute
Default: |
|
---|---|
Operations: |
|
List backups or show backup with project attributes.
backup:create
Default: | <empty string> |
---|---|
Operations: |
|
Create backup.
backup:get
Default: |
|
---|---|
Operations: |
|
Show backup.
backup:update
Default: |
|
---|---|
Operations: |
|
Update backup.
backup:delete
Default: |
|
---|---|
Operations: |
|
Delete backup.
backup:restore
Default: |
|
---|---|
Operations: |
|
Restore backup.
backup:backup-import
Default: |
|
---|---|
Operations: |
|
Import backup.
backup:export-import
Default: |
|
---|---|
Operations: |
|
Export backup.
volume_extension:backup_admin_actions:reset_status
Default: |
|
---|---|
Operations: |
|
Reset status of a backup.
volume_extension:backup_admin_actions:force_delete
Default: |
|
---|---|
Operations: |
|
Force delete a backup.
group:get_all
Default: |
|
---|---|
Operations: |
|
List groups.
group:create
Default: | <empty string> |
---|---|
Operations: |
|
Create group.
group:get
Default: |
|
---|---|
Operations: |
|
Show group.
group:update
Default: |
|
---|---|
Operations: |
|
Update group.
group:group_project_attribute
Default: |
|
---|---|
Operations: |
|
List groups or show group with project attributes.
group:group_types_manage
Default: |
|
---|---|
Operations: |
|
Create, update or delete a group type.
group:access_group_types_specs
Default: |
|
---|---|
Operations: |
|
Show group type with type specs attributes.
group:group_types_specs
Default: |
|
---|---|
Operations: |
|
Create, show, update and delete group type spec.
group:get_all_group_snapshots
Default: |
|
---|---|
Operations: |
|
List group snapshots.
group:create_group_snapshot
Default: | <empty string> |
---|---|
Operations: |
|
Create group snapshot.
group:get_group_snapshot
Default: |
|
---|---|
Operations: |
|
Show group snapshot.
group:delete_group_snapshot
Default: |
|
---|---|
Operations: |
|
Delete group snapshot.
group:update_group_snapshot
Default: |
|
---|---|
Operations: |
|
Update group snapshot.
group:group_snapshot_project_attribute
Default: |
|
---|---|
Operations: |
|
List group snapshots or show group snapshot with project attributes.
group:reset_group_snapshot_status
Default: |
|
---|---|
Operations: |
|
Reset status of group snapshot.
group:delete
Default: |
|
---|---|
Operations: |
|
Delete group.
group:reset_status
Default: |
|
---|---|
Operations: |
|
Reset status of group.
group:enable_replication
Default: |
|
---|---|
Operations: |
|
Enable replication.
group:disable_replication
Default: |
|
---|---|
Operations: |
|
Disable replication.
group:failover_replication
Default: |
|
---|---|
Operations: |
|
Fail over replication.
group:list_replication_targets
Default: |
|
---|---|
Operations: |
|
List failover replication.
volume_extension:qos_specs_manage:get_all
Default: |
|
---|---|
Operations: |
|
List qos specs or list all associations.
volume_extension:qos_specs_manage:get
Default: |
|
---|---|
Operations: |
|
Show qos specs.
volume_extension:qos_specs_manage:create
Default: |
|
---|---|
Operations: |
|
Create qos specs.
volume_extension:qos_specs_manage:update
Default: |
|
---|---|
Operations: |
|
Update qos specs (including updating association).
volume_extension:qos_specs_manage:delete
Default: |
|
---|---|
Operations: |
|
delete qos specs or unset one specified qos key.
volume_extension:quota_classes
Default: |
|
---|---|
Operations: |
|
Show or update project quota class.
volume_extension:quotas:show
Default: |
|
---|---|
Operations: |
|
Show project quota (including usage and default).
volume_extension:quotas:update
Default: |
|
---|---|
Operations: |
|
Update project quota.
volume_extension:quotas:delete
Default: |
|
---|---|
Operations: |
|
Delete project quota.
volume_extension:quota_classes:validate_setup_for_nested_quota_use
Default: |
|
---|---|
Operations: |
|
Validate setup for nested quota.
volume_extension:capabilities
Default: |
|
---|---|
Operations: |
|
Show backend capabilities.
volume_extension:services:index
Default: |
|
---|---|
Operations: |
|
List all services.
volume_extension:services:update
Default: |
|
---|---|
Operations: |
|
Update service, including failover_host, thaw, freeze, disable, enable, set-log and get-log actions.
volume:freeze_host
Default: |
|
---|---|
Operations: |
|
Freeze a backend host.
volume:thaw_host
Default: |
|
---|---|
Operations: |
|
Thaw a backend host.
volume:failover_host
Default: |
|
---|---|
Operations: |
|
Failover a backend host.
scheduler_extension:scheduler_stats:get_pools
Default: |
|
---|---|
Operations: |
|
List all backend pools.
volume_extension:hosts
Default: |
|
---|---|
Operations: |
|
List, update or show hosts for a project.
limits_extension:used_limits
Default: |
|
---|---|
Operations: |
|
Show limits with used limit attributes.
volume_extension:list_manageable
Default: |
|
---|---|
Operations: |
|
List (in detail) of volumes which are available to manage.
volume_extension:volume_manage
Default: |
|
---|---|
Operations: |
|
Manage existing volumes.
volume_extension:volume_unmanage
Default: |
|
---|---|
Operations: |
|
Stop managing a volume.
volume_extension:types_manage
Default: |
|
---|---|
Operations: |
|
Create, update and delete volume type.
volume_extension:type_get
Default: | <empty string> |
---|---|
Operations: |
|
Get one specific volume type.
volume_extension:type_get_all
Default: | <empty string> |
---|---|
Operations: |
|
List volume types.
volume_extension:volume_type_encryption
Default: |
|
---|---|
Operations: |
|
Base policy for all volume type encryption type operations. This can be used to set the policies for a volume type’s encryption type create, show, update, and delete actions in one place, or any of those may be set individually using the following policy targets for finer grained control.
volume_extension:volume_type_encryption:create
Default: |
|
---|---|
Operations: |
|
Create volume type encryption.
volume_extension:volume_type_encryption:get
Default: |
|
---|---|
Operations: |
|
Show a volume type’s encryption type, show an encryption specs item.
volume_extension:volume_type_encryption:update
Default: |
|
---|---|
Operations: |
|
Update volume type encryption.
volume_extension:volume_type_encryption:delete
Default: |
|
---|---|
Operations: |
|
Delete volume type encryption.
volume_extension:access_types_extra_specs
Default: |
|
---|---|
Operations: |
|
List or show volume type with access type extra specs attribute.
volume_extension:access_types_qos_specs_id
Default: |
|
---|---|
Operations: |
|
List or show volume type with access type qos specs id attribute.
volume_extension:volume_type_access
Default: |
|
---|---|
Operations: |
|
Volume type access related APIs.
volume_extension:volume_type_access:addProjectAccess
Default: |
|
---|---|
Operations: |
|
Add volume type access for project.
volume_extension:volume_type_access:removeProjectAccess
Default: |
|
---|---|
Operations: |
|
Remove volume type access for project.
volume:extend
Default: |
|
---|---|
Operations: |
|
Extend a volume.
volume:extend_attached_volume
Default: |
|
---|---|
Operations: |
|
Extend a attached volume.
volume:revert_to_snapshot
Default: |
|
---|---|
Operations: |
|
Revert a volume to a snapshot.
volume_extension:volume_admin_actions:reset_status
Default: |
|
---|---|
Operations: |
|
Reset status of a volume.
volume:retype
Default: |
|
---|---|
Operations: |
|
Retype a volume.
volume:update_readonly_flag
Default: |
|
---|---|
Operations: |
|
Update a volume’s readonly flag.
volume_extension:volume_admin_actions:force_delete
Default: |
|
---|---|
Operations: |
|
Force delete a volume.
volume_extension:volume_actions:upload_public
Default: |
|
---|---|
Operations: |
|
Upload a volume to image with public visibility.
volume_extension:volume_actions:upload_image
Default: |
|
---|---|
Operations: |
|
Upload a volume to image.
volume_extension:volume_admin_actions:force_detach
Default: |
|
---|---|
Operations: |
|
Force detach a volume.
volume_extension:volume_admin_actions:migrate_volume
Default: |
|
---|---|
Operations: |
|
migrate a volume to a specified host.
volume_extension:volume_admin_actions:migrate_volume_completion
Default: |
|
---|---|
Operations: |
|
Complete a volume migration.
volume_extension:volume_actions:initialize_connection
Default: |
|
---|---|
Operations: |
|
Initialize volume attachment.
volume_extension:volume_actions:terminate_connection
Default: |
|
---|---|
Operations: |
|
Terminate volume attachment.
volume_extension:volume_actions:roll_detaching
Default: |
|
---|---|
Operations: |
|
Roll back volume status to ‘in-use’.
volume_extension:volume_actions:reserve
Default: |
|
---|---|
Operations: |
|
Mark volume as reserved.
volume_extension:volume_actions:unreserve
Default: |
|
---|---|
Operations: |
|
Unmark volume as reserved.
volume_extension:volume_actions:begin_detaching
Default: |
|
---|---|
Operations: |
|
Begin detach volumes.
volume_extension:volume_actions:attach
Default: |
|
---|---|
Operations: |
|
Add attachment metadata.
volume_extension:volume_actions:detach
Default: |
|
---|---|
Operations: |
|
Clear attachment metadata.
volume:get_all_transfers
Default: |
|
---|---|
Operations: |
|
List volume transfer.
volume:create_transfer
Default: |
|
---|---|
Operations: |
|
Create a volume transfer.
volume:get_transfer
Default: |
|
---|---|
Operations: |
|
Show one specified volume transfer.
volume:accept_transfer
Default: | <empty string> |
---|---|
Operations: |
|
Accept a volume transfer.
volume:delete_transfer
Default: |
|
---|---|
Operations: |
|
Delete volume transfer.
volume:get_volume_metadata
Default: |
|
---|---|
Operations: |
|
Show volume’s metadata or one specified metadata with a given key.
volume:create_volume_metadata
Default: |
|
---|---|
Operations: |
|
Create volume metadata.
volume:update_volume_metadata
Default: |
|
---|---|
Operations: |
|
Update volume’s metadata or one specified metadata with a given key.
volume:delete_volume_metadata
Default: |
|
---|---|
Operations: |
|
Delete volume’s specified metadata with a given key.
volume_extension:volume_image_metadata
Default: |
|
---|---|
Operations: |
|
Volume’s image metadata related operation, create, delete, show and list.
volume:update_volume_admin_metadata
Default: |
|
---|---|
Operations: |
|
Update volume admin metadata. It’s used in attach and os-update_readonly_flag APIs
volume_extension:types_extra_specs:index
Default: |
|
---|---|
Operations: |
|
List type extra specs.
volume_extension:types_extra_specs:create
Default: |
|
---|---|
Operations: |
|
Create type extra specs.
volume_extension:types_extra_specs:show
Default: |
|
---|---|
Operations: |
|
Show one specified type extra specs.
volume_extension:types_extra_specs:update
Default: |
|
---|---|
Operations: |
|
Update type extra specs.
volume_extension:types_extra_specs:delete
Default: |
|
---|---|
Operations: |
|
Delete type extra specs.
volume:create
Default: | <empty string> |
---|---|
Operations: |
|
Create volume.
volume:create_from_image
Default: | <empty string> |
---|---|
Operations: |
|
Create volume from image.
volume:get
Default: |
|
---|---|
Operations: |
|
Show volume.
volume:get_all
Default: |
|
---|---|
Operations: |
|
List volumes or get summary of volumes.
volume:update
Default: |
|
---|---|
Operations: |
|
Update volume or update a volume’s bootable status.
volume:delete
Default: |
|
---|---|
Operations: |
|
Delete volume.
volume:force_delete
Default: |
|
---|---|
Operations: |
|
Force Delete a volume.
volume_extension:volume_host_attribute
Default: |
|
---|---|
Operations: |
|
List or show volume with host attribute.
volume_extension:volume_tenant_attribute
Default: |
|
---|---|
Operations: |
|
List or show volume with tenant attribute.
volume_extension:volume_mig_status_attribute
Default: |
|
---|---|
Operations: |
|
List or show volume with migration status attribute.
volume_extension:volume_encryption_metadata
Default: |
|
---|---|
Operations: |
|
Show volume’s encryption metadata.
volume:multiattach
Default: |
|
---|---|
Operations: |
|
Create multiattach capable volume.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.