Merge pull request #957 from Xenapi-Admin-Project/master

xe manpages

docs/en/man/man1/xe-cd-list.ad

@@ -0,0 +1,139 @@
+XE(1)
+=======
+:doctype: manpage
+:man source:   	xe-cd-list 
+:man version:  	{1}
+:man manual:   	xe cd-list Manual
+
+
+NAME
+----
+xe-cd-list - Lists CD images
+
+SYNOPSIS
+--------
+
+*xe cd-list* [ params=<PARAMETER> ] [--minimal]
+
+
+DESCRIPTION
+-----------
+
+*xe cd-list* displays cds and their parameters.
+
+Output can be filtered by using the *params* parameter and a value (separate multiple parameters with commas): ::
+	*xe cd-list params=uuid* +
+	*xe cd-list params=uuid,name-label,name-description*
+
+Append --minimal to display values for one parameter on a single line separated by commas: ::
+	*xe cd-list params="name-label" --minimal*
+
+
+OPTIONAL PARAMETERS
+-------------------
+
+*all*::
+	Display all parameter values
+*uuid*::
+	Display CD UUIDs
+*name-label*::
+	Display CD name labels
+*name-description*::
+	Display CD name descriptions
+*is-a-snapshot*::
+	Display if a CD is a snapshot [ true | false ]
+*snapshot-of*::
+	Display UUID of snapshotted CD
+*snapshots*::
+	Display how many snapshots the CD has
+*snapshot-time*::
+	Display the time of the snapshot
+*allowed-operations*::
+	Display allowed operations 
+*current-operations*::
+	Display current operations 
+*sr-uuid*::
+	Display UUID of the ISO Storage Repository where the CD resides
+*sr-name-label*::
+	Display name-label of the ISO Storage Repository where the CD resides
+*vbd-uuids*::
+	Display any Virtual Block Device UUIDs
+*crashdump-uuids*::
+	Display any crash dump UUIDs
+*virtual-size*::
+	Display the virtual size in bytes
+*physical-utilisation*::
+	Display utilised size in bytes
+*location*::
+	Display the CD filename
+*type*::
+	Display the CD type [ User | System ]
+*sharable*::
+	Display if the CD is sharable [ true | false ]
+*read-only*::
+	Display if the CD is read-only [ true | false ]
+*storage-lock*::
+	Display if the disk is locked at the storage level [ true | false ]
+*managed*::
+	Display if managed [ true | false ]
+*parent*::
+	Display parent disk if CD is part of a chain
+*missing*::
+	Display if the ISO Storage Repository has reported CD missing [ true | false ]
+*other-config*::
+	Display additional configuration parameter values for CD
+*xenstore-data*::
+	Display data to be inserted into xenstore tree
+*sm-config*::
+	Display storage manager device config keys
+*on-boot*::
+	Display on-boot config
+*allow-caching*::
+	Display if caching is allowed [ true | false ]
+*metadata-latest*::
+	Display latest CD metadata
+*metadata-of-pool*::
+	Display pool metadata
+*tags*::
+	Display tags
+*--minimal*::
+	Specify --minimal to only show minimal output.
+
+
+
+EXAMPLES
+--------
+
+To display all CD name-labels: ::
+	*xe cd-list* params="name-label"
+
+To display all parameters for all CDs: ::
+	*xe cd-list* params="all"
+
+To display minimal output for all CDs: ::
+	*xe cd-list* --minimal
+
+
+
+SEE ALSO
+--------
+*xe help cd-list*, *xe-vm-cd-add*(1), *xe-vm-cd-eject*(1), *xe-vm-cd-insert*(1), *xe-vm-cd-list*(1), *xe-vm-cd-remove*(1)
+
+
+AUTHORS
+-------
+Manpage Author(s): ::
+Grant McWilliams <grant@soundlinuxtraining.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 - Grant McWilliams
+
+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

@@ -0,0 +1,67 @@
+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* creates 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
+-------
+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-network-list.ad

