diff --git a/docs/en/man/man1/xe-cd-list.ad b/docs/en/man/man1/xe-cd-list.ad new file mode 100644 index 00000000000..7cd666f7e88 --- /dev/null +++ b/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= ] [--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 + + +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" + diff --git a/docs/en/man/man1/xe-network-create.ad b/docs/en/man/man1/xe-network-create.ad new file mode 100644 index 00000000000..06fb9fbb385 --- /dev/null +++ b/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= [ MTU= ] [ name-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 + + +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" + + diff --git a/docs/en/man/man1/xe-network-list.ad b/docs/en/man/man1/xe-network-list.ad new file mode 100644 index 00000000000..09a77f68af4 --- /dev/null +++ b/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= ] [--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 [ // ] + +*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= params="all" + +To display *VIF-uuids* for a specific network: :: + *xe network-list* 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 + + +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" diff --git a/docs/en/man/man1/xe-pif-param-clear.ad b/docs/en/man/man1/xe-pif-param-clear.ad new file mode 100644 index 00000000000..c9a2b1f50f2 --- /dev/null +++ b/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= param-name= + + +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= 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 + +Lisa Nguyen + +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" + + + diff --git a/docs/en/man/man1/xe-pif-param-get.ad b/docs/en/man/man1/xe-pif-param-get.ad new file mode 100644 index 00000000000..8164919d6ca --- /dev/null +++ b/docs/en/man/man1/xe-pif-param-get.ad @@ -0,0 +1,70 @@ +XE(1) +======= +:doctype: manpage +:man source: xe pif-param-get +:man version: {1} +:man manual: xe pif-param-get manual + +NAME +---- +xe-pif-param-get - Returns a parameter for a PIF + +SYNOPSIS +-------- + +*xe pif-param-get* uuid= param-name= [ param-key= ] + +DESCRIPTION +----------- + +*xe pif-param-get* returns a parameter or a key value for a specific PIF. + +REQUIRED PARAMETERS +------------------- + +*uuid*:: + PIF UUID - Use *xe pif-list* to obtain PIF UUIDs. + +*param-name*:: + Parameter for the PIF. + + +OPTIONAL PARAMETERS +------------------- + +*param-key*:: + Name of key in a map or set parameter (e.g. ethtool-speed). + +EXAMPLES +-------- + +To display the *management* parameter for a PIF: :: + *xe pif-param-get* uuid= param-name="management" + +To display the map parameter *ethtool-speed*: :: + *xe pif-param-get* uuid= param-name="other-config" param-key="ethtool-speed" + + + +SEE ALSO +-------- +*xe-pif-list*(1), *xe-pif-param-clear*(1), *xe-pif-param-get*(1), *xe-pif-param-remove*(1), *xe-pif-param-set*(1), *xe-pif-param-add*(1) + +AUTHORS +------- +Manpage Author(s): :: +Matthew Spah + +Lisa Nguyen + +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" + + diff --git a/docs/en/man/man1/xe-pif-param-list.ad b/docs/en/man/man1/xe-pif-param-list.ad new file mode 100644 index 00000000000..9e861baa190 --- /dev/null +++ b/docs/en/man/man1/xe-pif-param-list.ad @@ -0,0 +1,54 @@ +XE(1) +======= +:doctype: manpage +:man source: xe pif-param-list +:man version: {1} +:man manual: xe pif-param-list manual + +NAME +---- +xe-pif-param-list - Displays all parameters for a PIF. + +SYNOPSIS +-------- +*xe pif-param-list* uuid= + +DESCRIPTION +----------- +*xe pif-param-list* displays all parameters for a specific PIF. + + +REQUIRED PARAMETERS +------------------- +*uuid*:: + PIF UUID - Use *xe pif-list* to obtain PIF UUIDs. + + +EXAMPLES +-------- + +To display parameters for a PIF: :: + *xe pif-param-list* uuid= + + +SEE ALSO +-------- +*xe-pif-list*(1), *xe-pif-param-clear*(1), *xe-pif-scan*(1), *xe-pif-introduce*(1), *xe-network-list*(1) + + +AUTHORS +------- +Manpage Author(s): :: +Matthew Spah + +Lisa Nguyen + +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" diff --git a/docs/en/man/man1/xe-pif-param-remove.ad b/docs/en/man/man1/xe-pif-param-remove.ad new file mode 100644 index 00000000000..6f748791a01 --- /dev/null +++ b/docs/en/man/man1/xe-pif-param-remove.ad @@ -0,0 +1,60 @@ +XE(1) +======= +:doctype: manpage +:man source: xe pif-param-remove +:man version: {1} +:man manual: xe pif-param-remove manual + +NAME +---- +xe-pif-param-remove - Removes a writable parameter key for a PIF. + +SYNOPSIS +-------- +*xe pif-param-remove* uuid= param-name= param-key= + +DESCRIPTION +----------- + +*xe pif-param-remove* removes any writable set or map parameter. Use *xe pif-list* and *xe pif-param-list* to identify writable set or map parameters (SRW, MRW). + + +REQUIRED PARAMETERS +------------------- + +*uuid*:: + PIF UUID - Use *xe pif-list* to obtain PIF UUIDs. + +*param-name*:: + Parameter that contains parameter keys (e.g. other-config). + +*param-key*:: + Parameter key that will be removed (e.g. ethtool-speed). + +EXAMPLES +-------- + +To remove the *ethtool-speed* value: :: + *xe pif-param-remove* 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 +------- +Manpage Author(s): :: +Matthew Spah + +Lisa Nguyen + +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" + + diff --git a/docs/en/man/man1/xe-vlan-list.ad b/docs/en/man/man1/xe-vlan-list.ad new file mode 100644 index 00000000000..12a0ce2c493 --- /dev/null +++ b/docs/en/man/man1/xe-vlan-list.ad @@ -0,0 +1,79 @@ +XE(1) +======= +:doctype: manpage +:man source: xe vlan-list +:man version: {1} +:man manual: xe vlan-list manual + +NAME +---- +xe-vlan-list - Display all VLANS. + +SYNOPSIS +-------- +*xe vlan-list* [ params= ] [--minimal] + +DESCRIPTION +----------- + +*xe vlan-list* lists all VLANs and their parameters. Use *xe pif-list* to display VLANs and related PIFs. + +Output can be filtered by using the *params* parameter and a value (separate multiple parameters with commas): :: + *xe vlan-list params="tagged-PIF"* + + *xe vlan-list params="uuid,tagged-PIF,tag"* + +Output can be filtered by using parameter values and the desired value: :: + *xe vlan-list tag=* + +Append --minimal to display values for one parameter on a single line separated by commas: :: + *xe vlan-list params="tag" --minimal* + + +OPTIONAL PARAMETERS +------------------- + +*all*:: + Display all parameter values + +*uuid*:: + Display VLAN UUIDs + +*tag*:: + Display VLAN IDs [ 0 - 4094 ] + +*tagged-PIF*:: + Display physical PIF UUIDs + +*untagged-PIF*:: + Display pseudo PIF UUIDs + + +EXAMPLES +-------- + +To display only the tagged-PIF and tag parameters for VLANs: :: + *xe vlan-list* params="tag,tagged-PIF" + +To display all the VLANS associated with a physical PIF interface: :: + *xe vlan-list* tagged-PIF= params="all" + +SEE ALSO +-------- +*xe-pool-vlan-create*(1), *xe-vlan-create*(1), *xe-pif-list*(1), *xe-vlan-destroy*(1), *xe-network-list*(1) + +AUTHORS +------- +Manpage Author(s): :: +Matthew Spah + +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" + diff --git a/docs/en/man/man1/xe-vlan-param-get.ad b/docs/en/man/man1/xe-vlan-param-get.ad new file mode 100644 index 00000000000..c86d91d5df5 --- /dev/null +++ b/docs/en/man/man1/xe-vlan-param-get.ad @@ -0,0 +1,55 @@ +XE(1) +======= +:doctype: manpage +:man source: xe vlan-param-get +:man version: {1} +:man manual: xe vlan-param-get manual + +NAME +---- +xe-vlan-param-get - Returns a parameter for a VLAN. + +SYNOPSIS +-------- +*xe vlan-param-get* uuid= param-name= + +DESCRIPTION +----------- +*xe vlan-param-get* returns a parameter for a specific VLAN. + + +REQUIRED PARAMETERS +------------------- + +*uuid*:: + VLAN UUID - Use *xe vlan-list* to obtain a list of VLAN UUIDs. + +*param-name*:: + The VLAN parameter to return. + +EXAMPLES +-------- +To display the tagged-PIF parameter for a VLAN: :: + *xe vlan-param-get* uuid= param-name="tagged-PIF" + + +SEE ALSO +-------- +*xe help vlan-param-get*, *xe-vlan-param-list*(1), *xe-vlan-list*(1), *xe-pif-list*(1), *xe-pool-vlan-create*(1), *xe-network-list*(1) + +AUTHORS +------- +Manpage Author(s): :: +Matthew Spah + +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" + diff --git a/docs/en/man/man1/xe-vlan-param-list.ad b/docs/en/man/man1/xe-vlan-param-list.ad new file mode 100644 index 00000000000..a93e4f97bfc --- /dev/null +++ b/docs/en/man/man1/xe-vlan-param-list.ad @@ -0,0 +1,51 @@ +XE(1) +======= +:doctype: manpage +:man source: xe vlan-param-list +:man version: {1} +:man manual: xe vlan-param-list manual + +NAME +---- +xe-vlan-param-list - Lists all parameters for a VLAN. + + +SYNOPSIS +-------- +*xe vlan-param-list* uuid= + +DESCRIPTION +----------- +*xe vlan-param-list* lists all parameters for a specified VLAN. + +REQUIRED PARAMETERS +------------------- +*uuid*:: + VLAN UUID - Use *xe vlan-list* to obtain a list of a VLAN UUIDs. + +EXAMPLES +-------- +To list all the parameters for a specific VLAN: :: + *xe vlan-param-list* uuid= + + +SEE ALSO +-------- +*xe-vlan-list*(1), *xe-vlan-param-get*(1), *xe-pool-vlan-create*(1), *xe-vlan-create*(1), *xe-network-list*(1), *xe-pif-list*(1) + +AUTHORS +------- +Manpage Author(s): :: +Matthew Spah + +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" +