The meta-data commands allow you to add meta-data to the InfiniBox entities and view meta-data that arrives from entities that were created by the hosts. See examples along the commands documentation.
NOTE: By default, objects do not have associated metadata. The metadata must be set first.
metadata.clear
ROLE: Admin, Pool Admin
| Description | Clear all metadata keys from object. | |
| Syntax | metadata.clear objtype=OBJTYPE [object=NAME] | |
| Arguments | object | A maximum of 65 Latin characters, numbers, spaces, and the following symbols: "^&'@()[]$=!-#{}%.+~_" (excluding quotation marks). Leading and trailing whitespace characters are stripped. |
objtype | vol, vol-snap, fs, fs-snap, pool, host, cluster or system | |
| Example | metadata.clear | |
All meta-data cleared | ||
metadata.get
ROLE: Admin, Pool Admin
| Description | Get metadata from object. The object type is taken from a predefined list that can be obtained as you type. The object can be obtained from running a query for the specific object type. For example, if you are looking for the metadata of a specific host, query for a host first, and then use host as the object type, and the name of the desired host as an object. | |
| Syntax | metadata.get objtype=OBJTYPE [object=NAME] [key=STR] | |
| Arguments | key | Any sequence of characters |
object | A maximum of 65 Latin characters, numbers, spaces, and the following symbols: "^&'@()[]$=!-#{}%.+~_" (excluding quotation marks). Leading and trailing whitespace characters are stripped. | |
objtype | vol, vol-snap, fs, fs-snap, pool, host, cluster or system | |
| Example | metadata.get objtype=host object=io004 | |
| ||
metadata.remove
ROLE: Admin, Pool Admin
| Description | Remove a single metadata key from object. See the documentation of metadata.get above. | |
| Syntax | metadata.remove objtype=OBJTYPE key=NAME [object=STR] | |
| Arguments | object | Any sequence of characters |
key | A maximum of 65 Latin characters, numbers, spaces, and the following symbols: "^&'@()[]$=!-#{}%.+~_" (excluding quotation marks). Leading and trailing whitespace characters are stripped. | |
objtype | vol, vol-snap, fs, fs-snap, pool, host, cluster or system | |
| Example | metadata.remove objtype=host object=io004 key=platform | |
| ||
metadata.set
ROLE: Admin, Pool Admin
| Description | Set metadata on object. You can set one key at a time. setting a value to an already existing key overrides the previous string. | |
| Syntax | metadata.set objtype=OBJTYPE key=STR value=STR [object=NAME] | |
| Arguments | objtype | vol, vol-snap, fs, fs-snap, pool, host, cluster or system |
object | A maximum of 65 Latin characters, numbers, spaces, and the following symbols: "^&'@()[]$=!-#{}%.+~_" (excluding quotation marks). Leading and trailing whitespace characters are stripped. | |
value | Any sequence of characters | |
key | Any sequence of characters | |
| Example | metadata.set objtype=host object=io004 key=platform value=Linux-3.10.0-123.20.1.el7.x86_64-x86_64-with-centos-7.0.1406-Core | |
Meta-data set | ||
Last edited: 2022-08-06 08:32:51 UTC
Comments