API Overview

Table 6.1, “Manila API Overview - Share” specifies the valid operations that can be performed on Manila shares. Please note that Manila shares are identified as CLI command arguments by either their names or UUID.

Table 6.2, “Manila API Overview - Share Access” specifies the valid access operations that can be performed on Manila shares. Please note that Manila shares are identified as CLI command arguments by either their names or UUID.

	Warning
	Please refer to the caveat as explained in the section called “Share Access Rules”.

Table 6.3, “Manila API Overview - Share Export Location” specifies the operations that can be performed to get export locations of Manila shares. Please note that Manila shares are identified as CLI command arguments by either their names or UUID. There may be multiple export locations for a given share, at least one of which should be listed as preferred; clients should use the preferred path for optimum performance.

Table 6.4, “Manila API Overview - Snapshot” specifies the valid operations that can be performed on Manila snapshots. Please note that Manila snapshots are identified as CLI command arguments by either their display name or UUID.

Important

In the Mitaka and Newton release of OpenStack, snapshot support is enabled by default for a newly created share type. Starting with the Ocata release, the snapshot_support extra spec must be set to True in order to allow snapshots for a share type. If the 'snapshot_support' extra_spec is omitted or if it is set to False, users would not be able to create snapshots on shares of this share type. Other snapshot-related extra specs in the Ocata release (and later) include: create_share_from_snapshot_support: Allow the creation of a new share from a snapshot revert_to_snapshot_support: Allow a share to be reverted to the most recent snapshot If an extra-spec is left unset, it will default to 'False', but a newly created share may or may not end up on a backend with the associated capability. Set the extra spec explicitly to False, if you would like your shares to be created only on backends that do not support the associated capabilities. For a table of NetApp supported extra specs, refer to Table 6.10, “NetApp supported Extra Specs for use with Manila Share Types”.

Table 6.5, “Manila API Overview - Share Type” specifies the valid operations that can be performed on Manila share types. Please note that Manila share types are identified as CLI command arguments by either their display name or UUID. Creation or deletion of share types normally requires administrative privileges.

Table 6.6, “Manila API Overview - Share Type Extra Specs” specifies the valid operations that can be performed on Manila share type extra specs. Please note that Manila share type extra specs are properties of Manila share types and are identified by their parent object. Modifying extra specs or viewing the contents of a share type normally requires administrative privileges.

Table 6.7, “Manila API Overview - Consistency Groups”

Table 6.8, “Manila API Overview - Share Replication”

Table 6.9, “Manila API Overview - Share Migration”

Note

Several parameters need to be specified when starting migration for a share. For a list of supported parameters, refer to the help text from running manila help migration-start. For example, the NetApp driver supports preserving snapshots and file system metadata, and can perform in-Vserver migrations non-disruptively. In order to do so, preserve_metadata, preserve_snapshots, and nondisruptive must be set to True.