New manpages 10/07/2013

docs/en/man/man1/xe-bond-param-get.ad

@@ -0,0 +1,61 @@
+XE(1)
+=======
+:doctype: manpage
+:man source:   xe bond-param-get
+:man version:  {1}
+:man manual:   xe bond-param-get manual
+
+NAME
+----
+xe-bond-param-get - Returns a parameter for a bond
+
+SYNOPSIS
+--------
+*xe bond-param-get* uuid=<BOND UUID> param-name=<PARAMETER> [ param-key=<PARAMETER KEY> ]
+
+DESCRIPTION
+-----------
+*xe bond-param-get* returns a parameter or a key value from a specific bond.
+
+REQUIRED PARAMETERS
+-------------------
+*uuid*::
+	UUID of bond - Use *xe bond-list* to obtain a list of bonds
+
+*param-name*::
+	The bond parameter to return - Use *xe bond-param-list* to obtain a list of bond parameters 
+
+OPTIONAL PARAMETERS
+-------------------
+*param-key*::
+	The bond key to return
+
+EXAMPLES
+--------
+To return the mode parameter value from a specific bond:
+
+- *xe bond-param-get* uuid=<BOND UUID> param-name="mode"
+
+To return the value from a key found in the properties parameter:
+
+- *xe bond-param-get* uuid=<BOND UUID> param-name="properties" param-key=<PARAMETER KEY>
+
+SEE ALSO
+--------
+*xe help bond-param-get*, *xe-bond-create*(1), *xe-bond-destroy*(1), *xe-bond-set-mode*(1), *xe-bond-param-list*(1) *xe-bond-param-get*(1), *xe-bond-param-set*(1), *xe-pif-list*(1)
+
+AUTHORS
+-------
+Manpage Author(s):
+
+- Matthew Spah <spahmatthew@xenapiadmin.com>
+
+BUGS
+----
+For guidelines on submitting bug reports see http://wiki.xen.org/wiki/Reporting_Bugs_against_XCP. Submit bugs and general questions to xen-api@lists.xen.org.
+
+COPYRIGHT
+---------
+Copyright \(C)  2012 - Matthew Spah
+Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License."
+

docs/en/man/man1/xe-bond-param-list.ad

@@ -0,0 +1,49 @@
+XE(1)
+=======
+:doctype: manpage
+:man source:   xe bond-param-list
+:man version:  {1}
+:man manual:   xe bond-param-list manual
+
+NAME
+----
+xe-bond-param-list -  Displays all parameters for a bond
+
+SYNOPSIS
+--------
+*xe bond-param-list* uuid=<BOND UUID>
+
+DESCRIPTION
+-----------
+*xe bond-param-list* displays all parameters for a specific bond.
+
+REQUIRED PARAMETERS
+-------------------
+*uuid*::
+	Bond UUID - Use *xe bond-list* to obtain a list of bonds.
+
+EXAMPLES
+--------
+To display parameters for a bond:
+
+- *xe bond-param-list* uuid=<BOND UUID>
+
+SEE ALSO
+--------
+*xe help bond-param-list*, *xe-bond-create*(1), *xe-bond-destroy*(1), *xe-bond-set-mode*(1), *xe-bond-param-get*(1), *xe-bond-param-set*(1), *xe-pif-list*(1)
+
+AUTHORS
+-------
+Manpage Author(s):
+
+- Matthew Spah <spahmatthew@xenapiadmin.com>
+
+BUGS
+----
+For guidelines on submitting bug reports see http://wiki.xen.org/wiki/Reporting_Bugs_against_XCP. Submit bugs and general questions to xen-api@lists.xen.org.
+
+COPYRIGHT
+---------
+Copyright \(C)  2012 - Matthew Spah
+Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License"
+

docs/en/man/man1/xe-host-param-get.ad

@@ -0,0 +1,57 @@
+XE(1)
+=======
+:doctype: manpage
+:man source:   xe host-param-get
+:man version:  {1}
+:man manual:   xe host-param-get manual
+
+NAME
+-----
+xe-host-param-get - Return a parameter for a host
+
+SYNOPSIS
+--------
+*xe host-param-get*  uuid=<HOST UUID> param-name=<PARAMETER> [ param-key=<PARAMETER KEY> ]
+
+DESCRIPTION
+-----------
+*xe host-param-get* returns the value(s) of a parameter or a map parameter key value for a specified host.
+
+REQUIRED PARAMETERS
+-------------------
+*uuid*:: 
+	Host UUID - Use *xe host-list* to obtain a list of host UUIDs.
+
+*param-name*:: 
+	The host parameter value to return - Use *xe host-param-list* to obtain a list of host parameters
+
+OPTIONAL PARAMETERS
+-------------------
+*param-key*:: 
+	The host key value to return
+
+EXAMPLES
+--------
+To return the UUID of the Suspend Image Storage Repository: 
+
+- *xe host-param-get* uuid=<HOST UUID> param-name="suspend-image-sr-uuid"
+
+
+SEE ALSO
+--------
+*xe help host-param-get*, *xe host-list*(1), *xe host-param-set*(1), *xe host-param-remove*(1). *xe host-param-clear*(1), *xe host-param-add*(1)
+
+AUTHORS
+-------
+Manpage Author(s):
+
+- Matthew Spah <spahmatthew@xenapiadmin.com>
+
+BUGS
+----
+For guidelines on submitting bug reports see http://wiki.xen.org/wiki/Reporting_Bugs_against_XCP. Submit bugs and general questions to xen-api@lists.xen.org.
+
+COPYRIGHT
+---------
+Copyright \(C)  2013 - Matthew Spah
+Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".

docs/en/man/man1/xe-host-param-list.ad

@@ -0,0 +1,48 @@
+XE(1)
+=======
+:doctype: manpage
+:man source:   xe host-param-list
+:man version:  {1}
+:man manual:   xe host-param-list manual
+
+NAME
+----
+xe-host-param-list - Displays all parameters for a host 
+
+SYNOPSIS
+--------
+*xe host-param-list* uuid=<HOST UUID>
+
+DESCRIPTION
+-----------
+*xe host-param-list* displays all parameters for a specific host. 
+
+REQUIRED PARAMETERS
+-------------------
+*uuid*::
+	Host UUID - Use *xe host-list* to obtain a list of Host UUIDs.
+
+EXAMPLES
+--------
+To display all parameters for a specific host:
+
+- *xe host-param-list* uuid=<HOST UUID>
+
+SEE ALSO
+--------
+*xe help host-param-list*, *xe-host-enable*(1), *xe-host-list*(1), *xe-host-param-get*(1), *xe-host-disable*(1), *xe-host-forget*(1), *xe-host-power-on*(1)
+
+AUTHORS
+-------
+Manpage Author(s):
+
+- Matthew Spah <spahmatthew@xenapiadmin.com>
+
+BUGS
+----
+For guidelines on submitting bug reports see http://wiki.xen.org/wiki/Reporting_Bugs_against_XCP. Submit bugs and general questions to xen-api@lists.xen.org.
+
+COPYRIGHT
+---------
+Copyright \(C) 2013 - Matthew Spah
+Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".

docs/en/man/man1/xe-host-shutdown.ad

@@ -0,0 +1,60 @@
+XE(1)
+=======
+:doctype: manpage
+:man source:   	xe-host-shutdown 
+:man version:  	{1}
+:man manual:   	xe host-shutdown Manual
+
+
+NAME
+----
+xe-host-shutdown - Attempts to shut down the specified XenServer/XCP host(s).
+
+SYNOPSIS
+--------
+*xe host-shutdown* [ host-selectors ] [--multiple]
+
+DESCRIPTION
+-----------
+*xe host-shutdown* attempts to shut down XCP/XenServer host(s) using the standard host selection mechanism. The hosts must have been previously disabled using the *xe host-disable* command. If the hosts have not been previously disabled, *xe host-shutdown* will return a HOST_IN_USE error message. Successful shut down operations will not output any information to the terminal.
+
+The --multiple flag is required to shut down multiple hosts.
+
+A special procedure is required to shut down hosts with HA enabled. After disabling the host with *xe host-disable*, the virtual machines can be live migrated to other hosts using *xe host-evacuate*. The *xe host-shutdown* command can be issued after the migration is complete.
+
+OPTIONAL PARAMETERS
+-------------------
+<host-selectors>::
+	Parameters to select host(s) - Use *xe host-list params=all* to get a list of host parameters to filter on.
+
+EXAMPLES
+--------
+To shut down a host specified by its name-label:
+
+- *xe host-shutdown* host=<NAME-LABEL>
+
+To shut down all disabled hosts:
+
+- *xe host-shutdown* enabled=false --multiple
+
+SEE ALSO
+--------
+*xe help host-shutdown*, *xe host-list*(1), *xe-host-disable*(1), *xe-host-evacuate*(1)
+
+AUTHORS
+-------
+Manpage Author(s):
+
+- Jeff Loughridge <jeffl@alumni.duke.edu>
+
+BUGS
+----
+See http://wiki.xen.org/wiki/Reporting_Bugs_against_XCP on how to send bug reports, send bugs and general questions to xen-api@lists.xen.org.
+
+COPYRIGHT
+---------
+
+Copyright \(C) 2013 - Jeff Loughridge
+
+Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License"
+

docs/en/man/man1/xe-network-create.ad

@@ -25,7 +25,8 @@ REQUIRED PARAMETERS
 OPTIONAL PARAMETER
 -------------------
 *MTU*::
-	MTU for the network. The MTU default is 1500.	
+	MTU for the network. The MTU default is 1500.
+
 *name-description*::
 	Description of the network
 
@@ -35,7 +36,7 @@ To create a network with a *name-description*
 
 - *xe network-create* name-label="Example Network" name-description="This is an Example Network"
 
-To create a network with a custom *MTU*: ::
+To create a network with a custom *MTU*:
 
 - *xe network-create* name-label="MTU Example Network" MTU="9000"
 

docs/en/man/man1/xe-network-param-get.ad

@@ -20,15 +20,15 @@ DESCRIPTION
 REQUIRED PARAMETERS
 -------------------
 *uuid*::
-	Network UUID - Use *xe network-list* to obtain a list of network UUIDs.
+	Network UUID - Use *xe network-list* to obtain a list of network UUIDs
 
 *param-name*::
-	The network parameter value to return.
+	The network parameter value to return - Use *xe network-param-list* to obtain a list of network parameters
 
 OPTIONAL PARAMETERS
 -------------------
 *param-key*::
-	The network key value to return.  
+	The network key value to return
 
 EXAMPLES
 --------

docs/en/man/man1/xe-pif-param-add.ad

@@ -7,7 +7,7 @@ XE(1)
 
 NAME
 ----
-xe-pif-param-add - Add a key/value to a parameter for a PIF 
+xe-pif-param-add - Add a key/value to a parameter for a physical interface (PIF)
 
 SYNOPSIS
 --------

docs/en/man/man1/xe-pif-param-clear.ad

@@ -7,7 +7,7 @@ XE(1)
 
 NAME
 ----
-xe-pif-param-clear - Clears a specific writable parameter for a PIF
+xe-pif-param-clear - Clears a specific writable parameter for a physical interface (PIF)
 
 SYNOPSIS
 --------

docs/en/man/man1/xe-pif-param-get.ad

@@ -7,7 +7,7 @@ XE(1)
 
 NAME
 ----
-xe-pif-param-get - Returns a parameter for a PIF
+xe-pif-param-get - Returns a parameter for a physical interface (PIF)
 
 SYNOPSIS
 --------
@@ -21,13 +21,14 @@ REQUIRED PARAMETERS
 -------------------
 *uuid*::
 	PIF UUID - Use *xe pif-list* to obtain PIF UUIDs.
+
 *param-name*::
-	The PIF parameter value to return	
+	The PIF parameter value to return - Use *xe pif-param-list* to obtain a list of a PIF parameters 
 
 OPTIONAL PARAMETERS
 -------------------
 *param-key*::
-	The PIF map parameter key value to return
+	The PIF key value to return
 
 EXAMPLES
 --------

docs/en/man/man1/xe-pif-param-list.ad

@@ -7,7 +7,7 @@ XE(1)
 
 NAME
 ----
-xe-pif-param-list - Displays all parameters for a PIF.
+xe-pif-param-list - Displays all parameters for a physical interface (PIF)
 
 SYNOPSIS
 --------

docs/en/man/man1/xe-pif-param-remove.ad

@@ -7,7 +7,7 @@ XE(1)
 
 NAME
 ----
-xe-pif-param-remove - Removes a key or key/value pair from a physical interface
+xe-pif-param-remove - Removes a key or key/value pair from a physical interface (PIF)
 
 SYNOPSIS
 --------

docs/en/man/man1/xe-pif-param-set.ad

@@ -7,7 +7,7 @@ XE(1)
 
 NAME
 ----
-xe-pif-param-set - Set parameters for a physical interface
+xe-pif-param-set - Set parameters for a physical interface (PIF)
 
 SYNOPSIS
 --------