@@ -0,0 +1,128 @@
+XE(1)
+=======
+:doctype: manpage
+:man source:   xe network-list
+:man version:  {1}
+:man manual:   xe network-list manual
+
+NAME
+-----
+xe-network-list - Displays all networks and their parameters.
+
+SYNOPSIS
+--------
+
+*xe network-list*  [ params=<PARAMETER> ] [--minimal]
+
+
+DESCRIPTION
+-----------
+
+*xe network-list* displays networks and their parameters.
+
+Output can be filtered by using the *params* parameter and a value (separate multiple parameters with commas): ::
+	*xe network-list params=PIF-uuids* +
+	*xe network-list params=PIF-uuids,VIF-uuids,name-label,name-description*
+
+Output can be filtered by using parameter values and the desired value: ::
+	*xe network-list bridge=xapi0*
+
+Append --minimal to display values for one parameter on a single line separated by commas: ::
+	*xe network-list params="MTU" --minimal*
+
+
+
+OPTIONAL PARAMETERS
+-------------------
+
+*all*::
+	Display all parameter values
+
+*uuid*::
+	Display network UUIDs
+
+*name-label*::	
+	Display network name-labels
+
+*name-description*::	
+	Display network descriptions
+
+*VIF-uuids*::	
+	Display VIFs attached to networks
+
+*PIF-uuids*:: 	
+ 	Display PIFs attached to networks
+
+*MTU*::	
+	Display network MTU values
+
+*bridge*::
+	Display network bridge names
+
+*blobs*::	
+	Display binary data stores
+
+*tags*::	
+	Display writable tag parameters
+
+*other-config:static-routes*::	
+	Display comma seperated list of Static routes present on network [ <SOURCE NETWORK ADDRESS>/<CIDR MASK>/<NEXT HOP ADDRESS> ] 
+
+*other-config:ethtool-autoneg*::
+	Display ethernet Autonegotiation status [ on | off ]
+
+*other-config:ethtool-rx*:: 
+	Display receive checksum status [ on | off ]
+
+*other-config:ethtool-tx*::
+	Display transmit checksum status [ on | off ]
+
+*other-config:ethtool-sg*:: 
+	Display scatter gather status [ on | off ]
+
+*other-config:ethtool-tso*::
+	Display TCP segmentation offload status [ on | off ]
+
+*other-config:ethtool-ufo*::
+	Display UDP fragment offload status [ on | off ]
+
+*other-config:ethtool-gso*::
+	Display generic segmentation offload status [ on | off ]
+
+*--minimal*::
+	Specify --minimal to only show minimal output
+
+EXAMPLES
+--------
+
+To display all parameters for all networks in a pool: ::
+	*xe network-list* params="all"
+
+To display all paramters for a specific network: ::
+	*xe network-list* uuid=<NETWORK UUID> params="all"
+
+To display *VIF-uuids* for a specific network: ::
+	*xe network-list* uuid=<NETWORK UUID> params="VIF-uuids"
+
+To display the *name-label* and *UUID* parameters of all networks with a *MTU* of 1500: ::
+	*xe network-list* MTU="1500" params="name-label,uuid"
+
+
+SEE ALSO
+--------
+*xe help network-list*, *xe-network-create*(1), *xe-network-destroy*(1), *xe-network-param-set*(1), *xe-network-param-add*(1), *xe-network-param-clear*(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-pif-param-clear.ad

@@ -0,0 +1,58 @@
+XE(1)
+=======
+:doctype: manpage
+:man source:   xe pif-param-clear
+:man version:  {1}
+:man manual:   xe pif-param-clear manual
+
+NAME
+----
+xe-pif-param-clear - Clears a specific writable parameter for a PIF
+
+SYNOPSIS
+--------
+*xe pif-param-clear* uuid=<PIF UUID> param-name=<PARAMETER> 
+
+
+DESCRIPTION
+-----------
+*xe pif-param-clear* attempts to clear any writable parameter. Use *xe pif-list* and *xe pif-param-list* to identify writable parameters (RW, SRW, MRW).
+
+REQUIRED PARAMETERS
+-------------------
+
+*uuid*::
+	PIF UUID - Use *xe pif-list* to obtain PIF UUIDs.
+
+*param-name*::
+	Parameter to be cleared for a PIF interface (e.g. other-config). 
+
+EXAMPLES
+--------
+
+To clear all values found in the *other-config* parameter: ::
+	*xe pif-param-clear* uuid=<PIF UUID> param-name="other-config"
+
+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)
+
+AUTHORS
+-------
+Manpage Author(s): ::
+Matthew Spah <spahmatthew@xenapiadmin.com> +
+Lisa Nguyen <lisa@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, Lisa Nguyen
+
+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"
+
+
+