summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/registered-limit.rst
blob: 586fd1ffcc904d095a0416abdadd18c0ac406139 (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
134
135
136
137
138
139
140
================
registered limit
================

Identity v3

Registered limits are used to define default limits for resources within a
deployment.

registered limit create
-----------------------

Create a new registered limit

.. program:: registered limit create
.. code:: bash

    openstack registered limit create
        [--description <description>]
        [--region <region>]
        --service <service>
        --default-limit <default-limit>
        <resource-name>

.. option:: --description <description>

   Useful description of the registered limit or its purpose

.. option:: --region <region>

   Region that the limit should be applied to

.. describe:: --service  <service>

   The service that is responsible for the resource being limited (required)

.. describe:: --default-limit <default-limit>

   The default limit for projects to assume unless explicitly overridden
   (required)

.. describe:: <resource-name>

   The name of the resource to limit (e.g. cores or volumes)

registered limit delete
-----------------------

Delete registered limit(s)

.. program:: registered limit delete
.. code:: bash

    openstack registered limit delete
        <registered-limit-id> [<registered-limit-id> ...]


.. describe:: <registered-limit-id>

    Registered limit(s) to delete (ID)

registered limit list
---------------------

List registered limits

.. program:: registered limit list
.. code:: bash

    openstack registered limit list
        [--service <service>]
        [--resource-name <resource-name>]
        [--region <region>]

.. 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

registered limit show
---------------------

Display details about a registered limit

.. program:: registered limit show
.. code:: bash

    openstack registered limit show
        <registered-limit-id>

.. describe:: <registered-limit-id>

    Registered limit to display (ID)

registered limit set
--------------------

Update a registered limit

.. program:: registered limit set
.. code:: bash

    openstack registered limit set
        [--service <service>]
        [--resource-name <resource-name>]
        [--default-limit <default-limit>]
        [--description <description>]
        [--region <region>]
        <registered-limit-id>

.. option:: --service <service>

    The service of the registered limit to update (ID or name)

.. option:: --resource-name <resource-name>

    The name of the resource for the limit

.. option:: --default-limit <default-limit>

    The default limit for projects to assume for a given resource

.. option:: --description <description>

    A useful description of the limit or its purpose

.. option:: --region <region>

    The region the limit should apply to

.. describe:: <registered-limit-id>

    Registered limit to display (ID)