diff --git a/doc/cli-reference/generated/ch_cli_manila_commands.xml b/doc/cli-reference/generated/ch_cli_manila_commands.xml index f229ffd8fe..f691beed5c 100644 --- a/doc/cli-reference/generated/ch_cli_manila_commands.xml +++ b/doc/cli-reference/generated/ch_cli_manila_commands.xml @@ -15,7 +15,7 @@ interface (CLI) for the Shared file systems API and its extensions. This chapter documents manila version - 1.3.0. + 1.4.0. For help on a specific manila @@ -78,6 +78,110 @@ + + cg-create + + + Creates a new consistency group. + + + + + cg-delete + + + Remove one or more consistency groups. + + + + + cg-list + + + List consistency groups with filters. + + + + + cg-reset-state + + + Explicitly update the state of a consistency group. + + + + + cg-show + + + Show details about a consistency group. + + + + + cg-snapshot-create + + + Creates a new consistency group. + + + + + cg-snapshot-delete + + + Remove one or more consistency group snapshots. + + + + + cg-snapshot-list + + + List consistency group snapshots with filters. + + + + + cg-snapshot-members + + + Get member details for a consistency group snapshot. + + + + + cg-snapshot-reset-state + + + Explicitly update the state of a consistency group. + + + + + cg-snapshot-show + + + Show details about a consistency group snapshot. + + + + + cg-snapshot-update + + + Update a consistency group snapshot. + + + + + cg-update + + + Update a consistency group. + + + create @@ -180,6 +284,7 @@ migrate + Migrates share to a new host. @@ -856,6 +961,442 @@ Show access list for share. Display the API version information. +
+ manila cg-create + usage: manila cg-create [--name <name>] [--description <description>] + [--share-types <share_types>] + [--share-network <share_network>] + [--source-cgsnapshot-id <source_cgsnapshot_id>] + +Creates a new consistency group. + + Optional arguments + + --name <name> + + + Optional consistency group name. (Default=None) + + + + + --description <description> + + + Optional consistency group description. (Default=None) + + + + + --share-types <share_types>, --share_types <share_types> + + + Optional list of share types. (Default=None) + + + + + --share-network <share_network>, --share_network <share_network> + + + Specify share-network name or id. + + + + + --source-cgsnapshot-id <source_cgsnapshot_id>, --source_cgsnapshot_id <source_cgsnapshot_id> + + + Optional snapshot ID to create the share from. + (Default=None) + + + + +
+
+ manila cg-delete + usage: manila cg-delete [--force] + <consistency_group> [<consistency_group> ...] + +Remove one or more consistency groups. + + Positional arguments + + <consistency_group> + + + Name or ID of the consistency group(s). + + + + + + Optional arguments + + --force + + + Attempt to force delete the consistency group + (Default=False). + + + + +
+
+ manila cg-list + usage: manila cg-list [--all-tenants [<0|1>]] [--limit <limit>] + [--offset <offset>] + +List consistency groups with filters. + + Optional arguments + + --all-tenants [<0|1>] + + + Display information from all tenants (Admin only). + + + + + --limit <limit> + + + Maximum number of consistency groups to return. + (Default=None) + + + + + --offset <offset> + + + Start position of consistency group listing. + + + + +
+
+ manila cg-reset-state + usage: manila cg-reset-state [--state <state>] <consistency_group> + +Explicitly update the state of a consistency group. + + Positional arguments + + <consistency_group> + + + Name or ID of the consistency group state to modify. + + + + + + Optional arguments + + --state <state> + + + Indicate which state to assign the consistency group. + Options include available, error, creating, deleting, + error_deleting. If no state is provided, available will + be used. + + + + +
+
+ manila cg-show + usage: manila cg-show <consistency_group> + +Show details about a consistency group. + + Positional arguments + + <consistency_group> + + + Name or ID of the consistency group. + + + + +
+
+ manila cg-snapshot-create + usage: manila cg-snapshot-create [--name <name>] [--description <description>] + <consistency_group> + +Creates a new consistency group. + + Positional arguments + + <consistency_group> + + + Name or ID of the consistency group. + + + + + + Optional arguments + + --name <name> + + + Optional consistency group snapshot name. + (Default=None) + + + + + --description <description> + + + Optional consistency group snapshot description. + (Default=None) + + + + +
+
+ manila cg-snapshot-delete + usage: manila cg-snapshot-delete [--force] <cg_snapshot> [<cg_snapshot> ...] + +Remove one or more consistency group snapshots. + + Positional arguments + + <cg_snapshot> + + + Name or ID of the consistency group snapshot. + + + + + + Optional arguments + + --force + + + Attempt to force delete the cg snapshot(s) (Default=False). + + + + +
+
+ manila cg-snapshot-list + usage: manila cg-snapshot-list [--all-tenants [<0|1>]] [--limit <limit>] + [--offset <offset>] [--detailed DETAILED] + +List consistency group snapshots with filters. + + Optional arguments + + --all-tenants [<0|1>] + + + Display information from all tenants (Admin only). + + + + + --limit <limit> + + + Maximum number of consistency group snapshots to + return.(Default=None) + + + + + --offset <offset> + + + Start position of consistency group snapshot listing. + + + + + --detailed DETAILED + + + Show detailed information about snapshots. + + + + +
+
+ manila cg-snapshot-members + usage: manila cg-snapshot-members [--limit <limit>] [--offset <offset>] + <cg_snapshot> + +Get member details for a consistency group snapshot. + + Positional arguments + + <cg_snapshot> + + + Name or ID of the consistency group snapshot. + + + + + + Optional arguments + + --limit <limit> + + + Maximum number of shares to return. (Default=None) + + + + + --offset <offset> + + + Start position of security services listing. + + + + +
+
+ manila cg-snapshot-reset-state + usage: manila cg-snapshot-reset-state [--state <state>] <cg_snapshot> + +Explicitly update the state of a consistency group. + + Positional arguments + + <cg_snapshot> + + + Name or ID of the consistency group snapshot. + + + + + + Optional arguments + + --state <state> + + + Indicate which state to assign the consistency group. + Options include available, error, creating, deleting, + error_deleting. If no state is provided, available will be + used. + + + + +
+
+ manila cg-snapshot-show + usage: manila cg-snapshot-show <cg_snapshot> + +Show details about a consistency group snapshot. + + Positional arguments + + <cg_snapshot> + + + Name or ID of the consistency group snapshot. + + + + +
+
+ manila cg-snapshot-update + usage: manila cg-snapshot-update [--name <name>] [--description <description>] + <cg_snapshot> + +Update a consistency group snapshot. + + Positional arguments + + <cg_snapshot> + + + Name or ID of the cg snapshot to update. + + + + + + Optional arguments + + --name <name> + + + Optional new name for the cg snapshot. (Default=None + + + + + --description <description> + + + Optional cg snapshot description. (Default=None) + + + + +
+
+ manila cg-update + usage: manila cg-update [--name <name>] [--description <description>] + <consistency_group> + +Update a consistency group. + + Positional arguments + + <consistency_group> + + + Name or ID of the consistency group to update. + + + + + + Optional arguments + + --name <name> + + + Optional new name for the consistency group. + (Default=None) + + + + + --description <description> + + + Optional consistency group description. (Default=None) + + + + +
manila create usage: manila create [--snapshot-id <snapshot-id>] [--name <name>] @@ -863,6 +1404,7 @@ Display the API version information. [--share-network <network-info>] [--description <description>] [--share-type <share-type>] [--public] [--availability-zone <availability-zone>] + [--consistency-group <consistency-group>] <share_protocol> <size> Creates a new share (NFS, CIFS, GlusterFS or HDFS). @@ -954,6 +1496,15 @@ Creates a new share (NFS, CIFS, GlusterFS or HDFS). + + --consistency-group <consistency-group>, --consistency_group <consistency-group>, --cg <consistency-group> + + + Optional consistency group name or ID in which to + create the share. (Default=None) + + +
@@ -965,7 +1516,8 @@ Show user credentials returned from auth.
manila delete - usage: manila delete <share> [<share> ...] + usage: manila delete [--consistency-group <consistency-group>] + <share> [<share> ...] Remove one or more shares. @@ -978,6 +1530,18 @@ Remove one or more shares. + + + Optional arguments + + --consistency-group <consistency-group>, --consistency_group <consistency-group>, --cg <consistency-group> + + + Optional consistency group name or ID which contains + the share. (Default=None) + + +
@@ -1046,7 +1610,8 @@ Attempt force-delete of share, regardless of state. [--offset <offset>] [--sort-key <sort_key>] [--sort-dir <sort_dir>] [--snapshot <snapshot>] [--host <host>] [--share-network <share_network>] - [--project-id <project_id>] [--public] + [--project-id <project_id>] [--public] + [--consistency-group <consistency_group>] List NAS shares with filters. @@ -1194,6 +1759,14 @@ List NAS shares with filters. + + --consistency-group <consistency_group>, --consistency_group <consistency_group>, --cg <consistency_group> + + + Filter results by consistency group name or ID. + + +
@@ -1356,6 +1929,7 @@ Update all metadata of a share. manila migrate usage: manila migrate [--force-host-copy <True|False>] <share> <host#pool> +Migrates share to a new host. Positional arguments @@ -2795,8 +3369,7 @@ List all the snapshots. Key to be sorted, available keys are ('id', 'status', 'size', 'share_id', 'user_id', 'project_id', - 'progress', 'name', 'display_name'). OPTIONAL: - Default=None. + 'progress', 'name', 'display_name'). Default=None.