Merge pull request #940 from Bischoff/support-dhcp

Add support for DHCP

Author: mfriesenegger

doc/source/parameters.yaml

@@ -166,16 +166,16 @@ guest_info:
   type: dict
 guest_os_info:
   description: |
-    OS info and kernel info of guest 
+    OS info and kernel info of guest.
   in: body
-  required: true 
+  required: true
   type: dict
 guest_online_cpu_num:
   description: |
-    Online cpu number of the guest 
+    Online CPU number of the guest.
   in: body
-  required: true 
-  type: int 
+  required: true
+  type: int
 guest_account:
   description: |
     Account of guest, useful for guest billing.
@@ -1085,6 +1085,8 @@ guest_networks_list:
     Network information list of guest. It has one dictionary that contain some of the below
     keys for each interface. All the keys are optional\:
 
+    - ``method``: interface initialization method. The valid values are ``static`` and
+      ``dhcp``.  Default is ``static``.
     - ``ip_addr``: the IP address of the interface, ``cidr`` is required if IP address
        is set
     - ``dns_addr``: DNS servers address list
@@ -1108,7 +1110,7 @@ guest_networks:
       is set
     - ``dns_addr``: DNS servers address list
     - ``gateway_addr``: gateway address
-    - ``cidr``: cidr format
+    - ``cidr``: CIDR format
     - ``nic_vdev``: NIC device number, 1 to 4 hexadecimal digits
     - ``mac_addr``: MAC address
     - ``nic_id``: NIC identifier

doc/source/restapi.rst

@@ -683,7 +683,7 @@ Get running information of guest.
    :language: javascript
 
 
-Get guest os info 
+Get guest OS info
 -----------------
 
 **GET /guests/{userid}/os_info**
@@ -716,8 +716,8 @@ Get operating system and kernel information of a virtual machine.
   :language: javascript
 
 
-Get guest online cpu num 
----------------------------
+Get guest online CPU num
+------------------------
 
 **GET /guests/{userid}/online_cpu_num**
 
@@ -815,7 +815,9 @@ Create guest NIC
 
 **POST /guests/{userid}/nic**
 
-Create a virtual NIC on giving guest.
+Create a virtual NIC on given guest.
+The NIC is created in the z/VM system directory, but it is not configured
+at the guest OS level.
 
 * Request:
 
@@ -844,7 +846,9 @@ Create network interface
 
 **POST /guests/{userid}/interface**
 
-Create one or more network interfaces on giving guest.
+Create one or more network interfaces on given guest.
+The interfaces are created in the z/VM system directory, and configured after
+the guest is started.
 
 * Request: