Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Made changes requested by XenAPI admins and also added xe-network-cre…

…ate.ad
  • Loading branch information...
commit d2a64e9ad5eb6b79c857362071682553023731ae 1 parent 07ab18d
@Mattsface Mattsface authored
View
83 docs/en/man/man1/xe-network-create.ad
@@ -0,0 +1,83 @@
+XE(1)
+=======
+:doctype: manpage
+:man source: xe network-create
+:man version: {1}
+:man manual: xe network-create manual
+
+NAME
+----
+xe-network-create - Create a network
+
+SYNOPSIS
+--------
+
+*xe network-create* name-label=<network name> [ MTU=<MTU Size> ] [ name-description=<description> ]
+
+
+DESCRIPTION
+-----------
+
+*xe network-create* will create an internal network. Name-labels and name-descriptions containing spaces need to be enclosed in quotes. The resulting network UUID is returned.
+
+REQUIRED PARAMETERS
+-------------------
+
+*name-label*::
+ Name of the network.
+
+OPTIONAL PARAMETER
+-------------------
+
+*MTU*::
+ MTU for the network. The MTU default is 1500.
+
+*name-description*::
+ Description of the network.
+
+EXAMPLES
+--------
+
+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: ::
+ *xe network-create* name-label="MTU Example Network" MTU="9000"
+
+SEE ALSO
+--------
+*xe-network-list*(1), *xe-network-param-set*(1), *xe-pool-vlan-create*(1), *xe-network-param-set*(1), *xe-vif-create*(1), *xe-pif-list*(1)
+
+
+AUTHORS
+-------
+Man Page Author(s)::
+Matthew Spah <spahmatthew@xenapiadmin.com>
+
+
+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) 2012 - Matthew Spah
+
+The Howto containing this example, was offered under the following conditions:
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are
+met:
+
+[options="compact"]
+. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+
View
14 docs/en/man/man1/xe-pif-param-clear.ad
@@ -1,7 +1,7 @@
XE(1)
=======
:doctype: manpage
-:man source: xe
+:man source: xe pif-param-clear
:man version: {1}
:man manual: xe pif-param-clear manual
@@ -11,7 +11,6 @@ xe-pif-param-clear - Clears a specific writable parameter for a PIF.
SYNOPSIS
--------
-
*xe pif-param-clear* uuid=<PIF UUID> param-name=<parameter>
@@ -38,15 +37,16 @@ SEE ALSO
--------
*xe-pif-list*(1), *xe-pif-param-list*(1), *xe-pif-param-remove*(1), *xe-pif-param-set*(1), *xe-network-list*(1), *xe-vlan-list*(1)
-BUGS
-----
-Send bugs to xen-devel@lists.xen.org, see http://wiki.xen.org/wiki/Reporting_Bugs_against_XCP on how to send bug reports. General questions can be sent to xen-api@lists.xen.org.
-
AUTHORS
-------
-Matthew Spah <spahmatthew@xenapiadmin.com>::
+Man Page Author(s)::
+Matthew Spah <spahmatthew@xenapiadmin.com>
Lisa Nguyen <lisa@xenapiadmin.com>
+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) 2012 - Matthew Spah, Lisa Nguyen
View
10 docs/en/man/man1/xe-pif-param-get.ad
@@ -1,7 +1,7 @@
XE(1)
=======
:doctype: manpage
-:man source: xe
+:man source: xe pif-param-get
:man version: {1}
:man manual: xe pif-param-get manual
@@ -18,7 +18,7 @@ SYNOPSIS
DESCRIPTION
-----------
-*xe pif-param-get* returns parameter or key value for a specific PIF interface.
+*xe pif-param-get* returns a parameter or a key value for a specific PIF interface.
REQUIRED PARAMETERS
-------------------
@@ -38,6 +38,7 @@ OPTIONAL PARAMETERS
EXAMPLES
--------
+
To display the management parameter for a PIF interface: ::
*xe pif-param-get* uuid=<PIF UUID> param-name="management"
@@ -53,12 +54,13 @@ SEE ALSO
AUTHORS
-------
-Matthew Spah <spahmatthew@xenapiadmin.com>::
+Man Page Author(s)::
+Matthew Spah <spahmatthew@xenapiadmin.com>
Lisa Nguyen <lisa@xenapiadmin.com>
BUGS
----
-See http://wiki.xen.org/wiki/Reporting_Bugs_against_XCP on how to send bug reports, send bugs to xen-devel@lists.xen.org, General questions can be sent to xen-api@lists.xen.org.
+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
---------
View
12 docs/en/man/man1/xe-pif-param-list.ad
@@ -1,7 +1,7 @@
XE(1)
=======
:doctype: manpage
-:man source: xe
+:man source: xe pif-param-list
:man version: {1}
:man manual: xe pif-param-list manual
@@ -34,15 +34,17 @@ SEE ALSO
--------
*xe-pif-list*(1), *xe-pif-param-clear*(1), *xe-pif-scan*(1), *xe-pif-introduce*(1), *xe-network-list*(1)
-BUGS
-----
-See http://wiki.xen.org/wiki/Reporting_Bugs_against_XCP on how to send bug reports, send bugs to xen-devel@lists.xen.org. General questions can be sent to xen-api@lists.xen.org.
AUTHORS
-------
-Matthew Spah <spahmatthew@xenapiadmin.com>::
+Man Page Author(s)::
+Matthew Spah <spahmatthew@xenapiadmin.com>
Lisa Nguyen <lisa@xenapiadmin.com>
+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
---------
View
19 docs/en/man/man1/xe-pif-param-remove.ad
@@ -1,7 +1,7 @@
XE(1)
=======
:doctype: manpage
-:man source: xe
+:man source: xe pif-param-remove
:man version: {1}
:man manual: xe pif-param-remove manual
@@ -13,10 +13,10 @@ SYNOPSIS
--------
*xe pif-param-remove* uuid=<PIF UUID> param-name=<Parameter> param-key=<Parameter Key>
-
DESCRIPTION
-----------
-*xe pif-param-remove* removes a set or map writable parameter key assigned to a PIF interface. Tags is one example of a set or map parameter.
+
+*xe pif-param-remove* removes a set or map writable parameter key assigned to a PIF interface.
REQUIRED PARAMETERS
@@ -29,30 +29,31 @@ REQUIRED PARAMETERS
Parameter that contains parameter keys (e.g. other-config).
*param-key*::
- Parameter key that displays additional information on a PIF.
+ Parameter key that will be removed (e.g. ethtool-speed).
EXAMPLES
--------
-To remove the *ethtool-speed* value::
+
+To remove the *ethtool-speed* value: ::
*xe pif-param-remove* uuid=<PIF UUID> param-name="other-config" param-key="ethtool-speed"
SEE ALSO
--------
*xe-pif-param-set*(1), *xe-pif-param-add*(1), *xe-pif-list*(1), *xe-pif-introduce*(1), *xe-network-list*(1), *xe-vif-list*(1)
-
AUTHORS
-------
-Matthew Spah <spahmatthew@xenapiadmin.com>::
+Man Page Author(s)::
+Matthew Spah <spahmatthew@xenapiadmin.com>
Lisa Nguyen <lisa@xenapiadmin.com>
BUGS
----
-See http://wiki.xen.org/wiki/Reporting_Bugs_against_XCP on how to send bug reports, send bugs to xen-devel@lists.xen.org. General questions can be sent to xen-api@lists.xen.org.
+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) 2012 - Matthew Spah, Lisa Nguyen
+Copyright \(C) 2013 - Matthew Spah, Lisa Nguyen
The Howto containing this example, was offered under the following conditions:
Please sign in to comment.
Something went wrong with that request. Please try again.