diff options
| author | Zuul <zuul@review.opendev.org> | 2020-06-09 02:10:29 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2020-06-09 02:10:29 +0000 |
| commit | 09970d48e0af8da2faa01fd94c1e312384d683b4 (patch) | |
| tree | 8c97ff404033d23ce89a10440d9f5898379589db /doc/source/cli/command-objects/limit.rst | |
| parent | f6810edf41f7d457d490b360bf2918f4e8b1e6bd (diff) | |
| parent | 26878e7d53a531adb67c9ddde8fd6d3c3092ce34 (diff) | |
| download | python-openstackclient-09970d48e0af8da2faa01fd94c1e312384d683b4.tar.gz | |
Merge "identity: autogenerate docs"
Diffstat (limited to 'doc/source/cli/command-objects/limit.rst')
| -rw-r--r-- | doc/source/cli/command-objects/limit.rst | 127 |
1 files changed, 2 insertions, 125 deletions
diff --git a/doc/source/cli/command-objects/limit.rst b/doc/source/cli/command-objects/limit.rst index 46da6c1b..784d0cb4 100644 --- a/doc/source/cli/command-objects/limit.rst +++ b/doc/source/cli/command-objects/limit.rst @@ -6,128 +6,5 @@ Identity v3 Limits are used to specify project-specific limits thresholds of resources. -limit create ------------- - -Create a new limit - -.. program:: limit create -.. code:: bash - - openstack limit create - [--description <description>] - [--region <region>] - --project <project> - --service <service> - --resource-limit <resource-limit> - <resource-name> - -.. option:: --description <description> - - Useful description of the limit or its purpose - -.. option:: --region <region> - - Region that the limit should be applied to - -.. describe:: --project <project> - - The project that the limit applies to (required) - -.. describe:: --service <service> - - The service that is responsible for the resource being limited (required) - -.. describe:: --resource-limit <resource-limit> - - The limit to apply to the project (required) - -.. describe:: <resource-name> - - The name of the resource to limit (e.g. cores or volumes) - -limit delete ------------- - -Delete project-specific limit(s) - -.. program:: limit delete -.. code:: bash - - openstack limit delete - <limit-id> [<limit-id> ...] - -.. describe:: <limit-id> - - Limit(s) to delete (ID) - -limit list ----------- - -List project-specific limits - -.. program:: limit list -.. code:: bash - - openstack limit list - [--service <service>] - [--resource-name <resource-name>] - [--region <region>] - [--project <project>] - -.. option:: --service <service> - - The service to filter the response by (name or ID) - -.. option:: --resource-name <resource-name> - - The name of the resource to filter the response by - -.. option:: --region <region> - - The region name to filter the response by - -.. option:: --project <project> - - List resource limits associated with project - -limit show ----------- - -Display details about a limit - -.. program:: limit show -.. code:: bash - - openstack limit show - <limit-id> - -.. describe:: <limit-id> - - Limit to display (ID) - -limit set ---------- - -Update a limit - -.. program:: limit show -.. code:: bash - - openstack limit set - [--description <description>] - [--resource-limit <resource-limit>] - <limit-id> - - -.. option:: --description <description> - - Useful description of the limit or its purpose - -.. option:: --resource-limit <resource-limit> - - The limit to apply to the project - -.. describe:: <limit-id> - - Limit to update (ID) +.. autoprogram-cliff:: openstack.identity.v3 + :command: limit * |