Chapter 68. share This chapter describes the commands under the share command. 68.1. share abandon Abandon a share Usage: Table 68.1. Positional arguments Value Summary <share> Name or id of the share(s) Table 68.2. Command arguments Value Summary -h, --help Show this help message and exit --wait Wait until share is abandoned 68.2. share access create Create new share access rule Usage: Table 68.3. Positional arguments Value Summary <share> Name or id of the nas share to modify. <access_type> Access rule type (only "ip", "user" (user or group), "cert" or "cephx" are supported). <access_to> Value that defines access. Table 68.4. Command arguments Value Summary -h, --help Show this help message and exit --properties [<key=value> ... ] Space separated list of key=value pairs of properties. OPTIONAL: Default=None. Available only for API microversion >= 2.45. --access-level <access_level> Share access level ("rw" and "ro" access levels are supported). Defaults to rw. --wait Wait for share access rule creation. Table 68.5. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.6. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.7. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.8. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.3. share access delete Delete a share access rule Usage: Table 68.9. Positional arguments Value Summary <share> Name or id of the nas share to modify. <id> Id of the access rule to be deleted. Table 68.10. Command arguments Value Summary -h, --help Show this help message and exit --wait Wait for share access rule deletion 68.4. share access list List share access rule Usage: Table 68.11. Positional arguments Value Summary <share> Name or id of the share. Table 68.12. Command arguments Value Summary -h, --help Show this help message and exit --properties [<key=value> ... ] Filters results by properties (key=value). optional: Default=None. Available only for API microversion >= 2.45 Table 68.13. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.14. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.15. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.16. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.5. share access set Set properties to share access rule. Available for API microversion 2.45 and higher Usage: Table 68.17. Positional arguments Value Summary <access_id> Id of the nas share access rule. Table 68.18. Command arguments Value Summary -h, --help Show this help message and exit --property <key=value> Set a property to this share access rule. (repeat option to set multiple properties) Available only for API microversion >= 2.45. 68.6. share access show Display a share access rule. Available for API microversion 2.45 and higher Usage: Table 68.19. Positional arguments Value Summary <access_id> Id of the nas share access rule. Table 68.20. Command arguments Value Summary -h, --help Show this help message and exit Table 68.21. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.22. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.23. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.24. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.7. share access unset Unset properties of share access rule. Available for API microversion 2.45 and higher Usage: Table 68.25. Positional arguments Value Summary <access_id> Id of the nas share access rule. Table 68.26. Command arguments Value Summary -h, --help Show this help message and exit --property <key> Remove property from share access rule. (repeat option to remove multiple properties) Available only for API microversion >= 2.45. 68.8. share adopt Adopt a share Usage: Table 68.27. Positional arguments Value Summary <service-host> Service host: some.host@driver#pool. <protocol> Protocol of the share to manage, such as nfs or cifs. <export-path> Share export path, nfs share such as: 10.0.0.1:/example_path, CIFS share such as: \\10.0.0.1\example_cifs_share. Table 68.28. Command arguments Value Summary -h, --help Show this help message and exit --name <name> Optional share name. (default=none) --description <description> Optional share description. (default=none) --share-type <share-type> Optional share type assigned to share. (default=none) --driver-options [<key=value> ... ] Optional driver options as key=value pairs (Default=None). --public Level of visibility for share. defines whether other projects are able to see it or not. Available only for microversion >= 2.8. (Default=False) --share-server-id <share-server-id> Share server associated with share when using a share type with "driver_handles_share_servers" extra_spec set to True. Available only for microversion >= 2.49. (Default=None) --wait Wait until share is adopted Table 68.29. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.30. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.31. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.32. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.9. share availability zone list List all availability zones Usage: Table 68.33. Command arguments Value Summary -h, --help Show this help message and exit Table 68.34. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.35. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.36. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.37. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.10. share create Create new share Usage: Table 68.38. Positional arguments Value Summary <share_protocol> Share protocol (nfs, cifs, cephfs, glusterfs or hdfs) <size> Share size in gib. Table 68.39. Command arguments Value Summary -h, --help Show this help message and exit --name <name> Optional share name. (default=none) --snapshot-id <snapshot-id> Optional snapshot id to create the share from. (Default=None) --property <key=value> Set a property to this share (repeat option to set multiple properties) --share-network <network-info> Optional network info id or name. --description <description> Optional share description. (default=none) --public <public> Level of visibility for share. defines whether other tenants are able to see it or not. (Default = False) --share-type <share-type> The share type to create the share with. if not specified, unless creating from a snapshot, the default share type will be used. --availability-zone <availability-zone> Availability zone in which share should be created. --share-group <share-group> Optional share group name or id in which to create the share. (Default=None). --wait Wait for share creation --scheduler-hint <key=value> Set scheduler hints for the share as key=value pairs, possible keys are same_host, different_host.(repeat option to set multiple hints) Table 68.40. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.41. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.42. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.43. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.11. share delete Delete a share Usage: Table 68.44. Positional arguments Value Summary <share> Share(s) to delete (name or id) Table 68.45. Command arguments Value Summary -h, --help Show this help message and exit --share-group <share-group> Optional share group (name or id) which contains the share --force Attempt forced removal of share(s), regardless of state (defaults to False) --wait Wait for share deletion --soft Soft delete one or more shares. 68.12. share export location list List export location of a share Usage: Table 68.46. Positional arguments Value Summary <share> Name or id of share Table 68.47. Command arguments Value Summary -h, --help Show this help message and exit Table 68.48. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.49. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.50. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.51. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.13. share export location show Show export location of a share Usage: Table 68.52. Positional arguments Value Summary <share> Name or id of share <export-location> Id of the share export location Table 68.53. Command arguments Value Summary -h, --help Show this help message and exit Table 68.54. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.55. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.56. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.57. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.14. share group create Create new share group Usage: Table 68.58. Command arguments Value Summary -h, --help Show this help message and exit --name <name> Share group name --description <description> Share group description. --share-types <share-types> [<share-types> ... ] Name or id of share type(s). --share-group-type <share-group-type> Share group type name or id of the share group to be created. --share-network <share-network> Specify share network name or id --source-share-group-snapshot <source-share-group-snapshot> Share group snapshot name or id to create the share group from. --availability-zone <availability-zone> Optional availability zone in which group should be created --wait Wait for share group creation Table 68.59. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.60. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.61. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.62. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.15. share group delete Delete one or more share groups Usage: Table 68.63. Positional arguments Value Summary <share_group> Name or id of the share group(s) to delete Table 68.64. Command arguments Value Summary -h, --help Show this help message and exit --force Attempt to force delete the share group (default=false) (Admin only). --wait Wait for share group to delete 68.16. share group list List share groups Usage: Table 68.65. Command arguments Value Summary -h, --help Show this help message and exit --all-projects Display share groups from all projects (admin only). --name <name> Filter results by name. --description <description> Filter results by description. available only for microversion >= 2.36. --status <status> Filter results by status. --share-server <share-server-id> Filter results by share server id. --share-group-type <share-group-type> Filter results by a share group type id or name that was used for share group creation. --snapshot <snapshot> Filter results by share group snapshot name or id that was used to create the share group. --host <host> Filter results by host. --share-network <share-network> Filter results by share-network name or id. --project <project> Filter results by project name or id. useful with set key --all-projects . --project-domain <project-domain> Domain the project belongs to (name or id). this can be used in case collisions between project names exist. --limit <limit> Limit the number of share groups returned --marker <marker> The last share group id of the page --sort <key>[:<direction>] Sort output by selected keys and directions(asc or desc) (default: name:asc), multiple keys and directions can be specified separated by comma --name~ <name~> Filter results matching a share group name pattern. Available only for microversion >= 2.36. --description~ <description~> Filter results matching a share group description pattern. Available only for microversion >= 2.36. Table 68.66. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.67. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.68. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.69. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.17. share group set Explicitly set share group status Usage: Table 68.70. Positional arguments Value Summary <share-group> Name or id of the share group to update. Table 68.71. Command arguments Value Summary -h, --help Show this help message and exit --name <name> New name for the share group. (default=none) --description <description> Share group description. (default=none) --status <status> Explicitly update the status of a share group (admin only). Examples include: available, error, creating, deleting, error_deleting. 68.18. share group show Show details about a share group Usage: Table 68.72. Positional arguments Value Summary <share-group> Name or id of the share group. Table 68.73. Command arguments Value Summary -h, --help Show this help message and exit Table 68.74. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.75. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.76. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.77. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.19. share group snapshot create Create a share group snapshot of the given share group Usage: Table 68.78. Positional arguments Value Summary <share-group> Name or id of the share group. Table 68.79. Command arguments Value Summary -h, --help Show this help message and exit --name <name> Optional share group snapshot name. (default=none) --description <description> Optional share group snapshot description. (Default=None) --wait Wait for share group snapshot creation Table 68.80. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.81. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.82. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.83. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.20. share group snapshot delete Delete one or more share group snapshot Usage: Table 68.84. Positional arguments Value Summary <share-group-snapshot> Name or id of the group snapshot(s) to delete Table 68.85. Command arguments Value Summary -h, --help Show this help message and exit --force Attempt to force delete the share group snapshot(s) (Default=False) (Admin only). --wait Wait for share group snapshot deletion 68.21. share group snapshot list List share group snapshots Usage: Table 68.86. Command arguments Value Summary -h, --help Show this help message and exit --all-projects Display information from all projects (admin only). --name <name> Filter results by name. --status <status> Filter results by status. --share-group <share-group> Filter results by share group name or id. --limit <limit> Limit the number of share groups returned --marker <marker> The last share group snapshot id of the page --sort <key>[:<direction>] Sort output by selected keys and directions(asc or desc) (default: name:asc), multiple keys and directions can be specified separated by comma --detailed Show detailed information about share group snapshot. Table 68.87. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.88. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.89. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.90. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.22. share group snapshot members list List members of share group snapshot Usage: Table 68.91. Positional arguments Value Summary <share-group-snapshot> Name or id of the group snapshot to list members for Table 68.92. Command arguments Value Summary -h, --help Show this help message and exit Table 68.93. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.94. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.95. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.96. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.23. share group snapshot set Set share group snapshot properties Usage: Table 68.97. Positional arguments Value Summary <share-group-snapshot> Name or id of the snapshot to set a property for Table 68.98. Command arguments Value Summary -h, --help Show this help message and exit --name <name> Set a name to the snapshot. --description <description> Set a description to the snapshot. --status <status> Explicitly set the state of a share group snapshot(Admin only). Options include : available, error, creating, deleting, error_deleting. 68.24. share group snapshot show Show details about a share group snapshot Usage: Table 68.99. Positional arguments Value Summary <share-group-snapshot> Name or id of the share group snapshot to display Table 68.100. Command arguments Value Summary -h, --help Show this help message and exit Table 68.101. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.102. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.103. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.104. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.25. share group snapshot unset Unset a share group snapshot property Usage: Table 68.105. Positional arguments Value Summary <share-group-snapshot> Name or id of the group snapshot to unset a property of Table 68.106. Command arguments Value Summary -h, --help Show this help message and exit --name Unset share group snapshot name. --description Unset share group snapshot description. 68.26. share group type access create Allow a project to access a share group type (Admin only). Usage: Table 68.107. Positional arguments Value Summary <share-group-type> Share group type name or id to allow access to. <project> Project name or id to add share group type access for. Table 68.108. Command arguments Value Summary -h, --help Show this help message and exit --project-domain <project-domain> Domain the project belongs to (name or id). this can be used in case collisions between project names exist. 68.27. share group type access delete Deny a project to access a share group type (Admin only). Usage: Table 68.109. Positional arguments Value Summary <share-group-type> Share group type name or id to deny access from <project> Project name(s) or id(s) to deny share group type access for. Table 68.110. Command arguments Value Summary -h, --help Show this help message and exit --project-domain <project-domain> Domain the project belongs to (name or id). this can be used in case collisions between project names exist. 68.28. share group type access list Get access list for share group type (Admin only). Usage: Table 68.111. Positional arguments Value Summary <share-group-type> Filter results by share group type name or id. Table 68.112. Command arguments Value Summary -h, --help Show this help message and exit Table 68.113. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.114. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.115. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.116. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.29. share group type create Create new share group type Usage: Table 68.117. Positional arguments Value Summary <name> Share group type name <share-types> List of share type names or ids. example: my-share- type-1 my-share-type-2 Table 68.118. Command arguments Value Summary -h, --help Show this help message and exit --group-specs [<key=value> ... ] Share group type extra specs by key and value. OPTIONAL: Default=None. Example: --group-specs consistent_snapshot_support=host. --public <public> Make type accessible to the public (default true). Table 68.119. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.120. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.121. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.122. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.30. share group type delete Delete a share group type Usage: Table 68.123. Positional arguments Value Summary <share-group-types> Name or id of the share group type(s) to delete Table 68.124. Command arguments Value Summary -h, --help Show this help message and exit 68.31. share group type list List share types Usage: Table 68.125. Command arguments Value Summary -h, --help Show this help message and exit --all Display all share group types whether public or private. Default=False. (Admin only) --group-specs [<key=value> ... ] Filter share group types with group specs (key=value). Table 68.126. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.127. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.128. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.129. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.32. share group type set Set share group type properties Usage: Table 68.130. Positional arguments Value Summary <share-group-type> Name or id of the share group type to modify Table 68.131. Command arguments Value Summary -h, --help Show this help message and exit --group-specs [<key=value> ... ] Extra specs key and value of share group type that will be used for share type creation. OPTIONAL: Default=None. Example: --group-specs consistent- snapshot-support=True 68.33. share group type show Show share group types Usage: Table 68.132. Positional arguments Value Summary <share-group-type> Name or id of the share group type to show Table 68.133. Command arguments Value Summary -h, --help Show this help message and exit Table 68.134. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.135. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.136. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.137. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.34. share group type unset Unset share group type extra specs Usage: Table 68.138. Positional arguments Value Summary <share-group-type> Name or id of the share grouptype to modify <key> Remove group specs from this share group type Table 68.139. Command arguments Value Summary -h, --help Show this help message and exit 68.35. share group unset Unset a share group property Usage: Table 68.140. Positional arguments Value Summary <share-group> Name or id of the share group to set a property for. Table 68.141. Command arguments Value Summary -h, --help Show this help message and exit --name Unset share group name. --description Unset share group description. 68.36. share instance delete Forces the deletion of a share instance Usage: Table 68.142. Positional arguments Value Summary <instance> Id of the share instance to delete. Table 68.143. Command arguments Value Summary -h, --help Show this help message and exit --wait Wait for share instance deletion. 68.37. share instance export location list List share instance export locations Usage: Table 68.144. Positional arguments Value Summary <instance> Id of the share instance. Table 68.145. Command arguments Value Summary -h, --help Show this help message and exit Table 68.146. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.147. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.148. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.149. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.38. share instance export location show Show export location for a share instance. Usage: Table 68.150. Positional arguments Value Summary <instance> Name or id of the share instance <export_location> Id of the share instance export location. Table 68.151. Command arguments Value Summary -h, --help Show this help message and exit Table 68.152. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.153. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.154. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.155. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.39. share instance list List share instances Usage: Table 68.156. Command arguments Value Summary -h, --help Show this help message and exit --share <share> Name or id of the share to list instances for. --export-location <export-location> Export location to list instances for. Table 68.157. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.158. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.159. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.160. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.40. share instance set Explicitly reset share instance status Usage: Table 68.161. Positional arguments Value Summary <instance> Instance to be modified. Table 68.162. Command arguments Value Summary -h, --help Show this help message and exit --status <status> Indicate which state to assign the instance. options are: available, error, creating, deleting,error_deleting, migrating, migrating_to, server_migrating. 68.41. share instance show Show share instance Usage: Table 68.163. Positional arguments Value Summary <instance> Id of the share instance. Table 68.164. Command arguments Value Summary -h, --help Show this help message and exit Table 68.165. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.166. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.167. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.168. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.42. share limits show Show a list of share limits for a user. Usage: Table 68.169. Command arguments Value Summary -h, --help Show this help message and exit --absolute Get the absolute limits for the user --rate Get the api rate limits for the user Table 68.170. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.171. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.172. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.173. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.43. share list List shares Usage: Table 68.174. Command arguments Value Summary -h, --help Show this help message and exit --name <share-name> Filter shares by share name --status <share-status> Filter shares by status --snapshot <share-network-id> Filter shares by snapshot name or id. --export-location <export-location> Filter shares by export location id or path. available only for microversion >= 2.35 --soft-deleted Get shares in recycle bin. if this parameter is set to True (Default=False), only shares in the recycle bin will be displayed. Available only for microversion >= 2.69. --public Include public shares --share-network <share-network-name-or-id> Filter shares exported on a given share network --share-type <share-type-name-or-id> Filter shares of a given share type --share-group <share-group-name-or-id> Filter shares belonging to a given share group --host <share-host> Filter shares belonging to a given host (admin only) --share-server <share-server-id> Filter shares exported via a given share server (admin only) --project <project> Filter shares by project (name or id) (admin only) --project-domain <project-domain> Domain the project belongs to (name or id). this can be used in case collisions between project names exist. --user <user> Filter results by user (name or id) (admin only) --user-domain <user-domain> Domain the user belongs to (name or id). this can be used in case collisions between user names exist. --all-projects Include all projects (admin only) --property <key=value> Filter shares having a given metadata key=value property (repeat option to filter by multiple properties) --extra-spec <key=value> Filter shares with extra specs (key=value) of the share type that they belong to. (repeat option to filter by multiple extra specs) --long List additional fields in output --sort <key>[:<direction>] Sort output by selected keys and directions(asc or desc) (default: name:asc), multiple keys and directions can be specified separated by comma --limit <num-shares> Maximum number of shares to display --marker <share> The last share id of the page --name~ <name~> Filter results matching a share name pattern. Available only for microversion >= 2.36. --description~ <description~> Filter results matching a share description pattern.Available only for microversion >= 2.36. Table 68.175. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.176. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.177. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.178. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.44. share message delete Remove one or more messages Usage: Table 68.179. Positional arguments Value Summary <message> Id of the message(s). Table 68.180. Command arguments Value Summary -h, --help Show this help message and exit 68.45. share message list Lists all messages Usage: Table 68.181. Command arguments Value Summary -h, --help Show this help message and exit --resource-id <resource-id> Filters results by a resource uuid. default=none. --resource-type <resource-type> Filters results by a resource type. default=none. Example: "openstack message list --resource-type share" --action-id <action-id> Filters results by action id. default=none. --detail-id <detail-id> Filters results by detail id. default=none. --request-id <request-id> Filters results by request id. default=none. --message-level <message-level> Filters results by the message level. default=none. Example: "openstack message list --message-level ERROR". --limit <limit> Maximum number of messages to return. (default=none) --since <since> Return only user messages created since given date. The date format must be conforming to ISO8601. Available only for microversion >= 2.52. --before <before> Return only user messages created before given date. The date format must be conforming to ISO8601. Available only for microversion >= 2.52. Table 68.182. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.183. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.184. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.185. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.46. share message show Show details about a message Usage: Table 68.186. Positional arguments Value Summary <message> Id of the message. Table 68.187. Command arguments Value Summary -h, --help Show this help message and exit Table 68.188. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.189. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.190. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.191. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.47. share migration cancel Cancels migration of a given share when copying Usage: Table 68.192. Positional arguments Value Summary <share> Name or id of share to migrate. Table 68.193. Command arguments Value Summary -h, --help Show this help message and exit 68.48. share migration complete Completes migration for a given share Usage: Table 68.194. Positional arguments Value Summary <share> Name or id of share to migrate. Table 68.195. Command arguments Value Summary -h, --help Show this help message and exit 68.49. share migration show Gets migration progress of a given share when copying Usage: Table 68.196. Positional arguments Value Summary <share> Name or id of the share to get share migration progress information. Table 68.197. Command arguments Value Summary -h, --help Show this help message and exit Table 68.198. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.199. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.200. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.201. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.50. share migration start Migrates share to a new host. Usage: Table 68.202. Positional arguments Value Summary <share> Name or id of share to migrate. <host> Destination host where share will be migrated to. use the format host@backend#pool . Table 68.203. Command arguments Value Summary -h, --help Show this help message and exit --force-host-assisted-migration <force-host-assisted-migration> Enforces the use of the host-assisted migration approach, which bypasses driver optimizations. Default=False. --preserve-metadata <preserve-metadata> Enforces migration to preserve all file metadata when moving its contents. If set to True, host- assistedmigration will not be attempted. --preserve-snapshots <preserve-snapshots> Enforces migration of the share snapshots to the destination. If set to True, host-assisted migrationwill not be attempted. --writable <writable> Enforces migration to keep the share writable while contents are being moved. If set to True, host- assistedmigration will not be attempted. --nondisruptive <nondisruptive> Enforces migration to be nondisruptive. if set to True, host-assisted migration will not be attempted. --new-share-network <new_share_network> Specify the new share network for the share. do not specify this parameter if the migrating share has to beretained within its current share network. --new-share-type <new-share-type> Specify the new share type for the share. do not specify this parameter if the migrating share has to be retained with its current share type. 68.51. share network create Create a share network Usage: Table 68.204. Command arguments Value Summary -h, --help Show this help message and exit --name <share-network> Add a name to the share network (optional) --description <description> Add a description to the share network (optional). --neutron-net-id <neutron-net-id> Id of the neutron network that must be associated with the share network (Optional). The network specified will be associated with the default share network subnet, unless availability-zone is also specified. --neutron-subnet-id <neutron-subnet-id> Id of the neutron sub-network that must be associated with the share network (Optional). The subnet specified will be associated with the default share network subnet, unless availability-zone is also specified. --availability-zone <availability-zone> Name or id of the avalilability zone to assign the specified network subnet parameters to. Must be used in conjunction with neutron-net-id and neutron- subnet-id . Do not specify this parameter if the network must be available across all availability zones ( default share network subnet). Available only for microversion >= 2.51. Table 68.205. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.206. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.207. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.208. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.52. share network delete Delete one or more share networks Usage: Table 68.209. Positional arguments Value Summary <share-network> Name or id of the share network(s) to delete Table 68.210. Command arguments Value Summary -h, --help Show this help message and exit --wait Wait for the share network(s) to be deleted 68.53. share network list List share networks Usage: Table 68.211. Command arguments Value Summary -h, --help Show this help message and exit --name <share-network> Filter share networks by name --name~ <share-network-name-pattern> Filter share networks by name-pattern. available only for microversion >= 2.36. --description <share-network-description> Filter share networks by description. available only for microversion >= 2.36 --description~ <share-network-description-pattern> Filter share networks by description-pattern. Available only for microversion >= 2.36. --all-projects Include all projects (admin only) --project <project> Filter share networks by project (name or id) (admin only) --project-domain <project-domain> Domain the project belongs to (name or id). this can be used in case collisions between project names exist. --created-since <yyyy-mm-dd> Filter share networks by date they were created after. The date can be in the format yyyy-mm-dd. --created-before <yyyy-mm-dd> Filter share networks by date they were created before. The date can be in the format yyyy-mm-dd. --security-service <security-service> Filter share networks by the name or id of a security service attached to the network. --neutron-net-id <neutron-net-id> Filter share networks by the id of a neutron network. --neutron-subnet-id <neutron-subnet-id> Filter share networks by the id of a neutron sub network. --network-type <network-type> Filter share networks by the type of network. examples include "flat", "vlan", "vxlan", "geneve", etc. --segmentation-id <segmentation-id> Filter share networks by the segmentation id of network. Relevant only for segmented networks such as "vlan", "vxlan", "geneve", etc. --cidr <X.X.X.X/X> Filter share networks by the cidr of network. --ip-version 4/6 Filter share networks by the ip version of the network, either 4 or 6. --detail List share networks with details Table 68.212. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.213. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.214. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.215. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.54. share network set Set share network properties Usage: Table 68.216. Positional arguments Value Summary <share-network> Name or id of the share network to set a property for Table 68.217. Command arguments Value Summary -h, --help Show this help message and exit --name <name> Set a new name to the share network. --description <description> Set a new description to the share network. --status <status> Assign a status to the share network (admin only). Options include : active, error, network_change. Available only for microversion >= 2.63. --neutron-net-id <neutron-net-id> Update the neutron network associated with the default share network subnet. If a default share network subnet is not present or if the share network is in use, setting this will fail. --neutron-subnet-id <neutron-subnet-id> Update the neutron subnetwork associated with the default share network subnet. If a default share network subnet is not present or if the share network is in use, setting this will fail. --current-security-service <security-service> Name or id of a security service that is currently associated with a share network that must be replaced. Replacing a security service is only available for microversions >= 2.63. --new-security-service <security-service> Name or id of a security service that must be associated with the share network. When replacing a security service, the current security service must also be provided with the --current-security-service option. Replacing a security service is only available for microversions >= 2.63. --check-only Run a dry-run of a security service replacement. Available only for microversion >=2.63 --restart-check Restart a dry-run of a security service replacement. Helpful when check results are stale. Available only for microversion >=2.63. 68.55. share network show Show details about a share network Usage: Table 68.218. Positional arguments Value Summary <share-network> Name or id of the share network to display Table 68.219. Command arguments Value Summary -h, --help Show this help message and exit Table 68.220. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.221. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.222. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.223. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.56. share network subnet create Create a share network subnet Usage: Table 68.224. Positional arguments Value Summary <share-network> Share network name or id. Table 68.225. Command arguments Value Summary -h, --help Show this help message and exit --neutron-net-id <neutron-net-id> Neutron network id. used to set up network for share servers (optional). Should be defined together with ' --neutron-subnet-id'. --neutron-subnet-id <neutron-subnet-id> Neutron subnet id. used to set up network for share servers (optional). Should be defined together with ' --neutron-net-id' to which this subnet belongs to. --availability-zone <availability-zone> Optional availability zone that the subnet is available within (Default=None). If None, the subnet will be considered as being available across all availability zones. --check-only Run a dry-run of a share network subnet create. Available only for microversion >= 2.70. --restart-check Restart a dry-run of a share network subnet create. Helpful when check results are stale. Available only for microversion >= 2.70. Table 68.226. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.227. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.228. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.229. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.57. share network subnet delete Delete a share network subnet Usage: Table 68.230. Positional arguments Value Summary <share-network> Share network name or id. <share-network-subnet> Id(s) of share network subnet(s) to be deleted. Table 68.231. Command arguments Value Summary -h, --help Show this help message and exit 68.58. share network subnet show Show share network subnet Usage: Table 68.232. Positional arguments Value Summary <share-network> Share network name or id. <share-network-subnet> Id of share network subnet to show. Table 68.233. Command arguments Value Summary -h, --help Show this help message and exit Table 68.234. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.235. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.236. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.237. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.59. share network unset Unset a share network property Usage: Table 68.238. Positional arguments Value Summary <share-network> Name or id of the share network to unset a property of Table 68.239. Command arguments Value Summary -h, --help Show this help message and exit --name Unset share network name. --description Unset share network description. --security-service <security-service> Disassociate a security service from the share network. This is only possible with unused share networks. 68.60. share pool list List all backend storage pools known to the scheduler (Admin only). Usage: Table 68.240. Command arguments Value Summary -h, --help Show this help message and exit --host <host> Filter results by host name. regular expressions are supported. --backend <backend> Filter results by backend name. regular expressions are supported. --pool <pool> Filter results by pool name. regular expressions are supported. --detail Show detailed information about pools. --share-type <share-type> Filter results by share type name or id. available only for microversion >= 2.23 Table 68.241. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.242. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.243. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.244. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.61. share properties show Show share properties Usage: Table 68.245. Positional arguments Value Summary <share> Name or id of share Table 68.246. Command arguments Value Summary -h, --help Show this help message and exit Table 68.247. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.248. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.249. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.250. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.62. share quota delete Delete Quota Usage: Table 68.251. Positional arguments Value Summary <project> Name or id of the project to delete quotas for. Table 68.252. Command arguments Value Summary -h, --help Show this help message and exit --user <user> Name or id of user to delete the quotas for. optional. Mutually exclusive with --share-type . --share-type <share-type> Name or id of a share type to delete the quotas for. Optional. Mutually exclusive with --user . Available only for microversion >= 2.39 68.63. share quota set Set Quota for a project, or project/user or project/share-type or a class. Usage: Table 68.253. Positional arguments Value Summary <project/class> A project (name/id) or a class (e.g.: default). Table 68.254. Command arguments Value Summary -h, --help Show this help message and exit --class Update class quota to all projects. mutually exclusive with --user and --share-type . --user <user> Name or id of a user to set the quotas for. mutually exclusive with --share-type and --class . --share-type <share-type> Name or id of a share type to set the quotas for. Mutually exclusive with --user and --class . Available only for microversion >= 2.39 --shares <shares> New value for the "shares" quota. --snapshots <snapshots> New value for the "snapshots" quota. --gigabytes <gigabytes> New value for the "gigabytes" quota. --snapshot-gigabytes <snapshot-gigabytes> New value for the "snapshot-gigabytes" quota. --share-networks <share-networks> New value for the "share-networks" quota. --share-groups <share-groups> New value for the "share-groups" quota. available only for microversion >= 2.40 --share-group-snapshots <share-group-snapshots> New value for the "share-group-snapshots" quota. Available only for microversion >= 2.40 --share-replicas <share-replicas> Number of share replicas. available only for microversion >= 2.53 --replica-gigabytes <replica-gigabytes> Capacity of share replicas in total. available only for microversion >= 2.53 --per-share-gigabytes <per-share-gigabytes> New value for the per-share-gigabytes quota.Available only for microversion >= 2.62 --force Force update the quota. not applicable for class update. 68.64. share quota show Show Quota Usage: Table 68.255. Positional arguments Value Summary <project> Name or id of the project to list quotas for. Table 68.256. Command arguments Value Summary -h, --help Show this help message and exit --user <user> Name or id of user to list the quotas for. optional. Mutually exclusive with --share-type . --share-type <share-type> Name or id of a share type to list the quotas for. Optional. Mutually exclusive with --user . Available only for microversion >= 2.39 --detail Optional flag to indicate whether to show quota in detail. Default false, available only for microversion >= 2.25. --defaults Show the default quotas for the project. Table 68.257. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.258. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.259. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.260. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.65. share replica create Create a replica of the given share Usage: Table 68.261. Positional arguments Value Summary <share> Name or id of the share to replicate. Table 68.262. Command arguments Value Summary -h, --help Show this help message and exit --availability-zone <availability-zone> Availability zone in which the replica should be created. --wait Wait for replica creation --scheduler-hint <key=value> Scheduler hint for the share replica as key=value pairs, Supported key is only_host. Available for microversion >= 2.67. --share-network <share-network-name-or-id> Optional network info id or name. available for microversion >= 2.72 Table 68.263. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.264. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.265. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.266. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.66. share replica delete Delete one or more share replicas Usage: Table 68.267. Positional arguments Value Summary <replica> Name or id of the replica(s) to delete Table 68.268. Command arguments Value Summary -h, --help Show this help message and exit --force Attempt to force delete a replica on its backend. using this option will purge the replica from Manila even if it is not cleaned up on the backend. --wait Wait for share replica deletion 68.67. share replica export location list List export locations of a share replica. Usage: Table 68.269. Positional arguments Value Summary <replica> Id of the share replica. Table 68.270. Command arguments Value Summary -h, --help Show this help message and exit Table 68.271. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.272. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.273. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.274. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.68. share replica export location show Show details of a share replica's export location. Usage: Table 68.275. Positional arguments Value Summary <replica> Id of the share replica. <export-location> Id of the share replica export location. Table 68.276. Command arguments Value Summary -h, --help Show this help message and exit Table 68.277. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.278. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.279. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.280. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.69. share replica list List share replicas Usage: Table 68.281. Command arguments Value Summary -h, --help Show this help message and exit --share <share> Name or id of the share to list replicas for. Table 68.282. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.283. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.284. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.285. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.70. share replica promote Promote specified replica to active replica_state. Usage: Table 68.286. Positional arguments Value Summary <replica> Id of the share replica. Table 68.287. Command arguments Value Summary -h, --help Show this help message and exit --quiesce-wait-time <quiesce-wait-time> Quiesce wait time in seconds. available for microversion >= 2.75 68.71. share replica resync Attempt to update the share replica with its active mirror. Usage: Table 68.288. Positional arguments Value Summary <replica> Id of the share replica to resync. Table 68.289. Command arguments Value Summary -h, --help Show this help message and exit 68.72. share replica set Explicitly set share replica status and/or replica-state Usage: Table 68.290. Positional arguments Value Summary <replica> Id of the share replica to modify. Table 68.291. Command arguments Value Summary -h, --help Show this help message and exit --replica-state <replica-state> Indicate which replica_state to assign the replica. Options include in_sync, out_of_sync, active and error. --status <status> Indicate which status to assign the replica. options include available, error, creating, deleting and error_deleting. 68.73. share replica show Show details about a replica Usage: Table 68.292. Positional arguments Value Summary <replica> Id of the share replica. available only for microversion >= 2.47. Table 68.293. Command arguments Value Summary -h, --help Show this help message and exit Table 68.294. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.295. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.296. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.297. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.74. share resize Resize a share Usage: Table 68.298. Positional arguments Value Summary <share> Name or id of share to resize <new-size> New size of share, in gibs Table 68.299. Command arguments Value Summary -h, --help Show this help message and exit --wait Wait for share resize --force Only applicable when increasing the size of the share,only available with microversion 2.64 and higher. (admin only) 68.75. share restore Restores this share or more shares from the recycle bin Usage: Table 68.300. Positional arguments Value Summary <share> Name or id of the share(s) Table 68.301. Command arguments Value Summary -h, --help Show this help message and exit 68.76. share revert Revert a share to the specified snapshot. Usage: Table 68.302. Positional arguments Value Summary <snapshot> Name or id of the snapshot to restore. the snapshot must be the most recent one known to manila. Table 68.303. Command arguments Value Summary -h, --help Show this help message and exit --wait Wait for share revert 68.77. share security service create Create security service used by project. Usage: Table 68.304. Positional arguments Value Summary <type> Security service type. possible options are: ldap , kerberos , active_directory . Table 68.305. Command arguments Value Summary -h, --help Show this help message and exit --dns-ip <dns-ip> Dns ip address of the security service used inside project's network. --ou <ou> Security service ou (organizational unit). available only for microversion >= 2.44. --server <server> Security service ip address or hostname. --domain <domain> Security service domain. --user <user Security service user or group used by project. --password <password> Password used by user. --name <name> Security service name. --description <description> Security service description. Table 68.306. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.307. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.308. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.309. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.78. share security service delete Delete one or more security services. Usage: Table 68.310. Positional arguments Value Summary <security-service> Name or id of the security service(s) to delete. Table 68.311. Command arguments Value Summary -h, --help Show this help message and exit 68.79. share security service list List security services. Usage: Table 68.312. Command arguments Value Summary -h, --help Show this help message and exit --all-projects Display information from all projects (admin only). --share-network <share-network> Filter results by share network name or id. --status <status> Filter results by status. --name <name> Filter results by security service name. --type <type> Filter results by security service type. --user <user Filter results by security service user or group used by project. --dns-ip <dns-ip> Filter results by dns ip address used inside project's network. --ou <ou> Filter results by security service ou (organizational Unit). Available only for microversion >= 2.44. --server <server> Filter results by security service ip address or hostname. --domain <domain> Filter results by security service domain. --detail Show detailed information about filtered security services. --limit <num-security-services> Limit the number of security services returned --marker <security-service> The last security service id of the page Table 68.313. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.314. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.315. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.316. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.80. share security service set Set security service. Usage: Table 68.317. Positional arguments Value Summary <security-service> Security service name or id. Table 68.318. Command arguments Value Summary -h, --help Show this help message and exit --dns-ip <dns-ip> Set dns ip address used inside project's network. --ou <ou> Set security service ou (organizational unit). Available only for microversion >= 2.44. --server <server> Set security service ip address or hostname. --domain <domain> Set security service domain. --user <user Set security service user or group used by project. --password <password> Set password used by user. --name <name> Set security service name. --description <description> Set security service description. 68.81. share security service show Show security service. Usage: Table 68.319. Positional arguments Value Summary <security-service> Security service name or id to show. Table 68.320. Command arguments Value Summary -h, --help Show this help message and exit Table 68.321. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.322. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.323. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.324. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.82. share security service unset Unset security service. Usage: Table 68.325. Positional arguments Value Summary <security-service> Security service name or id. Table 68.326. Command arguments Value Summary -h, --help Show this help message and exit --dns-ip Unset dns ip address used inside project's network. --ou Unset security service ou (organizational unit). Available only for microversion >= 2.44. --server Unset security service ip address or hostname. --domain Unset security service domain. --user Unset security service user or group used by project. --password Unset password used by user. --name Unset security service name. --description Unset security service description. 68.83. share server abandon Remove one or more share server(s) (Admin only). Usage: Table 68.327. Positional arguments Value Summary <share-server> Id of the server(s) to be abandoned. Table 68.328. Command arguments Value Summary -h, --help Show this help message and exit --force Enforces the unmanage share server operation, even if the backend driver does not support it. --wait Wait until share server is abandoned 68.84. share server adopt Adopt share server not handled by Manila (Admin only). Usage: Table 68.329. Positional arguments Value Summary <host> Backend name as "<node_hostname>@<backend_name>". <share-network> Share network where share server has network allocations in. <identifier> A driver-specific share server identifier required by the driver to manage the share server. Table 68.330. Command arguments Value Summary -h, --help Show this help message and exit --driver-options <key=value> One or more driver-specific key=value pairs that may be necessary to manage the share server (Optional, Default=None). --share-network-subnet <share-network-subnet> Share network subnet where share server has network allocations in.The default subnet will be used if it's not specified. Available for microversion >= 2.51 (Optional, Default=None). --wait Wait until share server is adopted Table 68.331. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.332. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.333. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.334. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.85. share server delete Delete one or more share servers Usage: Table 68.335. Positional arguments Value Summary <share-server> Id(s) of the server(s) to delete Table 68.336. Command arguments Value Summary -h, --help Show this help message and exit --wait Wait for share server deletion. 68.86. share server list List all share servers (Admin only). Usage: Table 68.337. Command arguments Value Summary -h, --help Show this help message and exit --host <hostname> Filter results by name of host. --status <status> Filter results by status. --share-network <share-network> Filter results by share network name or id. --project <project> Filter results by project name or id. --share-network-subnet <share-network-subnet> Filter results by share network subnet that the share server's network allocation exists within. Available for microversion >= 2.51 (Optional, Default=None) --project-domain <project-domain> Domain the project belongs to (name or id). this can be used in case collisions between project names exist. Table 68.338. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.339. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.340. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.341. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.87. share server migration cancel Cancels migration of a given share server when copying Usage: Table 68.342. Positional arguments Value Summary <share_server> Id of share server to cancel migration. Table 68.343. Command arguments Value Summary -h, --help Show this help message and exit 68.88. share server migration complete Completes migration for a given share server Usage: Table 68.344. Positional arguments Value Summary <share_server> Id of share server to complete migration. Table 68.345. Command arguments Value Summary -h, --help Show this help message and exit 68.89. share server migration show Gets migration progress of a given share server when copying Usage: Table 68.346. Positional arguments Value Summary <share_server> Id of share server to show migration progress for. Table 68.347. Command arguments Value Summary -h, --help Show this help message and exit Table 68.348. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.349. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.350. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.351. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.90. share server migration start Migrates share server to a new host. Usage: Table 68.352. Positional arguments Value Summary <share_server> Id of share server to start migration. <host@backend> Destination to migrate the share server to. use the format <node_hostname>@<backend_name> . Table 68.353. Command arguments Value Summary -h, --help Show this help message and exit --preserve-snapshots <True|False> Set to true if snapshots must be preserved at the migration destination. --writable <True|False> Enforces migration to keep all its shares writable while contents are being moved. --nondisruptive <True|False> Enforces migration to be nondisruptive. --new-share-network <new_share_network> Specify a new share network for the share server. do not specify this parameter if the migrating share server has to be retained within its current share network. --check-only Run a dry-run of the share server migration. Table 68.354. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.355. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.356. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.357. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.91. share server set Set share server properties (Admin only). Usage: Table 68.358. Positional arguments Value Summary <share-server> Id of the share server to modify. Table 68.359. Command arguments Value Summary -h, --help Show this help message and exit --status <status> Assign a status to the share server. options include: unmanage_starting, server_migrating_to, error, unmanage_error, manage_error, inactive, active, server_migrating, manage_starting, deleting, network_change. If no state is provided, active will be used. --task-state <task-state> Indicate which task state to assign the share server. Options include migration_starting, migration_in_progress, migration_completing, migration_success, migration_error, migration_cancelled, migration_driver_in_progress, migration_driver_phase1_done, data_copying_starting, data_copying_in_progress, data_copying_completing, data_copying_completed, data_copying_cancelled, data_copying_error. 68.92. share server show Show details about a share server (Admin only). Usage: Table 68.360. Positional arguments Value Summary <share-server> Id of share server. Table 68.361. Command arguments Value Summary -h, --help Show this help message and exit Table 68.362. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.363. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.364. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.365. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.93. share service list List share services (Admin only). Usage: Table 68.366. Command arguments Value Summary -h, --help Show this help message and exit --host <host> Filter services by name of the host. --binary <binary> Filter services by the name of the service. --status <status> Filter results by status. --state <state> Filter results by state. --zone <zone> Filter services by their availability zone. Table 68.367. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.368. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.369. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.370. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.94. share service set Enable/Disable share service (Admin only). Usage: Table 68.371. Positional arguments Value Summary <host> Host name as example_host@example_backend . <binary> Service binary, could be manila-share , manila-scheduler or manila-data Table 68.372. Command arguments Value Summary -h, --help Show this help message and exit --enable Enable share service --disable Disable share service 68.95. share set Set share properties Usage: Table 68.373. Positional arguments Value Summary <share> Share to modify (name or id) Table 68.374. Command arguments Value Summary -h, --help Show this help message and exit --property <key=value> Set a property to this share (repeat option to set multiple properties) --name <name> New share name. (default=none) --description <description> New share description. (default=none) --public <public> Level of visibility for share. defines whether other tenants are able to see it or not. --status <status> Explicitly update the status of a share (admin only). Examples include: available, error, creating, deleting, error_deleting. --task-state <task-state> Indicate which task state to assign the share. options include migration_starting, migration_in_progress, migration_completing, migration_success, migration_error, migration_cancelled, migration_driver_in_progress, migration_driver_phase1_done, data_copying_starting, data_copying_in_progress, data_copying_completing, data_copying_completed, data_copying_cancelled, data_copying_error. 68.96. share show Display share details Usage: Table 68.375. Positional arguments Value Summary <share> Share to display (name or id) Table 68.376. Command arguments Value Summary -h, --help Show this help message and exit Table 68.377. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.378. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.379. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.380. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.97. share snapshot abandon Abandon share snapshot(s) Usage: Table 68.381. Positional arguments Value Summary <snapshot> Name or id of the snapshot(s) to be abandoned. Table 68.382. Command arguments Value Summary -h, --help Show this help message and exit --wait Wait until share snapshot is abandoned 68.98. share snapshot access create Allow access to a snapshot Usage: Table 68.383. Positional arguments Value Summary <snapshot> Name or id of the snapshot <access_type> Access rule type (only "ip", "user" (user or group), "cert" or "cephx" are supported). <access_to> Value that defines access. Table 68.384. Command arguments Value Summary -h, --help Show this help message and exit Table 68.385. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.386. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.387. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.388. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.99. share snapshot access delete Delete access to a snapshot Usage: Table 68.389. Positional arguments Value Summary <snapshot> Name or id of the share snapshot to deny access to. <id> Id(s) of the access rule(s) to be deleted. Table 68.390. Command arguments Value Summary -h, --help Show this help message and exit 68.100. share snapshot access list Show access list for a snapshot Usage: Table 68.391. Positional arguments Value Summary <snapshot> Name or id of the share snapshot to show access list for. Table 68.392. Command arguments Value Summary -h, --help Show this help message and exit Table 68.393. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.394. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.395. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.396. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.101. share snapshot adopt Adopt a share snapshot Usage: Table 68.397. Positional arguments Value Summary <share> Name or id of the share that owns the snapshot to be adopted. <provider-location> Provider location of the snapshot on the backend. Table 68.398. Command arguments Value Summary -h, --help Show this help message and exit --name <name> Optional snapshot name (default=none). --description <description> Optional snapshot description (default=none). --driver-option <key=value> Set driver options as key=value pairs.(repeat option to set multiple key=value pairs) --wait Wait until share snapshot is adopted Table 68.399. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.400. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.401. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.402. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.102. share snapshot create Create a snapshot of the given share Usage: Table 68.403. Positional arguments Value Summary <share> Name or id of the share to create snapshot of Table 68.404. Command arguments Value Summary -h, --help Show this help message and exit --force Optional flag to indicate whether to snapshot a share even if it's busy. (Default=False) --name <name> Add a name to the snapshot (optional). --description <description> Add a description to the snapshot (optional). --wait Wait for share snapshot creation --property <key=value> Set a property to this snapshot (repeat option to set multiple properties).Available only for microversion >= 2.73 Table 68.405. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.406. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.407. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.408. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.103. share snapshot delete Delete one or more share snapshots Usage: Table 68.409. Positional arguments Value Summary <snapshot> Name or id of the snapshot(s) to delete Table 68.410. Command arguments Value Summary -h, --help Show this help message and exit --force Delete the snapshot(s) ignoring the current state. --wait Wait for share snapshot deletion 68.104. share snapshot export location list List export locations of a given snapshot Usage: Table 68.411. Positional arguments Value Summary <snapshot> Name or id of the share snapshot. Table 68.412. Command arguments Value Summary -h, --help Show this help message and exit Table 68.413. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.414. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.415. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.416. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.105. share snapshot export location show Show export location of the share snapshot Usage: Table 68.417. Positional arguments Value Summary <snapshot> Name or id of the share snapshot. <export-location> Id of the share snapshot export location. Table 68.418. Command arguments Value Summary -h, --help Show this help message and exit Table 68.419. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.420. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.421. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.422. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.106. share snapshot instance export location list List export locations from a share snapshot instance. Usage: Table 68.423. Positional arguments Value Summary <instance> Name or id of the share instance. Table 68.424. Command arguments Value Summary -h, --help Show this help message and exit Table 68.425. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.426. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.427. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.428. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.107. share snapshot instance export location show Show export location of the share snapshot instance. Usage: Table 68.429. Positional arguments Value Summary <snapshot_instance> Id of the share snapshot instance. <export_location> Id of the share snapshot instance export location. Table 68.430. Command arguments Value Summary -h, --help Show this help message and exit Table 68.431. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.432. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.433. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.434. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.108. share snapshot instance list List all share snapshot instances Usage: Table 68.435. Command arguments Value Summary -h, --help Show this help message and exit --snapshot <snapshot> Filter results by share snapshot id. --detailed Show detailed information about snapshot instances. Table 68.436. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.437. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.438. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.439. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.109. share snapshot instance set Explicitly update the state of a share snapshot instance. Usage: Table 68.440. Positional arguments Value Summary <snapshot_instance> Id of the share snapshot instance to update. Table 68.441. Command arguments Value Summary -h, --help Show this help message and exit --status <status> Indicate state to update the snapshot instance to. Default is available. 68.110. share snapshot instance show Show details about a share snapshot instance. Usage: Table 68.442. Positional arguments Value Summary <snapshot_instance> Id of the share snapshot instance. Table 68.443. Command arguments Value Summary -h, --help Show this help message and exit Table 68.444. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.445. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.446. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.447. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.111. share snapshot list List snapshots Usage: Table 68.448. Command arguments Value Summary -h, --help Show this help message and exit --all-projects Display snapshots from all projects (admin only). --name <name> Filter results by name. --description <description> Filter results by description. available only for microversion >= 2.36. --status <status> Filter results by status --share <share> Name or id of a share to filter results by. --usage <usage> Option to filter snapshots by usage. --limit <num-snapshots> Limit the number of snapshots returned --marker <snapshot> The last share id of the page --sort <key>[:<direction>] Sort output by selected keys and directions(asc or desc) (default: name:asc), multiple keys and directions can be specified separated by comma --name~ <name~> Filter results matching a share snapshot name pattern. Available only for microversion >= 2.36. --description~ <description~> Filter results matching a share snapshot description pattern. Available only for microversion >= 2.36. --detail List share snapshots with details --property <key=value> Filter snapshots having a given metadata key=value property. (repeat option to filter by multiple properties) Table 68.449. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.450. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.451. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.452. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.112. share snapshot set Set share snapshot properties Usage: Table 68.453. Positional arguments Value Summary <snapshot> Name or id of the snapshot to set a property for Table 68.454. Command arguments Value Summary -h, --help Show this help message and exit --name <name> Set a name to the snapshot. --description <description> Set a description to the snapshot. --status <status> Assign a status to the snapshot (admin only). options include : available, error, creating, deleting, manage_starting, manage_error, unmanage_starting, unmanage_error, error_deleting. --property <key=value> Set a property to this snapshot (repeat option to set multiple properties) 68.113. share snapshot show Show details about a share snapshot Usage: Table 68.455. Positional arguments Value Summary <snapshot> Name or id of the snapshot to display Table 68.456. Command arguments Value Summary -h, --help Show this help message and exit Table 68.457. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.458. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.459. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.460. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.114. share snapshot unset Unset a share snapshot property Usage: Table 68.461. Positional arguments Value Summary <snapshot> Name or id of the snapshot to set a property for Table 68.462. Command arguments Value Summary -h, --help Show this help message and exit --name Unset snapshot name. --description Unset snapshot description. --property <key> Remove a property from snapshot (repeat option to remove multiple properties) 68.115. share type access create Add access for share type Usage: Table 68.463. Positional arguments Value Summary <share_type> Share type name or id to add access to <project_id> Project id to add share type access for Table 68.464. Command arguments Value Summary -h, --help Show this help message and exit 68.116. share type access delete Delete access from share type Usage: Table 68.465. Positional arguments Value Summary <share_type> Share type name or id to delete access from <project_id> Project id to delete share type access for Table 68.466. Command arguments Value Summary -h, --help Show this help message and exit 68.117. share type access list Get access list for share type Usage: Table 68.467. Positional arguments Value Summary <share_type> Share type name or id to get access list for Table 68.468. Command arguments Value Summary -h, --help Show this help message and exit Table 68.469. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.470. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.471. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.472. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.118. share type create Create new share type Usage: Table 68.473. Positional arguments Value Summary <name> Share type name <spec_driver_handles_share_servers> Required extra specification. valid values are true and false Table 68.474. Command arguments Value Summary -h, --help Show this help message and exit --description <description> Share type description. available only for microversion >= 2.41. --snapshot-support <snapshot_support> Boolean extra spec used for filtering of back ends by their capability to create share snapshots. --create-share-from-snapshot-support <create_share_from_snapshot_support> Boolean extra spec used for filtering of back ends by their capability to create shares from snapshots. --revert-to-snapshot-support <revert_to_snapshot_support> Boolean extra spec used for filtering of back ends by their capability to revert shares to snapshots. (Default is False). --mount-snapshot-support <mount_snapshot_support> Boolean extra spec used for filtering of back ends by their capability to mount share snapshots. (Default is False). --extra-specs [<key=value> ... ] Extra specs key and value of share type that will be used for share type creation. OPTIONAL: Default=None. example --extra-specs thin_provisioning= <is> True , replication_type=readable. --public <public> Make type accessible to the public (default true). Table 68.475. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.476. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.477. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.478. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.119. share type delete Delete a share type Usage: Table 68.479. Positional arguments Value Summary <share_types> Name or id of the share type(s) to delete Table 68.480. Command arguments Value Summary -h, --help Show this help message and exit 68.120. share type list List share types Usage: Table 68.481. Command arguments Value Summary -h, --help Show this help message and exit --all Display all share types whatever public or private. Default=False. (Admin only) --extra-specs [<key=value> ... ] Filter share types with extra specs (key=value). Available only for API microversion >= 2.43. OPTIONAL: Default=None. Table 68.482. Output formatter options Value Summary -f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns --sort-column SORT_COLUMN Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated --sort-ascending Sort the column(s) in ascending order --sort-descending Sort the column(s) in descending order Table 68.483. CSV formatter options Value Summary --quote {all,minimal,none,nonnumeric} When to include quotes, defaults to nonnumeric Table 68.484. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.485. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.121. share type set Set share type properties Usage: Table 68.486. Positional arguments Value Summary <share_type> Name or id of the share type to modify Table 68.487. Command arguments Value Summary -h, --help Show this help message and exit --extra-specs [<key=value> ... ] Extra specs key and value of share type that will be used for share type creation. OPTIONAL: Default=None. example --extra-specs thin_provisioning= <is> True , replication_type=readable. --public <public> New visibility of the share type. if set to true, share type will be available to all projects in the cloud. Available only for microversion >= 2.50 --description <description> New description of share type. available only for microversion >= 2.50 --name <name> New name of share type. available only for microversion >= 2.50 68.122. share type show Display share type details Usage: Table 68.488. Positional arguments Value Summary <share_type> Share type to display (name or id) Table 68.489. Command arguments Value Summary -h, --help Show this help message and exit Table 68.490. Output formatter options Value Summary -f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} The output format, defaults to table -c COLUMN, --column COLUMN Specify the column(s) to include, can be repeated to show multiple columns Table 68.491. JSON formatter options Value Summary --noindent Whether to disable indenting the json Table 68.492. Shell formatter options Value Summary --prefix PREFIX Add a prefix to all variable names Table 68.493. Table formatter options Value Summary --max-width <integer> Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. --fit-width Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable --print-empty Print empty table if there is no data to show. 68.123. share type unset Unset share type extra specs Usage: Table 68.494. Positional arguments Value Summary <share_type> Name or id of the share type to modify <key> Remove extra_specs from this share type Table 68.495. Command arguments Value Summary -h, --help Show this help message and exit 68.124. share unset Unset share properties Usage: Table 68.496. Positional arguments Value Summary <share> Share to modify (name or id) Table 68.497. Command arguments Value Summary -h, --help Show this help message and exit --property <key> Remove a property from share (repeat option to remove multiple properties) --name Unset share name. --description Unset share description.

