diff --git a/doc/cli-reference/source/senlin.rst b/doc/cli-reference/source/senlin.rst index e37beba60b..4dfd68150d 100644 --- a/doc/cli-reference/source/senlin.rst +++ b/doc/cli-reference/source/senlin.rst @@ -9,7 +9,7 @@ Clustering service command-line client The senlin client is the command-line interface (CLI) for the Clustering service API and its extensions. -This chapter documents :command:`senlin` version ``0.2.1``. +This chapter documents :command:`senlin` version ``0.4.0``. For help on a specific :command:`senlin` command, enter: @@ -80,12 +80,6 @@ Subcommands ``cluster-policy-detach`` Detach policy from cluster. -``cluster-policy-disable`` - Disable a policy on a cluster. - -``cluster-policy-enable`` - Enable a policy on a cluster. - ``cluster-policy-list`` List policies from cluster. @@ -123,12 +117,6 @@ Subcommands ``node-delete`` Delete the node(s). -``node-join`` - Make node join the specified cluster. - -``node-leave`` - Make node leave its current cluster. - ``node-list`` Show list of nodes. @@ -314,8 +302,8 @@ senlin action-list .. code-block:: console - usage: senlin action-list [-f ] [-k ] - [-s ] [-l ] [-m ] [-F] + usage: senlin action-list [-f ] [-o ] + [-l ] [-m ] [-F] List actions. @@ -327,12 +315,10 @@ Optional arguments can be specified multiple times, or once with parameters separated by a semicolon. -``-k , --sort-keys `` - Name of keys used for sorting the returned actions. - -``-s , --sort-dir `` - Direction for sorting, where DIR can be "asc" or - "desc". +``-o , --sort `` + Sorting option which is a string containing a list of + keys separated by commas. Each key can be optionally + appened by a sort direction (:asc or :desc) ``-l , --limit `` Limit the number of actions returned. @@ -381,8 +367,8 @@ senlin cluster-create .. code-block:: console usage: senlin cluster-create -p [-n ] [-m ] - [-c ] [-o ] - [-t ] [-M ] + [-c ] [-t ] + [-M ] Create the cluster. @@ -410,9 +396,6 @@ Optional arguments Desired capacity of the cluster. Default to min_size if min_size is specified else 0. -``-o , --parent `` - ID of the parent cluster, if exists. - ``-t , --timeout `` Cluster creation timeout in seconds. @@ -445,28 +428,23 @@ senlin cluster-list .. code-block:: console - usage: senlin cluster-list [-n] [-f ] [-k ] - [-s ] [-l ] [-m ] [-g] [-F] + usage: senlin cluster-list [-f ] [-o ] + [-l ] [-m ] [-g] [-F] List the user's clusters. Optional arguments ------------------ -``-n, --show-nested`` - Include nested clusters if any. - ``-f , --filters `` Filter parameters to apply on returned clusters. This can be specified multiple times, or once with parameters separated by a semicolon. -``-k , --sort-keys `` - Name of keys used for sorting the returned clusters. - -``-s , --sort-dir `` - Direction for sorting, where DIR can be "asc" or - "desc". +``-o , --sort `` + Sorting option which is a string containing a list of + keys separated by commas. Each key can be optionally + appened by a sort direction (:asc or :desc) ``-l , --limit `` Limit the number of clusters returned. @@ -574,9 +552,7 @@ senlin cluster-policy-attach .. code-block:: console - usage: senlin cluster-policy-attach -p [-r ] [-l ] - [-c ] [-e] - + usage: senlin cluster-policy-attach -p [-e] Attach policy to cluster. @@ -592,20 +568,6 @@ Optional arguments ``-p , --policy `` ID or name of policy to be attached. -``-r , --priority `` - An integer specifying the relative priority among all - policies attached to a cluster. The lower the value, - the higher the priority. Default is 50. - -``-l , --enforcement-level `` - An integer between 0 and 100 representing the - enforcement level. Default to enforcement level of - policy. - -``-c , --cooldown `` - An integer indicating the cooldown seconds once the - policy is effected. Default to cooldown of policy. - ``-e, --enabled`` Whether the policy should be enabled once attached. Default to enabled. @@ -633,52 +595,6 @@ Optional arguments ``-p , --policy `` ID or name of policy to be detached. -.. _senlin_cluster-policy-disable: - -senlin cluster-policy-disable -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: console - - usage: senlin cluster-policy-disable -p - -Disable a policy on a cluster. - -Positional arguments --------------------- - -```` - Name or ID of cluster to operate on. - -Optional arguments ------------------- - -``-p , --policy `` - ID or name of policy to be disabled. - -.. _senlin_cluster-policy-enable: - -senlin cluster-policy-enable -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: console - - usage: senlin cluster-policy-enable -p - -Enable a policy on a cluster. - -Positional arguments --------------------- - -```` - Name or ID of cluster to operate on. - -Optional arguments ------------------- - -``-p , --policy `` - ID or name of policy to be enabled. - .. _senlin_cluster-policy-list: senlin cluster-policy-list @@ -687,7 +603,7 @@ senlin cluster-policy-list .. code-block:: console usage: senlin cluster-policy-list [-f ] - [-k ] [-s ] [-F] + [-o ] [-F] List policies from cluster. @@ -706,12 +622,10 @@ Optional arguments can be specified multiple times, or once with parameters separated by a semicolon. -``-k , --sort-keys `` - Name of keys used for sorting the returned policies. - -``-s , --sort-dir `` - Direction for sorting, where DIR can be "asc" or - "desc". +``-o , --sort `` + Sorting option which is a string containing a list of + keys separated by commas. Each key can be optionally + appened by a sort direction (:asc or :desc) ``-F, --full-id`` Print full IDs in list. @@ -746,9 +660,7 @@ senlin cluster-policy-update .. code-block:: console - usage: senlin cluster-policy-update -p [-r ] [-l ] - [-c ] [-e ] - + usage: senlin cluster-policy-update -p [-e ] Update a policy's properties on a cluster. @@ -764,17 +676,6 @@ Optional arguments ``-p , --policy `` ID or name of policy to be updated. -``-r , --priority `` - An integer specifying the relative priority among all - policies attached to a cluster. The lower the value, - the higher the priority. Default is 50. - -``-l , --enforcement-level `` - New enforcement level. - -``-c , --cooldown `` - Cooldown interval in seconds. - ``-e , --enabled `` Whether the policy should be enabled. @@ -900,7 +801,7 @@ senlin cluster-update .. code-block:: console - usage: senlin cluster-update [-p ] [-t ] [-r ] + usage: senlin cluster-update [-p ] [-t ] [-M ] [-n ] @@ -921,9 +822,6 @@ Optional arguments ``-t , --timeout `` New timeout (in seconds) value for the cluster. -``-r , --parent `` - ID of parent cluster for the cluster. - ``-M , --metadata `` Metadata values to be attached to the cluster. This can be specified multiple times, or once with key- @@ -940,7 +838,7 @@ senlin event-list .. code-block:: console usage: senlin event-list [-f ] [-l ] - [-m ] [-k ] [-s ] [-g] [-F] + [-m ] [-o ] [-g] [-F] List events. @@ -959,12 +857,10 @@ Optional arguments Only return events that appear after the given event ID. -``-k , --sort-keys `` - Name of keys used for sorting the returned events. - -``-s , --sort-dir `` - Direction for sorting, where DIR can be "asc" or - "desc". +``-o , --sort `` + Sorting option which is a string containing a list of + keys separated by commas. Each key can be optionally + appened by a sort direction (:asc or :desc) ``-g, --global-project`` Whether events from all projects should be listed. @@ -1044,46 +940,6 @@ Positional arguments ```` Name or ID of node(s) to delete. -.. _senlin_node-join: - -senlin node-join -~~~~~~~~~~~~~~~~ - -.. code-block:: console - - usage: senlin node-join -c CLUSTER - -Make node join the specified cluster. - -Positional arguments --------------------- - -```` - Name or ID of node to operate on. - -Optional arguments ------------------- - -``-c CLUSTER, --cluster CLUSTER`` - ID or name of cluster for node to join. - -.. _senlin_node-leave: - -senlin node-leave -~~~~~~~~~~~~~~~~~ - -.. code-block:: console - - usage: senlin node-leave - -Make node leave its current cluster. - -Positional arguments --------------------- - -```` - Name or ID of node to operate on. - .. _senlin_node-list: senlin node-list @@ -1092,8 +948,7 @@ senlin node-list .. code-block:: console usage: senlin node-list [-c ] [-f ] - [-k ] [-s ] [-l ] [-m ] [-g] - [-F] + [-o ] [-l ] [-m ] [-g] [-F] Show list of nodes. @@ -1109,12 +964,10 @@ Optional arguments be specified multiple times, or once with parameters separated by a semicolon. -``-k , --sort-keys `` - Name of keys used for sorting the returned nodes. - -``-s , --sort-dir `` - Direction for sorting, where DIR can be "asc" or - "desc". +``-o , --sort `` + Sorting option which is a string containing a list of + keys separated by commas. Each key can be optionally + appened by a sort direction (:asc or :desc) ``-l , --limit `` Limit the number of nodes returned. @@ -1196,7 +1049,7 @@ senlin policy-create .. code-block:: console - usage: senlin policy-create -s [-c ] [-l ] + usage: senlin policy-create -s Create a policy. @@ -1212,14 +1065,6 @@ Optional arguments ``-s , --spec-file `` The spec file used to create the policy. -``-c , --cooldown `` - An integer indicating the cooldown seconds once the - policy is effected. Default to 0. - -``-l , --enforcement-level `` - An integer between 0 and 100 representing the - enforcement level. Default to 0. - .. _senlin_policy-delete: senlin policy-delete @@ -1244,19 +1089,35 @@ senlin policy-list .. code-block:: console - usage: senlin policy-list [-l ] [-m ] [-F] + usage: senlin policy-list [-f ] [-l ] + [-m ] [-o ] [-g] [-F] List policies that meet the criteria. Optional arguments ------------------ +``-f , --filters `` + Filter parameters to apply on returned policies. This + can be specified multiple times, or once with + parameters separated by a semicolon. + ``-l , --limit `` Limit the number of policies returned. ``-m , --marker `` Only return policies that appear after the given ID. +``-o , --sort `` + Sorting option which is a string containing a list of + keys separated by commas. Each key can be optionally + appened by a sort direction (:asc or :desc) + +``-g, --global-project`` + Indicate that the list should include policies from + all projects. This option is subject to access policy + checking. Default is False. + ``-F, --full-id`` Print full IDs in list. @@ -1318,7 +1179,7 @@ senlin policy-update .. code-block:: console - usage: senlin policy-update [-c ] [-l ] [-n ] + usage: senlin policy-update [-n ] Update a policy. @@ -1331,14 +1192,6 @@ Positional arguments Optional arguments ------------------ -``-c , --cooldown `` - An integer indicating the cooldown seconds once the - policy is effected. Default to 0. - -``-l , --enforcement-level `` - An integer between 0 and 100 representing the - enforcement level. Default to 0. - ``-n , --name `` New name of the policy to be updated. @@ -1349,8 +1202,7 @@ senlin profile-create .. code-block:: console - usage: senlin profile-create -s [-p ] - [-M ] + usage: senlin profile-create -s [-M ] Create a profile. @@ -1367,9 +1219,6 @@ Optional arguments ``-s , --spec-file `` The spec file used to create the profile. -``-p , --permission `` - A string format permission for this profile. - ``-M , --metadata `` Metadata values to be attached to the profile. This can be specified multiple times, or once with key- @@ -1399,19 +1248,35 @@ senlin profile-list .. code-block:: console - usage: senlin profile-list [-l ] [-m ] [-F] + usage: senlin profile-list [-f ] [-l ] + [-m ] [-o ] [-g] [-F] List profiles that meet the criteria. Optional arguments ------------------ +``-f , --filters `` + Filter parameters to apply on returned profiles. This + can be specified multiple times, or once with + parameters separated by a semicolon. + ``-l , --limit `` Limit the number of profiles returned. ``-m , --marker `` Only return profiles that appear after the given ID. +``-o , --sort `` + Sorting option which is a string containing a list of + keys separated by commas. Each key can be optionally + appened by a sort direction (:asc or :desc) + +``-g, --global-project`` + Indicate that the list should include profiles from + all projects. This option is subject to access policy + checking. Default is False. + ``-F, --full-id`` Print full IDs in list. @@ -1474,8 +1339,7 @@ senlin profile-update .. code-block:: console - usage: senlin profile-update [-n ] [-p ] - [-M ] + usage: senlin profile-update [-n ] [-M ] Update a profile. @@ -1492,9 +1356,6 @@ Optional arguments ``-n , --name `` The new name for the profile. -``-p , --permission `` - A string format permission for this profile. - ``-M , --metadata `` Metadata values to be attached to the profile. This can be specified multiple times, or once with key- @@ -1507,7 +1368,7 @@ senlin receiver-create .. code-block:: console - usage: senlin receiver-create [-t ] [-c ] -a + usage: senlin receiver-create [-t ] -c -a [-P ] @@ -1560,7 +1421,7 @@ senlin receiver-list .. code-block:: console usage: senlin receiver-list [-f ] [-l ] - [-m ] [-k ] [-s ] [-g] [-F] + [-m ] [-o ] [-g] [-F] List receivers that meet the criteria. @@ -1578,12 +1439,10 @@ Optional arguments ``-m , --marker `` Only return receivers that appear after the given ID. -``-k , --sort-keys `` - Name of keys used for sorting the returned receivers. - -``-s , --sort-dir `` - Direction for sorting, where DIR can be "asc" or - "desc". +``-o , --sort `` + Sorting option which is a string containing a list of + keys separated by commas. Each key can be optionally + appened by a sort direction (:asc or :desc) ``-g, --global-project`` Indicate that the list should include receivers from