Red Hat Training

A Red Hat training course is available for Red Hat OpenStack Platform

Chapter 13. Shared File Systems Service Command-line Client

The manila client is the command-line interface (CLI) for the Shared File Systems API and its extensions. This chapter documents manila version 1.11.0.
For help on a specific manila command, enter: 
$ manila help COMMAND

13.1. manila Usage

usage: manila [--version] [-d] [--os-cache] [--os-reset-cache]
              [--os-user-id <auth-user-id>] [--os-username <auth-user-name>]
              [--os-password <auth-password>]
              [--os-tenant-name <auth-tenant-name>]
              [--os-project-name <auth-project-name>]
              [--os-tenant-id <auth-tenant-id>]
              [--os-project-id <auth-project-id>]
              [--os-user-domain-id <auth-user-domain-id>]
              [--os-user-domain-name <auth-user-domain-name>]
              [--os-project-domain-id <auth-project-domain-id>]
              [--os-project-domain-name <auth-project-domain-name>]
              [--os-auth-url <auth-url>] [--os-region-name <region-name>]
              [--os-token <token>] [--bypass-url <bypass-url>]
              [--service-type <service-type>] [--service-name <service-name>]
              [--share-service-name <share-service-name>]
              [--endpoint-type <endpoint-type>]
              [--os-share-api-version <share-api-ver>]
              [--os-cacert <ca-certificate>] [--retries <retries>]
              [--os-cert <certificate>]
              <subcommand> ...

Subcommands

absolute-limits


        Print a list of absolute limits for a user.

access-allow


        Allow access to the share.

access-deny


        Deny access to a share.

access-list


        Show access list for share.

api-version


        Display the API version information.

cg-create


        Creates a new consistency group (Experimental).

cg-delete


        Remove one or more consistency groups (Experimental).

cg-list


        List consistency groups with filters (Experimental).

cg-reset-state


        Explicitly update the state of a consistency group
      (Admin only, Experimental).

cg-show


        Show details about a consistency group (Experimental).

cg-snapshot-create


        Creates a new consistency group snapshot
      (Experimental).

cg-snapshot-delete


        Remove one or more consistency group snapshots
      (Experimental).

cg-snapshot-list


        List consistency group snapshots with filters
      (Experimental).

cg-snapshot-members


      Get member details for a consistency group snapshot
      (Experimental).

cg-snapshot-reset-state


      Explicitly update the state of a consistency group
      (Admin only, Experimental).

cg-snapshot-show


        Show details about a consistency group snapshot
      (Experimental).

cg-snapshot-update


        Update a consistency group snapshot (Experimental).

cg-update


        Update a consistency group (Experimental).

create


        Creates a new share (NFS, CIFS, CephFS, GlusterFS or
      HDFS).

credentials


        Show user credentials returned from auth.

delete


        Remove one or more shares.

endpoints


        Discover endpoints that get returned from the
      authenticate services.

extend


        Increases the size of an existing share.

extra-specs-list


        Print a list of current 'share types and extra specs'
      (Admin Only).

force-delete


        Attempt force-delete of share, regardless of state
      (Admin only).

list


        List NAS shares with filters.

manage


        Manage share not handled by Manila (Admin only).

metadata


        Set or delete metadata on a share.

metadata-show


        Show metadata of given share.

metadata-update-all


      Update all metadata of a share.

migration-cancel


        Cancels migration of a given share when copying (Admin
      only, Experimental).

migration-complete


        Completes migration for a given share (Admin only,
      Experimental).

migration-get-progress


      Gets migration progress of a given share when copying
      (Admin only, Experimental).

migration-start


        Migrates share to a new host (Admin only,
      Experimental).

pool-list


        List all backend storage pools known to the scheduler
      (Admin only).

quota-class-show


        List the quotas for a quota class.

quota-class-update


        Update the quotas for a quota class (Admin only).

quota-defaults


        List the default quotas for a tenant.

quota-delete


        Delete quota for a tenant/user. The quota will revert
      back to default (Admin only).

