vm_role
^^^^^^^^^
-The ``OS::Nova::Server`` Resource ``metadata`` map value parameter ``vm-role``
+The ``OS::Nova::Server`` Resource ``metadata`` map value parameter ``vm_role``
is a ``metadata`` tag that describes the role of the Virtual Machine.
-The ``vm_role`` is stored in ONAP’s A&AI module and is
-available for use by other ONAP components and/or north bound systems.
.. req::
:id: R-85328
.. req::
:id: R-95430
:target: VNF
- :keyword: MUST
- :validation_mode: static
- :updated: casablanca
+ :keyword: MAY
+ :validation_mode: none
+ :updated: dublin
If a VNF's Heat Orchestration Template's ``OS::Nova::Server``
resource property
``metadata`` key/value pair ``vm_role`` value is obtained via
- ``get_param``, the parameter **MUST** be declared as ``vm_role``
- and the parameter **MUST** be defined as type: ``string``.
+ ``get_param``, the parameter **MAY** be declared as
+
+ * ``vm_role`` and the parameter defined as ``type: string``.
+ * ``vm_roles`` and the parameter defined as ``type: comma_delimited_list``.
+ * ``{vm-type}_vm_role`` and the parameter defined as ``type: string``.
.. req::
:id: R-67597
type: string
description: Unique role for this VM
-*Example: 'vm-role' Definition: Hard Coded in
+*Example: 'vm_role' Definition: Hard Coded in
OS::Nova::Resource metadata property*
.. code-block:: yaml
metadata:
vm_role: dns
-*Example 'vm-role' Definition: Defined in Environment file
+*Example 'vm_role' Definition: Defined in Environment file
and retrieved via 'get_param'*
.. code-block:: yaml
:id: R-82481
:target: VNF
:keyword: MUST
- :validation_mode: static
- :updated: casablanca
+ :validation_mode: none
+ :updated: dublin
A VNF's Heat Orchestration Template's Resource property parameter that is
associated with a unique Virtual Machine type **MUST** include
1.) The Resource ``OS::Nova::Server`` property ``availability_zone``
parameter **MUST NOT** be prefixed with a common ``{vm-type}`` identifier,
- 2.) The Resource ``OS::Nova::Server`` eight mandatory and optional
- ``metadata``
- parameters (i.e., ``vnf_name``, ``vnf_id``, ``vf_module_id``,
- ``vf_module_name``, ``vm_role``,
- ``vf_module_index``, ``environment_context``, ``workload_context``)
+ 2.) The Resource ``OS::Nova::Server`` mandatory and optional
+ ``metadata`` parameters
+
+ * ``vnf_name``
+ * ``vnf_id``
+ * ``vf_module_id``
+ * ``vf_module_name``
+ * ``vf_module_index``
+ * ``environment_context``
+ * ``workload_context``
+
**MUST NOT** be prefixed with a common ``{vm-type}`` identifier.
.. req::