The cinder client is the command-line interface (CLI) for the OpenStack Block Storage API and its extensions.
For help on a specific cinder command, enter:
$ cinder help COMMAND
[--os-password <auth-password>]
[--os-tenant-name <auth-tenant-name>]
[--os-tenant-id <auth-tenant-id>] [--os-auth-url <auth-url>]
[--os-region-name <region-name>] [--service-type <service-type>]
[--service-name <service-name>]
[--volume-service-name <volume-service-name>]
[--endpoint-type <endpoint-type>]
[--os-volume-api-version <volume-api-ver>]
[--os-cacert <ca-certificate>] [--retries <retries>]
<subcommand> ...
| Command | Description |
| backup-create | Creates a backup. |
| backup-delete | Remove a backup. |
| backup-list | List all the backups. |
| backup-restore | Restore a backup. |
| backup-show | Show details about a backup. |
| create | Add a new volume. |
| credentials | Show user credentials returned from auth. |
| delete | Remove volume(s). |
| endpoints | Discover endpoints that get returned from the authenticate services. |
| extend | Attempt to extend the size of an existing volume. |
| force-delete | Attempt forced removal of volume(s), regardless of the state(s). |
| list | List all the volumes. |
| metadata | Set or Delete metadata on a volume. |
| metadata-show | Show metadata of given volume. |
| metadata-update-all | Update all metadata of a volume. |
| rate-limits | Print a list of rate limits for a user |
| readonly-mode-update | Update volume read-only access mode read_only. |
| rename | Rename a volume. |
| show | Show details about a volume. |
| snapshot-create | Add a new snapshot. |
| snapshot-delete | Remove a snapshot. |
| snapshot-list | List all the snapshots. |
| snapshot-metadata | Set or Delete metadata of a snapshot. |
| snapshot-metadata-show | Show metadata of given snapshot. |
| snapshot-metadata-update-all | Update all metadata of a snapshot. |
| snapshot-rename | Rename a snapshot. |
| snapshot-show | Show details about a snapshot. |
| transfer-accept | Accepts a volume transfer. |
| transfer-create | Creates a volume transfer. |
| transfer-delete | Undo a transfer. |
| transfer-list | List all the transfers. |
| transfer-show | Show details about a transfer. |
| type-list | Print a list of available 'volume types'. |
| upload-to-image | Upload volume to image service as image. |
| bash-completion | Print arguments for bash_completion. |
| help | Display help about this program or one of its subcommands. |
| list-extensions | List all the os-api extensions that are available. |
| Command | Description |
| --version | show program's version number and exit |
| --debug | Print debugging output |
| --os-username <auth-user-name> | Defaults to env[OS_USERNAME]. |
| --os-password <auth-password> | Defaults to env[OS_PASSWORD]. |
| --os-tenant-name <auth-tenant-name> | Defaults to env[OS_TENANT_NAME]. |
| --os-tenant-id <auth-tenant-id> | Defaults to env[OS_TENANT_ID]. |
| --os-auth-url <auth-url> | Defaults to env[OS_AUTH_URL]. |
| --os-region-name <region-name> | Defaults to env[OS_REGION_NAME]. |
| --service-type <service-type> | Defaults to volume for most actions |
| --service-name <service-name> | Defaults to env[CINDER_SERVICE_NAME] |
| --volume-service-name <volume-service-name> | Defaults to env[CINDER_VOLUME_SERVICE_NAME] |
| --endpoint-type <endpoint-type> | Defaults to env[CINDER_ENDPOINT_TYPE] or publicURL. |
| --os-volume-api-version <volume-api-ver> | Accepts 1 or 2,defaults to env[OS_VOLUME_API_VERSION]. |
| --os-cacert <ca-certificate> | Specify a CA bundle file to use in verifying a TLS
(https) server certificate. Defaults to env[OS_CACERT] |
| --retries <retries> | Number of retries. |
usage: cinder backup-create [--container <container>]
[--display-name <display-name>]
[--display-description <display-description>]
<volume>
Creates a backup.
| Command | Description |
| <volume> | Name or ID of the volume to backup. |
| Command | Description |
| --container <container> | Optional Backup container name. (Default=None) |
| --display-name <display-name> | Optional backup name. (Default=None) |
| --display-description <display-description> | Optional backup description. (Default=None) |
usage: cinder backup-delete <backup>
Remove a backup.
| Command | Description |
| <backup> | Name or ID of the backup to delete. |
usage: cinder backup-restore [--volume-id <volume>] <backup>
Restore a backup.
| Command | Description |
| <backup> | ID of the backup to restore. |
| Command | Description |
| --volume-id <volume> | Optional ID(or name) of the volume to restore to. |
usage: cinder backup-show <backup>
Show details about a backup.
| Command | Description |
| <backup> | Name or ID of the backup. |
usage: cinder create [--snapshot-id <snapshot-id>]
[--source-volid <source-volid>] [--image-id <image-id>]
[--display-name <display-name>]
[--display-description <display-description>]
[--volume-type <volume-type>]
[--availability-zone <availability-zone>]
[--metadata [<key=value> [<key=value> ...]]]
<size>
Add a new volume.
| Command | Description |
| <size> | Size of volume in GB |
| Command | Description |
| --snapshot-id <snapshot-id> | Create volume from snapshot id (Optional, Default=None) |
| --source-volid <source-volid> | Create volume from volume id (Optional, Default=None) |
| --image-id <image-id> | Create volume from image id (Optional, Default=None) |
| --display-name <display-name> | Volume name (Optional, Default=None) |
| --display-description <display-description> | Volume description (Optional, Default=None) |
| --volume-type <volume-type> | Volume type (Optional, Default=None) |
| --availability-zone <availability-zone> | Availability zone for volume (Optional, Default=None) |
| --metadata [<key=value> [<key=value> | ...]] Metadata key=value pairs (Optional, Default=None) |
usage: cinder delete <volume> [<volume> ...]
Remove volume(s).
| Command | Description |
| <volume> | Name or ID of the volume(s) to delete. |
usage: cinder endpoints
Discover endpoints that get returned from the authenticate services.
usage: cinder extend <volume> <new-size>
Attempt to extend the size of an existing volume.
| Command | Description |
| <volume> | Name or ID of the volume to extend. |
| <new-size> | New size of volume in GB |
usage: cinder force-delete <volume> [<volume> ...]
Attempt forced removal of volume(s), regardless of the state(s).
| Command | Description |
| <volume> | Name or ID of the volume(s) to delete. |
usage: cinder list [--all-tenants [<0|1>]] [--display-name <display-name>]
[--status <status>]
[--metadata [<key=value> [<key=value> ...]]]
List all the volumes.
| Command | Description |
| --all-tenants [<0|1>] | Display information from all tenants (Admin only). |
| --display-name <display-name> | Filter results by display-name |
| --status <status> | Filter results by status |
| --metadata [<key=value> [<key=value> | ...]] Filter results by metadata |
usage: cinder list-extensions
List all the os-api extensions that are available.
usage: cinder metadata <volume> <action> <key=value> [<key=value> ...]
Set or Delete metadata on a volume.
| Command | Description |
| <volume> | Name or ID of the volume to update metadata on. |
| <action> | Actions: 'set' or 'unset' |
| <key=value> | Metadata to set/unset (only key is necessary on unset) |
usage: cinder metadata-show <volume>
Show metadata of given volume.
| Command | Description |
| <volume> | ID of volume |
usage: cinder metadata-update-all <volume> <key=value> [<key=value> ...]
Update all metadata of a volume.
| Command | Description |
| <volume> | ID of the volume to update metadata on. |
| <key=value> | Metadata entry/entries to update. |
usage: cinder readonly-mode-update <volume> <True|true|False|false>
Update volume read-only access mode read_only.
| Command | Description |
| <volume> | ID of the volume to update. |
| <True|true|False|false> | Flag to indicate whether to update volume to read-only access mode. |
usage: cinder rename [--display-description <display-description>]
<volume> [<display-name>]
Rename a volume.
| Command | Description |
| <volume> | Name or ID of the volume to rename. |
| <display-name> | New display-name for the volume. |
| Command | Description |
| --display-description <display-description> | Optional volume description. (Default=None) |
usage: cinder show <volume>
Show details about a volume.
| Command | Description |
| <volume> | Name or ID of the volume. |
usage: cinder snapshot-create [--force <True|False>]
[--display-name <display-name>]
[--display-description <display-description>]
<volume>
Add a new snapshot.
| Command | Description |
| <volume> | Name or ID of the volume to snapshot |
| Command | Description |
| --force <True|False> | Optional flag to indicate whether to snapshot a volume even if it's attached to an instance. (Default=False) |
| --display-name <display-name> | Optional snapshot name. (Default=None) |
| --display-description <display-description> | Optional snapshot description. (Default=None) |
usage: cinder snapshot-delete <snapshot>
Remove a snapshot.
| Command | Description |
| <snapshot> | Name or ID of the snapshot to delete. |
usage: cinder snapshot-list [--all-tenants [<0|1>]]
[--display-name <display-name>]
[--status <status>] [--volume-id <volume-id>]
List all the snapshots.
| Command | Description |
| --all-tenants [<0|1>] | Display information from all tenants (Admin only). |
| --display-name <display-name> | Filter results by display-name |
| --status <status> | Filter results by status |
| --volume-id <volume-id> | Filter results by volume-id |
usage: cinder snapshot-metadata <snapshot> <action> <key=value>
[<key=value> ...]
Set or Delete metadata of a snapshot.
| Command | Description |
| <snapshot> | ID of the snapshot to update metadata on. |
| <action> | Actions: 'set' or 'unset' |
| <key=value> | Metadata to set/unset (only key is necessary on unset) |
usage: cinder snapshot-metadata-show <snapshot>
Show metadata of given snapshot.
| Command | Description |
| <snapshot> | ID of snapshot |
usage: cinder snapshot-metadata-update-all <snapshot> <key=value>
[<key=value> ...]
Update all metadata of a snapshot.
| Command | Description |
| <snapshot> | ID of the snapshot to update metadata on. |
| <key=value> | Metadata entry/entries to update. |
usage: cinder snapshot-rename [--display-description <display-description>]
<snapshot> [<display-name>]
Rename a snapshot.
| Command | Description |
| <snapshot> | Name or ID of the snapshot. |
| <display-name> | New display-name for the snapshot. |
| Command | Description |
| --display-description <display-description> | Optional snapshot description. (Default=None) |
usage: cinder snapshot-show <snapshot>
Show details about a snapshot.
| Command | Description |
| <snapshot> | Name or ID of the snapshot. |
usage: cinder transfer-accept <transfer> <auth_key>
Accepts a volume transfer.
| Command | Description |
| <transfer> | ID of the transfer to accept. |
| <auth_key> | Auth key of the transfer to accept. |
usage: cinder transfer-create [--display-name <display-name>] <volume>
Creates a volume transfer.
| Command | Description |
| <volume> | Name or ID of the volume to transfer. |
| Command | Description |
| --display-name <display-name> | Optional transfer name. (Default=None) |
usage: cinder transfer-delete <transfer>
Undo a transfer.
| Command | Description |
| <transfer> | Name or ID of the transfer to delete. |
usage: cinder transfer-show <transfer>
Show details about a transfer.
| Command | Description |
| <transfer> | Name or ID of the transfer to accept. |
usage: cinder upload-to-image [--force <True|False>]
[--container-format <container-format>]
[--disk-format <disk-format>]
<volume> <image-name>
Upload volume to image service as image.
| Command | Description |
| <volume> | Name or ID of the volume to upload to an image |
| <image-name> | Name for created image |
| Command | Description |
| --force <True|False> | Optional flag to indicate whether to upload a volume even if it's attached to an instance. (Default=False) |
| --container-format <container-format> | Optional type for container format (Default=bare) |
| --disk-format <disk-format> | Optional type for disk format (Default=raw) |
AURO Cloud Computing expands support to include Managed Amazon Web Services infrastructure
Canadian Cloud Leader AURO adds Managed AWS services to provide a hyper cloud solution compliant with Canadian data privacy laws. These offerings allows customers to receive a customized AWS support solution, fulfilling both their infrastructure requirements and business goals.
Get the guides, facts, reports, and diagrams you need.
©2016 Idigital Internet Inc. All rights reserved, AURO is a registered trademark. Sitemap