quota-show


        List the quotas for a tenant/user.

quota-update


        Update the quotas for a tenant/user (Admin only).

rate-limits


        Print a list of rate limits for a user.

reset-state


        Explicitly update the state of a share (Admin only).

reset-task-state


        Explicitly update the task state of a share (Admin
      only, Experimental).

security-service-create


      Create security service used by tenant.

security-service-delete


      Delete security service.

security-service-list


      Get a list of security services.

security-service-show


      Show security service.

security-service-update


      Update security service.

service-disable


        Disables 'manila-share' or 'manila-scheduler' services
      (Admin only).

service-enable


        Enables 'manila-share' or 'manila-scheduler' services
      (Admin only).

service-list


        List all services (Admin only).

share-export-location-list


      List export locations of a given share.

share-export-location-show


      Show export location of the share.

share-instance-export-location-list


      List export locations of a given share instance.

share-instance-export-location-show


      Show export location for the share instance.

share-instance-force-delete


      Force-delete the share instance, regardless of state
      (Admin only).

share-instance-list


      List share instances (Admin only).

share-instance-reset-state


      Explicitly update the state of a share instance (Admin
      only).

share-instance-show


      Show details about a share instance (Admin only).

share-network-create


      Create description for network used by the tenant.

share-network-delete


      Delete share network.

share-network-list


        Get a list of network info.

share-network-security-service-add


      Associate security service with share network.

share-network-security-service-list


      Get list of security services associated with a given
      share network.

share-network-security-service-remove


      Dissociate security service from share network.

share-network-show


        Get a description for network used by the tenant.

share-network-update


      Update share network data.

share-replica-create


      Create a share replica (Experimental).

share-replica-delete


      Remove one or more share replicas (Experimental).

share-replica-list


        List share replicas (Experimental).

share-replica-promote


      Promote specified replica to 'active' replica_state
      (Experimental).

share-replica-reset-replica-state


      Explicitly update the 'replica_state' of a share
      replica (Experimental).

share-replica-reset-state


      Explicitly update the 'status' of a share replica
      (Experimental).

share-replica-resync


      Attempt to update the share replica with its 'active'
      mirror (Experimental).

share-replica-show


        Show details about a replica (Experimental).

share-server-delete


      Delete share server (Admin only).

share-server-details


      Show share server details (Admin only).

share-server-list


        List all share servers (Admin only).

share-server-show


        Show share server info (Admin only).

show


        Show details about a NAS share.

shrink


        Decreases the size of an existing share.

snapshot-create


        Add a new snapshot.

snapshot-delete


        Remove a snapshot.

snapshot-force-delete


      Attempt force-delete of snapshot, regardless of state
      (Admin only).

snapshot-instance-list


      List share snapshot instances.

snapshot-instance-reset-state


      Explicitly update the state of a share snapshot
      instance.

snapshot-instance-show


      Show details about a share snapshot instance.

snapshot-list


        List all the snapshots.

snapshot-manage


        Manage share snapshot not handled by Manila (Admin
      only).

snapshot-rename


        Rename a snapshot.

snapshot-reset-state


      Explicitly update the state of a snapshot (Admin
      only).

snapshot-show


        Show details about a snapshot.

snapshot-unmanage


        Unmanage one or more share snapshots (Admin only).

type-access-add


        Adds share type access for the given project (Admin
      only).

type-access-list


        Print access information about the given share type
      (Admin only).

type-access-remove


        Removes share type access for the given project (Admin
      only).

type-create


        Create a new share type (Admin only).

type-delete


        Delete a specific share type (Admin only).

type-key


        Set or unset extra_spec for a share type (Admin only).

type-list


        Print a list of available 'share types'.

unmanage


        Unmanage share (Admin only).

update


        Rename a share.

bash-completion


        Print arguments for bash_completion. Prints all of the
      commands and options to stdout so that the
      manila.bash_completion script doesn't have to hard
      code them.

help


        Display help about this program or one of its
      subcommands.

list-extensions


        List all the os-api extensions that are available.