# `openstack share` Command-Line Interface (CLI)

## Synopsis

openstack [options] share <command> [command-options]

openstack help share <command>

## Description

The OpenStack Client plugin interacts with the Manila service through the `openstack share` command line interface (CLI).

To use the CLI, you must provide your OpenStack username, password, project, auth endpoint and the share API version. You can use configuration options `--os-username`, `--os-password`, `--os-project-name`, `--os-auth-url` and `--os-share-api-version`, or set the corresponding environment variables:

    export OS_USERNAME=foo
    export OS_PASSWORD=bar
    export OS_TENANT_NAME=foobarproject
    export OS_AUTH_URL=http://...
    export OS_SHARE_API_VERSION=2.51

It is possible to use different Manila endpoint while using Openstack Client. In this case, you can use configuration option `--os-endpoint-override` or set the corresponding environment variable:

    export OS_ENDPOINT_OVERRIDE=http://...

## Getting help

To get a full list of all possible commands, run:

    $ openstack help share

To get detailed help for one command, run:

    $ openstack help share <command>

## Examples

Get information about the openstack share create command:

    $ openstack help share create

Create one share:

    $ openstack share create NFS 1 --name "myshare"

List shares:

    $ openstack share list

Display a share:

    $ openstack share show myshare

Delete a share:

    $ openstack share delete myshare

Extend a 1gb share to 2gb:

    $ openstack share resize myshare 2

Shrink a 2gb share to 1gb:

    $ openstack share resize myshare 1

## Command Reference

- Command Reference
  - shares
    - share create
    - share list
    - share show
    - share delete
    - share set
    - share unset
    - share properties show
    - share resize
    - share adopt
    - share abandon
    - share export location show
    - share export location list
    - share revert
    - share restore
  - share instances
    - share instance delete
    - share instance list
    - share instance set
    - share instance show
  - share access rules
    - share access create
    - share access delete
    - share access list
    - share access set
    - share access show
    - share access unset
  - share migration
    - share migration start
    - share migration cancel
    - share migration complete
    - share migration show
  - share networks
    - share network create
    - share network delete
    - share network list
    - share network unset
    - share network show
    - share network set
  - share network subnets
    - share network subnet create
    - share network subnet delete
    - share network subnet set
    - share network subnet show
    - share network subnet unset
  - share types
    - share type access create
    - share type access delete
    - share type access list
    - share type create
    - share type delete
    - share type list
    - share type set
    - share type show
    - share type unset
  - share quotas
    - share quota delete
    - share quota set
    - share quota show
  - share snapshots
    - share snapshot abandon
    - share snapshot access create
    - share snapshot access delete
    - share snapshot access list
    - share snapshot adopt
    - share snapshot create
    - share snapshot delete
    - share snapshot export location list
    - share snapshot export location show
    - share snapshot list
    - share snapshot set
    - share snapshot show
    - share snapshot unset
  - share snapshot instances
    - share snapshot instance export location list
    - share snapshot instance export location show
    - share snapshot instance list
    - share snapshot instance set
    - share snapshot instance show
  - user messages
    - share message delete
    - share message list
    - share message show
  - share replicas
    - share replica create
    - share replica delete
    - share replica export location list
    - share replica export location show
    - share replica list
    - share replica promote
    - share replica resync
    - share replica set
    - share replica show
    - share replica unset
  - share availability zones
    - share availability zone list
  - share services
    - share service ensure shares
    - share service list
    - share service set
  - share security services
    - share security service create
    - share security service delete
    - share security service list
    - share security service set
    - share security service show
    - share security service unset
  - share pools
    - share pool list
  - share limits
    - share limits show
  - share instance export location
    - share instance export location list
    - share instance export location show
  - share groups
    - share group create
    - share group delete
    - share group list
    - share group unset
    - share group set
  - share group types
    - share group type access create
    - share group type access delete
    - share group type access list
    - share group type create
    - share group type delete
    - share group type list
    - share group type set
    - share group type show
    - share group type unset
  - share group snapshots
  - share servers
    - share server abandon
    - share server adopt
    - share server delete
    - share server list
    - share server migration cancel
    - share server migration complete
    - share server migration show
    - share server migration start
    - share server set
    - share server show
  - resource locks
    - share lock create
    - share lock delete
    - share lock list
    - share lock set
    - share lock show
    - share lock unset
  - qos types
    - share qos type create
    - share qos type delete
    - share qos type list
    - share qos type set
    - share qos type show
    - share qos type unset

this page last updated: 2026-02-27 13:15:53

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug