openstack-manuals/doc/common/section_cli_nova_metadata.xml
Christian Berendt 6feaaf116f Standardize usage of client arguments (common)
Like documented at https://wiki.openstack.org/wiki/Documentation/Conventions#Client_arguments:_.22--option_ARGUMENT.22
we prefer to use '--option ARGUMENT'.

Change-Id: I4ea2c16a384726429d583d5eb6f03aeec3ca514c
2014-09-09 15:43:44 +02:00

48 lines
3.4 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!-- moved this information to "launch a server" section -->
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="inserting_metadata">
<title>Insert metadata during launch</title>
<para>When booting a server, you can also add metadata, so that you
can more easily identify it amongst your ever-growing elastic
cloud. Use the <literal>--meta</literal> option with a key=value
pair, where you can make up the string for both the key and the
value. For example, you could add a description and also the creator
of the server.
<screen><prompt>$</prompt> <userinput>nova boot --image natty-image --flavor 2 smallimage2 --meta description 'Small test image' --meta creator=joecool</userinput></screen>
</para>
<para>When viewing the server information, you can see the metadata
included on the <literal>metadata</literal> line:
<screen><prompt>$</prompt> <userinput>nova show smallimage2</userinput>
<computeroutput>+------------------------+---------------------------------------------------------------+
| Property | Value |
+------------------------+---------------------------------------------------------------+
| OS-DCF:diskConfig | MANUAL |
| OS-EXT-STS:power_state | 1 |
| OS-EXT-STS:task_state | None |
| OS-EXT-STS:vm_state | active |
| accessIPv4 | |
| accessIPv6 | |
| config_drive | |
| created | 2012-05-16T20:48:23Z |
| flavor | m1.small |
| hostId | de0c201e62be88c61aeb52f51d91e147acf6cf2012bb57892e528487 |
| id | 8ec95524-7f43-4cce-a754-d3e5075bf915 |
| image | natty-image |
| key_name | |
| metadata | {u'description': u'Small test image', u'creator': u'joecool'} |
| name | smallimage2 |
| private network | 172.16.101.11 |
| progress | 0 |
| public network | 10.4.113.11 |
| status | ACTIVE |
| tenant_id | e830c2fbb7aa4586adf16d61c9b7e482 |
| updated | 2012-05-16T20:48:35Z |
| user_id | de3f4e99637743c7b6d27faca4b800a9 |
+------------------------+---------------------------------------------------------------+</computeroutput></screen>
</para>
</section>