Commands:
openstack share abandon [-h] [--wait] <share> [<share> ...]
openstack share access create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--properties [<key=value> ...]] [--access-level <access_level>] [--wait] <share> <access_type> <access_to>
openstack share access delete [-h] [--wait] <share> <id>
openstack share access list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--properties [<key=value> ...]] <share>
openstack share access set [-h] [--property <key=value>] <access_id>
openstack share access show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <access_id>
openstack share access unset [-h] [--property <key>] <access_id>
openstack share adopt [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <name>] [--description <description>] [--share-type <share-type>] [--driver-options [<key=value> ...]] [--public] [--share-server-id <share-server-id>] [--wait] <service-host> <protocol> <export-path>
openstack share availability zone list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending]
openstack share create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <name>] [--snapshot-id <snapshot-id>] [--property <key=value>] [--share-network <network-info>] [--description <description>] [--public <public>] [--share-type <share-type>] [--availability-zone <availability-zone>] [--share-group <share-group>] [--wait] [--scheduler-hint <key=value>] <share_protocol> <size>
openstack share delete [-h] [--share-group <share-group>] [--force] [--wait] [--soft] <share> [<share> ...]
openstack share export location list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] <share>
openstack share export location show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <share> <export-location>
openstack share group create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <name>] [--description <description>] [--share-types <share-types> [<share-types> ...]] [--share-group-type <share-group-type>] [--share-network <share-network>] [--source-share-group-snapshot <source-share-group-snapshot>] [--availability-zone <availability-zone>] [--wait]
openstack share group delete [-h] [--force] [--wait] <share_group> [<share_group> ...]
openstack share group list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--all-projects] [--name <name>] [--description <description>] [--status <status>] [--share-server <share-server-id>] [--share-group-type <share-group-type>] [--snapshot <snapshot>] [--host <host>] [--share-network <share-network>] [--project <project>] [--project-domain <project-domain>] [--limit <limit>] [--marker <marker>] [--sort <key>[:<direction>]] [--name~ <name~>] [--description~ <description~>]
openstack share group set [-h] [--name <name>] [--description <description>] [--status <status>] <share-group>
openstack share group show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <share-group>
openstack share group snapshot create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <name>] [--description <description>] [--wait] <share-group>
openstack share group snapshot delete [-h] [--force] [--wait] <share-group-snapshot> [<share-group-snapshot> ...]
openstack share group snapshot list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--all-projects] [--name <name>] [--status <status>] [--share-group <share-group>] [--limit <limit>] [--marker <marker>] [--sort <key>[:<direction>]] [--detailed]
openstack share group snapshot members list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] <share-group-snapshot>
openstack share group snapshot set [-h] [--name <name>] [--description <description>] [--status <status>] <share-group-snapshot>
openstack share group snapshot show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <share-group-snapshot>
openstack share group snapshot unset [-h] [--name] [--description] <share-group-snapshot>
openstack share group type access create [-h] [--project-domain <project-domain>] <share-group-type> <project> [<project> ...]
openstack share group type access delete [-h] [--project-domain <project-domain>] <share-group-type> <project> [<project> ...]
openstack share group type access list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] <share-group-type>
openstack share group type create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--group-specs [<key=value> ...]] [--public <public>] <name> <share-types> [<share-types> ...]
openstack share group type delete [-h] <share-group-types> [<share-group-types> ...]
openstack share group type list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--all] [--group-specs [<key=value> ...]]
openstack share group type set [-h] [--group-specs [<key=value> ...]] <share-group-type>
openstack share group type show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <share-group-type>
openstack share group type unset [-h] <share-group-type> <key> [<key> ...]
openstack share group unset [-h] [--name] [--description] <share-group>
openstack share instance delete [-h] [--wait] <instance> [<instance> ...]
openstack share instance export location list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] <instance>
openstack share instance export location show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <instance> <export_location>
openstack share instance list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--share <share>] [--export-location <export-location>]
openstack share instance set [-h] [--status <status>] <instance>
openstack share instance show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <instance>
openstack share limits show [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] (--absolute | --rate)
openstack share list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--name <share-name>] [--status <share-status>] [--snapshot <share-network-id>] [--export-location <export-location>] [--soft-deleted] [--public] [--share-network <share-network-name-or-id>] [--share-type <share-type-name-or-id>] [--share-group <share-group-name-or-id>] [--host <share-host>] [--share-server <share-server-id>] [--project <project>] [--project-domain <project-domain>] [--user <user>] [--user-domain <user-domain>] [--all-projects] [--property <key=value>] [--extra-spec <key=value>] [--long] [--sort <key>[:<direction>]] [--limit <num-shares>] [--marker <share>] [--name~ <name~>] [--description~ <description~>]
openstack share message delete [-h] <message> [<message> ...]
openstack share message list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--resource-id <resource-id>] [--resource-type <resource-type>] [--action-id <action-id>] [--detail-id <detail-id>] [--request-id <request-id>] [--message-level <message-level>] [--limit <limit>] [--since <since>] [--before <before>]
openstack share message show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <message>
openstack share migration cancel [-h] <share>
openstack share migration complete [-h] <share>
openstack share migration show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <share>
openstack share migration start [-h] [--force-host-assisted-migration <force-host-assisted-migration>] --preserve-metadata <preserve-metadata> --preserve-snapshots <preserve-snapshots> --writable <writable> --nondisruptive <nondisruptive> [--new-share-network <new_share_network>] [--new-share-type <new-share-type>] <share> <host>
openstack share network create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <share-network>] [--description <description>] [--neutron-net-id <neutron-net-id>] [--neutron-subnet-id <neutron-subnet-id>] [--availability-zone <availability-zone>]
openstack share network delete [-h] [--wait] <share-network> [<share-network> ...]
openstack share network list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--name <share-network>] [--name~ <share-network-name-pattern>] [--description <share-network-description>] [--description~ <share-network-description-pattern>] [--all-projects] [--project <project>] [--project-domain <project-domain>] [--created-since <yyyy-mm-dd>] [--created-before <yyyy-mm-dd>] [--security-service <security-service>] [--neutron-net-id <neutron-net-id>] [--neutron-subnet-id <neutron-subnet-id>] [--network-type <network-type>] [--segmentation-id <segmentation-id>] [--cidr <X.X.X.X/X>] [--ip-version 4/6] [--detail]
openstack share network set [-h] [--name <name>] [--description <description>] [--status <status>] [--neutron-net-id <neutron-net-id>] [--neutron-subnet-id <neutron-subnet-id>] [--current-security-service <security-service>] [--new-security-service <security-service>] [--check-only] [--restart-check] <share-network>
openstack share network show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <share-network>
openstack share network subnet create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--neutron-net-id <neutron-net-id>] [--neutron-subnet-id <neutron-subnet-id>] [--availability-zone <availability-zone>] [--check-only] [--restart-check] <share-network>
openstack share network subnet delete [-h] <share-network> <share-network-subnet> [<share-network-subnet> ...]
openstack share network subnet show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <share-network> <share-network-subnet>
openstack share network unset [-h] [--name] [--description] [--security-service <security-service>] <share-network>
openstack share pool list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--host <host>] [--backend <backend>] [--pool <pool>] [--detail] [--share-type <share-type>]
openstack share properties show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <share>
openstack share quota delete [-h] [--user <user> | --share-type <share-type>] <project>
openstack share quota set [-h] [--class | --user <user> | --share-type <share-type>] [--shares <shares>] [--snapshots <snapshots>] [--gigabytes <gigabytes>] [--snapshot-gigabytes <snapshot-gigabytes>] [--share-networks <share-networks>] [--share-groups <share-groups>] [--share-group-snapshots <share-group-snapshots>] [--share-replicas <share-replicas>] [--replica-gigabytes <replica-gigabytes>] [--per-share-gigabytes <per-share-gigabytes>] [--force] <project/class>
openstack share quota show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--user <user> | --share-type <share-type>] [--detail] [--defaults] <project>
openstack share replica create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--availability-zone <availability-zone>] [--wait] [--scheduler-hint <key=value>] [--share-network <share-network-name-or-id>] <share>
openstack share replica delete [-h] [--force] [--wait] <replica> [<replica> ...]
openstack share replica export location list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] <replica>
openstack share replica export location show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <replica> <export-location>
openstack share replica list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--share <share>]
openstack share replica promote [-h] [--quiesce-wait-time <quiesce-wait-time>] <replica>
openstack share replica resync [-h] <replica>
openstack share replica set [-h] [--replica-state <replica-state>] [--status <status>] <replica>
openstack share replica show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <replica>
openstack share resize [-h] [--wait] [--force] <share> <new-size>
openstack share restore [-h] <share> [<share> ...]
openstack share revert [-h] [--wait] <snapshot>
openstack share security service create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--dns-ip <dns-ip>] [--ou <ou>] [--server <server>] [--domain <domain>] [--user <user] [--password <password>] [--name <name>] [--description <description>] <type>
openstack share security service delete [-h] <security-service> [<security-service> ...]
openstack share security service list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--all-projects] [--share-network <share-network>] [--status <status>] [--name <name>] [--type <type>] [--user <user] [--dns-ip <dns-ip>] [--ou <ou>] [--server <server>] [--domain <domain>] [--detail] [--limit <num-security-services>] [--marker <security-service>]
openstack share security service set [-h] [--dns-ip <dns-ip>] [--ou <ou>] [--server <server>] [--domain <domain>] [--user <user] [--password <password>] [--name <name>] [--description <description>] <security-service>
openstack share security service show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <security-service>
openstack share security service unset [-h] [--dns-ip] [--ou] [--server] [--domain] [--user] [--password] [--name] [--description] <security-service>
openstack share server abandon [-h] [--force] [--wait] <share-server> [<share-server> ...]
openstack share server adopt [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--driver-options <key=value>] [--share-network-subnet <share-network-subnet>] [--wait] <host> <share-network> <identifier>
openstack share server delete [-h] [--wait] <share-server> [<share-server> ...]
openstack share server list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--host <hostname>] [--status <status>] [--share-network <share-network>] [--project <project>] [--share-network-subnet <share-network-subnet>] [--project-domain <project-domain>]
openstack share server migration cancel [-h] <share_server>
openstack share server migration complete [-h] <share_server>
openstack share server migration show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <share_server>
openstack share server migration start [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] --preserve-snapshots <True|False> --writable <True|False> --nondisruptive <True|False> [--new-share-network <new_share_network>] [--check-only] <share_server> <host@backend>
openstack share server set [-h] [--status <status>] [--task-state <task-state>] <share-server>
openstack share server show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <share-server>
openstack share service list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--host <host>] [--binary <binary>] [--status <status>] [--state <state>] [--zone <zone>]
openstack share service set [-h] [--enable | --disable] <host> <binary>
openstack share set [-h] [--property <key=value>] [--name <name>] [--description <description>] [--public <public>] [--status <status>] [--task-state <task-state>] <share>
openstack share show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <share>
openstack share snapshot abandon [-h] [--wait] <snapshot> [<snapshot> ...]
openstack share snapshot access create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <snapshot> <access_type> <access_to>
openstack share snapshot access delete [-h] <snapshot> <id> [<id> ...]
openstack share snapshot access list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] <snapshot>
openstack share snapshot adopt [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--name <name>] [--description <description>] [--driver-option <key=value>] [--wait] <share> <provider-location>
openstack share snapshot create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--force] [--name <name>] [--description <description>] [--wait] [--property <key=value>] <share>
openstack share snapshot delete [-h] [--force] [--wait] <snapshot> [<snapshot> ...]
openstack share snapshot export location list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] <snapshot>
openstack share snapshot export location show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <snapshot> <export-location>
openstack share snapshot instance export location list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] <instance>
openstack share snapshot instance export location show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <snapshot_instance> <export_location>
openstack share snapshot instance list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--snapshot <snapshot>] [--detailed]
openstack share snapshot instance set [-h] [--status <status>] <snapshot_instance>
openstack share snapshot instance show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <snapshot_instance>
openstack share snapshot list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--all-projects] [--name <name>] [--description <description>] [--status <status>] [--share <share>] [--usage <usage>] [--limit <num-snapshots>] [--marker <snapshot>] [--sort <key>[:<direction>]] [--name~ <name~>] [--description~ <description~>] [--detail] [--property <key=value>]
openstack share snapshot set [-h] [--name <name>] [--description <description>] [--status <status>] [--property <key=value>] <snapshot>
openstack share snapshot show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <snapshot>
openstack share snapshot unset [-h] [--name] [--description] [--property <key>] <snapshot>
openstack share type access create [-h] <share_type> <project_id>
openstack share type access delete [-h] <share_type> <project_id>
openstack share type access list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] <share_type>
openstack share type create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description <description>] [--snapshot-support <snapshot_support>] [--create-share-from-snapshot-support <create_share_from_snapshot_support>] [--revert-to-snapshot-support <revert_to_snapshot_support>] [--mount-snapshot-support <mount_snapshot_support>] [--extra-specs [<key=value> ...]] [--public <public>] <name> <spec_driver_handles_share_servers>
openstack share type delete [-h] <share_types> [<share_types> ...]
openstack share type list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--all] [--extra-specs [<key=value> ...]]
openstack share type set [-h] [--extra-specs [<key=value> ...]] [--public <public>] [--description <description>] [--name <name>] <share_type>
openstack share type show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <share_type>
openstack share type unset [-h] <share_type> <key> [<key> ...]
openstack share unset [-h] [--property <key>] [--name] [--description] <share>