|
| 1 | +================ |
| 2 | +registered limit |
| 3 | +================ |
| 4 | + |
| 5 | +Identity v3 |
| 6 | + |
| 7 | +Registered limits are used to define default limits for resources within a |
| 8 | +deployment. |
| 9 | + |
| 10 | +registered limit create |
| 11 | +----------------------- |
| 12 | + |
| 13 | +Create a new registered limit |
| 14 | + |
| 15 | +.. program:: registered limit create |
| 16 | +.. code:: bash |
| 17 | +
|
| 18 | + openstack registered limit create |
| 19 | + [--description <description>] |
| 20 | + [--region <region>] |
| 21 | + --service <service> |
| 22 | + --default-limit <default-limit> |
| 23 | + <resource-name> |
| 24 | +
|
| 25 | +.. option:: --description <description> |
| 26 | + |
| 27 | + Useful description of the registered limit or its purpose |
| 28 | + |
| 29 | +.. option:: --region <region> |
| 30 | + |
| 31 | + Region that the limit should be applied to |
| 32 | + |
| 33 | +.. describe:: --service <service> |
| 34 | + |
| 35 | + The service that is responsible for the resource being limited (required) |
| 36 | + |
| 37 | +.. describe:: --default-limit <default-limit> |
| 38 | + |
| 39 | + The default limit for projects to assume unless explicitly overridden |
| 40 | + (required) |
| 41 | + |
| 42 | +.. describe:: <resource-name> |
| 43 | + |
| 44 | + The name of the resource to limit (e.g. cores or volumes) |
| 45 | + |
| 46 | +registered limit delete |
| 47 | +----------------------- |
| 48 | + |
| 49 | +Delete registered limit(s) |
| 50 | + |
| 51 | +.. program:: registered limit delete |
| 52 | +.. code:: bash |
| 53 | +
|
| 54 | + openstack registered limit delete |
| 55 | + <registered-limit-id> [<registered-limit-id> ...] |
| 56 | +
|
| 57 | +
|
| 58 | +.. describe:: <registered-limit-id> |
| 59 | + |
| 60 | + Registered limit(s) to delete (ID) |
| 61 | + |
| 62 | +registered limit list |
| 63 | +--------------------- |
| 64 | + |
| 65 | +List registered limits |
| 66 | + |
| 67 | +.. program:: registered limit list |
| 68 | +.. code:: bash |
| 69 | +
|
| 70 | + openstack registered limit list |
| 71 | + [--service <service>] |
| 72 | + [--resource-name <resource-name>] |
| 73 | + [--region <region>] |
| 74 | +
|
| 75 | +.. option:: --service <service> |
| 76 | + |
| 77 | + The service to filter the response by (name or ID) |
| 78 | + |
| 79 | +.. option:: --resource-name <resource-name> |
| 80 | + |
| 81 | + The name of the resource to filter the response by |
| 82 | + |
| 83 | +.. option:: --region <region> |
| 84 | + |
| 85 | + The region name to filter the response by |
| 86 | + |
| 87 | +registered limit show |
| 88 | +--------------------- |
| 89 | + |
| 90 | +Display details about a registered limit |
| 91 | + |
| 92 | +.. program:: registered limit show |
| 93 | +.. code:: bash |
| 94 | +
|
| 95 | + openstack registered limit show |
| 96 | + <registered-limit-id> |
| 97 | +
|
| 98 | +.. describe:: <registered-limit-id> |
| 99 | + |
| 100 | + Registered limit to display (ID) |
| 101 | + |
| 102 | +registered limit set |
| 103 | +-------------------- |
| 104 | + |
| 105 | +Update a registered limit |
| 106 | + |
| 107 | +.. program:: registered limit set |
| 108 | +.. code:: bash |
| 109 | +
|
| 110 | + openstack registered limit set |
| 111 | + [--service <service>] |
| 112 | + [--resource-name <resource-name>] |
| 113 | + [--default-limit <default-limit>] |
| 114 | + [--description <description>] |
| 115 | + [--region <region>] |
| 116 | + <registered-limit-id> |
| 117 | +
|
| 118 | +.. option:: --service <service> |
| 119 | + |
| 120 | + The service of the registered limit to update (ID or name) |
| 121 | + |
| 122 | +.. option:: --resource-name <resource-name> |
| 123 | + |
| 124 | + The name of the resource for the limit |
| 125 | + |
| 126 | +.. option:: --default-limit <default-limit> |
| 127 | + |
| 128 | + The default limit for projects to assume for a given resource |
| 129 | + |
| 130 | +.. option:: --description <description> |
| 131 | + |
| 132 | + A useful description of the limit or its purpose |
| 133 | + |
| 134 | +.. option:: --region <region> |
| 135 | + |
| 136 | + The region the limit should apply to |
| 137 | + |
| 138 | +.. describe:: <registered-limit-id> |
| 139 | + |
| 140 | + Registered limit to display (ID) |
0 commit comments