summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/limit.rst
blob: 46da6c1b705d893353c495b6d1e707cbe836d965 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
=====
limit
=====

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)