From mboxrd@z Thu Jan 1 00:00:00 1970 From: Paul Durrant Subject: [PATCH 4/4] docs: Document xenstore paths for domain network address information Date: Fri, 6 Nov 2015 17:21:47 +0000 Message-ID: <1446830507-4233-6-git-send-email-paul.durrant@citrix.com> References: <1446830507-4233-1-git-send-email-paul.durrant@citrix.com> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Return-path: Received: from mail6.bemta5.messagelabs.com ([195.245.231.135]) by lists.xen.org with esmtp (Exim 4.72) (envelope-from ) id 1Zukjg-0000Wx-5O for xen-devel@lists.xenproject.org; Fri, 06 Nov 2015 17:23:36 +0000 In-Reply-To: <1446830507-4233-1-git-send-email-paul.durrant@citrix.com> List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Sender: xen-devel-bounces@lists.xen.org Errors-To: xen-devel-bounces@lists.xen.org To: xen-devel@lists.xenproject.org Cc: Keir Fraser , Ian Campbell , Tim Deegan , Ian Jackson , Paul Durrant , Jan Beulich List-Id: xen-devel@lists.xenproject.org It is useful to be able to see the network addresses in use by a domain for a particular vif in xenstore, for example so that ssh can be invoked by a toolstack to log into the guest domain. This patch documents paths to allow a domain to advertise MAC (unicast and multicast) and IP (versions 4 and 6) address information. Signed-off-by: Paul Durrant Cc: Ian Campbell Cc: Ian Jackson Cc: Jan Beulich Cc: Keir Fraser Cc: Tim Deegan --- docs/misc/xenstore-paths.markdown | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/docs/misc/xenstore-paths.markdown b/docs/misc/xenstore-paths.markdown index 9e98d6f..68d3dbf 100644 --- a/docs/misc/xenstore-paths.markdown +++ b/docs/misc/xenstore-paths.markdown @@ -39,6 +39,8 @@ before regexp expansion: * $UUID -- a UUID in the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx * $NAME -- a string identifying an object within a domain. Typically comprising only alphanumeric characters. +* $INDEX -- an integer used as part of a path when listing a set of + values. Typically these integers are contiguous. VALUES are strings and can take the following forms: @@ -56,6 +58,13 @@ VALUES are strings and can take the following forms: * VERSION -- 2 or 3 integers, in decimal form separated by ".", specifying major version, minor version, and then (optionally) micro version. +* MAC_ADDRESS -- 6 integers, in hexadecimal form, separated by ':', + specifying an ethernet MAC address. +* IPV4_ADDRESS -- 4 integers, in decimal form, separated by '.', + specifying an IP version 4 address. +* IPV6_ADDRESS -- 8 integers, in hexadecimal form, separated by ':', + specifying an IP version 6 address. (There should + be strictly 8 integers i.e. '::' compression). Additional TAGS may follow as a comma separated set of the following tags enclosed in square brackets. @@ -399,6 +408,26 @@ An HVM domain can indicate to a toolstack that it is capable of responding to instantiation of a new vbd by bringing online a new PV block device without the need for a reboot. +#### ~/attr/vif/$DEVID/name = STRING [w] + +A domain may write its internal 'friendly' name for a network device +using this path. + +#### ~/attr/vif/$DEVID/mac/$INDEX = MAC_ADDRESS [w] + +A domain may write the set of MAC addresses (unicast and multicast) +in use by the network frontend using paths of this form. + +#### ~/attr/vif/$DEVID/ipv4/$INDEX = IPV4_ADDRESS [w] + +A domain may write the set of IP version 4 addresses in use by the +stack bound to the network frontend using paths of this form. + +#### ~/attr/vif/$DEVID/ipv6/$INDEX = IPV6_ADDRESS [w] + +A domain may write the set of IP version 6 addresses in use by the +stack bound to the network frontend using paths of this form. + ### Paths private to the toolstack #### ~/device-model/$DOMID/state [w] -- 2.1.4