1
Pool appliance-assert-can-be-recovered * appliance-create * appliance-destroy * appliance-list * appliance-param-clear * appliance-param-get * appliance-param-list * appliance-param-set * appliance-recover * appliance-shutdown * appliance-start * Appliance Commands audit-log-get Audit Commands bond-create bond-destroy bond-list bond-param-get bond-param-list bond-set-mode * Bond Commands cd-list CD/DVD Commands console-list console-param-add console-param-clear console-param-get console-param-list console-param-remove console-param-set Console Commands drtask-create * drtask-destroy * drtask-list * drtask-param-get * drtask-param-list * appliance-assert-can-be-recovered * appliance-recover * vm-assert-can-be-recovered * vm-recover * sr-enable-database-replication * sr-disable-database-replication * Disaster Recovery (DR) Commands event-wait Event Commands Virtual GPU (vGPU) vgpu-create * vgpu-destroy * vgpu-list * vgpu-param-add * vgpu-param-clear * vgpu-param-get * vgpu-param-list * vgpu-param-remove * vgpu-param-set * Physical GPU (pGPU) pgpu-list * pgpu-param-add * pgpu-param-clear * pgpu-param-get * pgpu-param-list * pgpu-param-remove * pgpu-param-set * GPU group gpu-group-list * gpu-group-param-add * gpu-group-param-clear * gpu-group-param-get * gpu-group-param-list * gpu-group-param-remove * gpu-group-param-set * GPU Commands * New in XenServer 6.0 (command does not exist in 5.6 SP2) host-all-editions * host-apply-edition host-backup host-bugreport-upload host-call-plugin host-compute-free-memory host-compute-memory-overhead host-cpu-info host-cpu-list host-cpu-param-get host-cpu-param-list host-crashdump-destroy host-crashdump-list host-crashdump-param-get host-crashdump-param-list host-crashdump-upload host-data-source-forget host-data-source-list host-data-source-query host-data-source-record host-disable host-disable-local-storage-caching host-dmesg host-emergency-ha-disable host-emergency-management-reconfigure host-enable host-enable-local-storage-caching host-evacuate host-forget host-get-cpu-features host-get-server-certificate host-get-sm-diagnostics * host-get-system-status host-get-system-status-capabilities host-get-thread-diagnostics * host-get-uncooperative-vms host-get-vms-which-prevent-evacuation host-is-in-emergency-mode host-license-add host-license-view host-list host-logs-download host-management-disable host-management-reconfigure host-param-add host-param-clear host-param-get host-param-list host-param-remove host-param-set host-power-on host-reboot host-reset-cpu-features host-restore host-retrieve-wlb-evacuate-recommendations host-send-debug-keys host-set-cpu-features host-set-hostname-live host-set-power-on-mode host-shutdown host-shutdown-agent host-sm-dp-destroy * host-sync-data host-syslog-reconfigure Host Commands log-get log-get-keys log-reopen log-set-output Log Commands message-create message-destroy message-list message-param-get message-param-list Message Commands network-create network-destroy network-list network-param-add network-param-clear network-param-get network-param-list network-param-remove network-param-set Network Commands patch-apply patch-clean patch-destroy patch-list patch-param-clear patch-param-get patch-param-list patch-pool-apply patch-precheck patch-upload Patch Commands Hosts Storage Networking pbd-create pbd-destroy pbd-list pbd-param-add pbd-param-clear pbd-param-get pbd-param-list pbd-param-remove pbd-param-set pbd-plug pbd-unplug PBD (Physical Block Devices) Commands pif-forget pif-introduce pif-list pif-param-add pif-param-clear pif-param-get pif-param-list pif-param-remove pif-param-set pif-plug pif-reconfigure-ip pif-scan pif-unplug PIF (Phys. Network Interface) Commands pool-certificate-install pool-certificate-list pool-certificate-sync pool-certificate-uninstall pool-crl-install pool-crl-list pool-crl-uninstall pool-deconfigure-wlb pool-designate-new-master pool-disable-external-auth pool-disable-local-storage-caching pool-disable-redo-log pool-dump-database pool-eject pool-emergency-reset-master pool-emergency-transition-to-master pool-enable-external-auth pool-enable-local-storage-caching pool-enable-redo-log pool-ha-compute-hypothetical-max-host-failures-to-tolerate pool-ha-compute-max-host-failures-to-tolerate pool-ha-disable pool-ha-enable pool-initialize-wlb pool-join pool-list pool-param-add pool-param-clear pool-param-get pool-param-list pool-param-remove pool-param-set pool-recover-slaves pool-restore-database pool-retrieve-wlb-configuration pool-retrieve-wlb-diagnostics pool-retrieve-wlb-recommendations pool-retrieve-wlb-report pool-send-test-post pool-send-wlb-configuration pool-sync-database pool-vlan-create Pool Commands sr-create sr-destroy sr-disable-database-replication * sr-enable-database-replication * sr-forget sr-introduce sr-list sr-param-add sr-param-clear sr-param-get sr-param-list sr-param-remove sr-param-set sr-probe sr-scan sr-update SR (Storage Repositories) Commands task-cancel task-list task-param-get task-param-list Task Commands template-export template-list template-param-add template-param-clear template-param-get template-param-list template-param-remove template-param-set template-uninstal Template Commands Virtual Machines update-upload Update Commands user-password-change subject-add subject-list subject-param-clear subject-param-get subject-param-list subject-remove subject-role-add subject-role-remove role-list role-param-get role-param-list session-subject-identifier-list session-subject-identifier-logout session-subject-identifier-logout-all User Commands vbd-create vbd-destroy vbd-eject vbd-insert vbd-list vbd-param-add vbd-param-clear vbd-param-get vbd-param-list vbd-param-remove vbd-param-set vbd-plug vbd-unplug VBD (Virtual Block Devices) Commands vdi-clone vdi-copy vdi-create vdi-destroy vdi-forget vdi-import vdi-introduce vdi-list vdi-param-add vdi-param-clear vdi-param-get vdi-param-list vdi-param-remove vdi-param-set vdi-resize vdi-snapshot vdi-unlock vdi-update VDI (Virtual Disk Images) Commands vif-create vif-destroy vif-list vif-param-add vif-param-clear vif-param-get vif-param-list vif-param-remove vif-param-set vif-plug vif-unplug VIF (Virt. Network Interface) Commands vlan-create vlan-destroy vlan-list vlan-param-get vlan-param-list VLAN Commands vm-assert-can-be-recovered * vm-cd-add vm-cd-eject vm-cd-insert vm-cd-list vm-cd-remove vm-checkpoint vm-clone vm-compute-maximum-memory vm-compute-memory-overhead vm-copy vm-copy-bios-strings vm-crashdump-list vm-data-source-forget vm-data-source-list vm-data-source-query vm-data-source-record vm-destroy vm-disk-add vm-disk-list vm-disk-remove vm-export vm-import vm-install vm-is-bios-customized vm-list vm-memory-dynamic-range-set vm-memory-limits-set vm-memory-shadow-multiplier-set vm-memory-static-range-set vm-memory-target-set vm-migrate vm-param-add vm-param-clear vm-param-get vm-param-list vm-param-remove vm-param-set vm-pause vm-reboot vm-recover * vm-reset-powerstate vm-resume vm-retrieve-wlb-recommendations vm-shutdown vm-snapshot vm-snapshot-with-quiesce vm-start vm-suspend vm-uninstall vm-unpause vm-vcpu-hotplug vm-vif-list VM Commands XenServer 6.0 XE-Command Reference Version: 1.1 © Bjorn Andersson (www.DiverseTips.se) Corrections and improvements are highly welcome (Send to Twitter: @DiverseTips or [email protected]) Newest version of dokument can be found at: http://diversetips.blogspot.com/2011/12/poster-xenserver-xe-command-reference.html XenServer®, XenCenter® are registered trademarks of Citrix Systems, Inc. All other trademarks and registered trademarks are property of their respective owners. pool-initialize-wl pool-param-set other-config pool-retrieve-wlb-diagnostics host-retrieve-wlb-evacuate-recommendations vm-retrieve-wlb-recommendations pool-certificate-list pool-certificate-install pool-certificate-sync pool-param-set pool-deconfigure-wlb pool-retrieve-wlb-configuration pool-retrieve-wlb-recommendations pool-retrieve-wlb-report pool-send-wlb-configuration Workload Balancing (WLB) Commands snapshot-clone snapshot-copy snapshot-destroy snapshot-disk-list snapshot-export-to-template snapshot-list snapshot-param-add snapshot-param-clear snapshot-param-get snapshot-param-list snapshot-param-remove snapshot-param-set snapshot-reset-powerstate snapshot-revert snapshot-uninstal Snapshot Commands sm-list sm-param-get sm-param-list Storage Manager (SM) Commands vmpp-create vmpp-destroy vmpp-list vmpp-param-add vmpp-param-clear vmpp-param-get vmpp-param-list vmpp-param-remove vmpp-param-set VM Protection Policy (VMPP) Commands tunnel-create tunnel-destroy tunnel-list tunnel-param-add tunnel-param-clear tunnel-param-get tunnel-param-list tunnel-param-remove tunnel-param-set Tunnel Commands secret-create secret-destroy secret-list secret-param-clear secret-param-get secret-param-list secret-param-set Secrets Commands diagnostic-compact diagnostic-db-log diagnostic-db-stats diagnostic-gc-stats diagnostic-license-status diagnostic-timing-stats diagnostic-vdi-status diagnostic-vm-status Diagnostics Commands Nice-to-have Linux commands (not XE-commands) xe-toolstack-restart Restarts the XAPI-tools df -h Shows the amount of free disk space xsconsole Starts the text based menu console fdisk -l List the disk partitions xentop Lists top Xen processes iostat -d 2 6 Shows Storage trafic stats (6 reports, 2sec a part) top Lists top processes in Dom0 netstat -s Shows networking statistics xen-bugtool --yes Builds a status report when Xapi is down mpstat 2 Shows processor statistics in Dom0 (every 2 sec) less /var/log/dmesg Displays Boot Messages from Linux vmstat 2 Show virtual memory in Dom0 (every 2 sec) tail /var/log/xensource.log Look at xapi messages as they happen list_domains Lists all VMs that are running (on this server) Some good logfiles (for troubleshooting) /var/log/messages Logs for the system (the host) /var/log/xensource XenServer only logs (XAPI) /var/log/xha Logs regarding High Availability /var/log/audit Kinda what it sounds like... J Audit logs. /etc/xensource-inventory Info about the server (version, build, hypvervisor, when the server was installe...) /var/log/dmesg Boot messages from Linux Some good links at Citrix.com http://support.citrix.com/article/CTX130418 XenServer 6.0 Release Notes http://support.citrix.com/article/CTX131214 Hotfix XS60E001 - For XenServer 6.0 http://support.citrix.com/article/CTX130421 XenServer 6.0 Installation Guide http://support.citrix.com/article/CTX131400 Hotfix XS60E002 - For XenServer 6.0 http://support.citrix.com/article/CTX130420 XenServer 6.0 Administrator's Guide http://support.citrix.com/article/CTX130924 Designing XS 6.0 Network Configurations http://support.citrix.com/article/CTX130422 XenServer 6.0 Virtual Machine Installation Guide http://support.citrix.com/article/CTX130423 XenServer 6.0 vSwitch Controller User Guide http://support.citrix.com/article/CTX130437 XenServer 6.0 Web Self Service Administrator's Guide http://support.citrix.com/article/CTX131047 XenServer 6.0 Configuration Limits

XenServer 6.0 XE Command Reference 1.1

Embed Size (px)

Citation preview

Page 1: XenServer 6.0 XE Command Reference 1.1

Pool

appliance-assert-can-be-recovered *appliance-create *appliance-destroy *appliance-list *appliance-param-clear *appliance-param-get *appliance-param-list *appliance-param-set *appliance-recover *appliance-shutdown *appliance-start *

Appliance Commands

audit-log-get

Audit Commands

bond-createbond-destroybond-listbond-param-getbond-param-listbond-set-mode *

Bond Commands

cd-list

CD/DVD Commands

console-listconsole-param-addconsole-param-clearconsole-param-getconsole-param-listconsole-param-removeconsole-param-set

Console Commands

drtask-create *drtask-destroy *drtask-list *drtask-param-get *drtask-param-list *appliance-assert-can-be-recovered *appliance-recover *vm-assert-can-be-recovered *vm-recover *sr-enable-database-replication *sr-disable-database-replication *

Disaster Recovery (DR) Commands

event-wait

Event Commands

Virtual GPU (vGPU)vgpu-create *vgpu-destroy *vgpu-list *vgpu-param-add *vgpu-param-clear *vgpu-param-get *vgpu-param-list *vgpu-param-remove *vgpu-param-set *

Physical GPU (pGPU)pgpu-list *pgpu-param-add *pgpu-param-clear *pgpu-param-get *pgpu-param-list *pgpu-param-remove *pgpu-param-set *

GPU groupgpu-group-list *gpu-group-param-add *gpu-group-param-clear *gpu-group-param-get *gpu-group-param-list *gpu-group-param-remove *gpu-group-param-set *

GPU Commands

* New in XenServer 6.0 (command does not exist in 5.6 SP2)

host-all-editions *host-apply-editionhost-backuphost-bugreport-uploadhost-call-pluginhost-compute-free-memoryhost-compute-memory-overheadhost-cpu-infohost-cpu-listhost-cpu-param-gethost-cpu-param-listhost-crashdump-destroyhost-crashdump-listhost-crashdump-param-gethost-crashdump-param-listhost-crashdump-uploadhost-data-source-forgethost-data-source-listhost-data-source-queryhost-data-source-recordhost-disablehost-disable-local-storage-cachinghost-dmesghost-emergency-ha-disablehost-emergency-management-reconfigurehost-enablehost-enable-local-storage-cachinghost-evacuatehost-forgethost-get-cpu-featureshost-get-server-certificatehost-get-sm-diagnostics *host-get-system-statushost-get-system-status-capabilitieshost-get-thread-diagnostics *host-get-uncooperative-vmshost-get-vms-which-prevent-evacuationhost-is-in-emergency-modehost-license-addhost-license-viewhost-listhost-logs-downloadhost-management-disablehost-management-reconfigurehost-param-addhost-param-clearhost-param-gethost-param-listhost-param-removehost-param-sethost-power-onhost-reboothost-reset-cpu-featureshost-restorehost-retrieve-wlb-evacuate-recommendationshost-send-debug-keyshost-set-cpu-featureshost-set-hostname-livehost-set-power-on-modehost-shutdownhost-shutdown-agenthost-sm-dp-destroy *host-sync-datahost-syslog-reconfigure

Host Commands

log-getlog-get-keyslog-reopenlog-set-output

Log Commands

message-createmessage-destroymessage-listmessage-param-getmessage-param-list

Message Commands

network-createnetwork-destroynetwork-listnetwork-param-addnetwork-param-clearnetwork-param-getnetwork-param-listnetwork-param-removenetwork-param-set

Network Commands

patch-applypatch-cleanpatch-destroypatch-listpatch-param-clearpatch-param-getpatch-param-listpatch-pool-applypatch-precheckpatch-upload

Patch Commands

Hosts Storage Networking

pbd-createpbd-destroypbd-listpbd-param-addpbd-param-clearpbd-param-getpbd-param-listpbd-param-removepbd-param-setpbd-plugpbd-unplug

PBD (Physical Block Devices) Commands

pif-forgetpif-introducepif-listpif-param-addpif-param-clearpif-param-getpif-param-listpif-param-removepif-param-setpif-plugpif-reconfigure-ippif-scanpif-unplug

PIF (Phys. Network Interface) Commands

pool-certificate-installpool-certificate-listpool-certificate-syncpool-certificate-uninstallpool-crl-installpool-crl-listpool-crl-uninstallpool-deconfigure-wlbpool-designate-new-masterpool-disable-external-authpool-disable-local-storage-cachingpool-disable-redo-logpool-dump-databasepool-ejectpool-emergency-reset-masterpool-emergency-transition-to-masterpool-enable-external-authpool-enable-local-storage-cachingpool-enable-redo-logpool-ha-compute-hypothetical-max-host-failures-to-toleratepool-ha-compute-max-host-failures-to-toleratepool-ha-disablepool-ha-enablepool-initialize-wlbpool-joinpool-listpool-param-addpool-param-clearpool-param-getpool-param-listpool-param-removepool-param-setpool-recover-slavespool-restore-databasepool-retrieve-wlb-configurationpool-retrieve-wlb-diagnosticspool-retrieve-wlb-recommendationspool-retrieve-wlb-reportpool-send-test-postpool-send-wlb-configurationpool-sync-databasepool-vlan-create

Pool Commands

sr-createsr-destroysr-disable-database-replication *sr-enable-database-replication *sr-forgetsr-introducesr-listsr-param-addsr-param-clearsr-param-getsr-param-listsr-param-removesr-param-setsr-probesr-scansr-update

SR (Storage Repositories) Commands

task-canceltask-listtask-param-gettask-param-list

Task Commands

template-exporttemplate-listtemplate-param-addtemplate-param-cleartemplate-param-gettemplate-param-listtemplate-param-removetemplate-param-settemplate-uninstal

Template Commands

Virtual Machines

update-upload

Update Commands

user-password-changesubject-addsubject-listsubject-param-clearsubject-param-getsubject-param-listsubject-removesubject-role-addsubject-role-removerole-listrole-param-getrole-param-listsession-subject-identifier-listsession-subject-identifier-logoutsession-subject-identifier-logout-all

User Commands

vbd-createvbd-destroyvbd-ejectvbd-insertvbd-listvbd-param-addvbd-param-clearvbd-param-getvbd-param-listvbd-param-removevbd-param-setvbd-plugvbd-unplug

VBD (Virtual Block Devices) Commands

vdi-clonevdi-copyvdi-createvdi-destroyvdi-forgetvdi-importvdi-introducevdi-listvdi-param-addvdi-param-clearvdi-param-getvdi-param-listvdi-param-removevdi-param-setvdi-resizevdi-snapshotvdi-unlockvdi-update

VDI (Virtual Disk Images) Commands

vif-createvif-destroyvif-listvif-param-addvif-param-clearvif-param-getvif-param-listvif-param-removevif-param-setvif-plugvif-unplug

VIF (Virt. Network Interface) Commands

vlan-createvlan-destroyvlan-listvlan-param-getvlan-param-list

VLAN Commands

vm-assert-can-be-recovered *vm-cd-addvm-cd-ejectvm-cd-insertvm-cd-listvm-cd-removevm-checkpointvm-clonevm-compute-maximum-memoryvm-compute-memory-overheadvm-copyvm-copy-bios-stringsvm-crashdump-listvm-data-source-forgetvm-data-source-listvm-data-source-queryvm-data-source-recordvm-destroyvm-disk-addvm-disk-listvm-disk-removevm-exportvm-importvm-installvm-is-bios-customizedvm-listvm-memory-dynamic-range-setvm-memory-limits-setvm-memory-shadow-multiplier-setvm-memory-static-range-setvm-memory-target-setvm-migratevm-param-addvm-param-clearvm-param-getvm-param-listvm-param-removevm-param-setvm-pausevm-rebootvm-recover *vm-reset-powerstatevm-resumevm-retrieve-wlb-recommendationsvm-shutdownvm-snapshotvm-snapshot-with-quiescevm-startvm-suspendvm-uninstallvm-unpausevm-vcpu-hotplugvm-vif-list

VM Commands

XenServer 6.0 XE-Command ReferenceVersion: 1.1

© Bjorn Andersson (www.DiverseTips.se)

Corrections and improvements are highly welcome (Send to Twitter: @DiverseTips or [email protected])

Newest version of dokument can be found at: http://diversetips.blogspot.com/2011/12/poster-xenserver-xe-command-reference.htmlXenServer®, XenCenter® are registered trademarks of Citrix Systems, Inc.

All other trademarks and registered trademarks are property of their respective owners.

pool-initialize-wlpool-param-set other-configpool-retrieve-wlb-diagnosticshost-retrieve-wlb-evacuate-recommendationsvm-retrieve-wlb-recommendationspool-certificate-listpool-certificate-installpool-certificate-syncpool-param-setpool-deconfigure-wlbpool-retrieve-wlb-configurationpool-retrieve-wlb-recommendationspool-retrieve-wlb-reportpool-send-wlb-configuration

Workload Balancing (WLB) Commands

snapshot-clonesnapshot-copysnapshot-destroysnapshot-disk-listsnapshot-export-to-templatesnapshot-listsnapshot-param-addsnapshot-param-clearsnapshot-param-getsnapshot-param-listsnapshot-param-removesnapshot-param-setsnapshot-reset-powerstatesnapshot-revertsnapshot-uninstal

Snapshot Commands

sm-listsm-param-getsm-param-list

Storage Manager (SM) Commands

vmpp-createvmpp-destroyvmpp-listvmpp-param-addvmpp-param-clearvmpp-param-getvmpp-param-listvmpp-param-removevmpp-param-set

VM Protection Policy (VMPP) Commands

tunnel-createtunnel-destroytunnel-listtunnel-param-addtunnel-param-cleartunnel-param-gettunnel-param-listtunnel-param-removetunnel-param-set

Tunnel Commands

secret-createsecret-destroysecret-listsecret-param-clearsecret-param-getsecret-param-listsecret-param-set

Secrets Commands diagnostic-compactdiagnostic-db-logdiagnostic-db-statsdiagnostic-gc-statsdiagnostic-license-statusdiagnostic-timing-statsdiagnostic-vdi-statusdiagnostic-vm-status

Diagnostics Commands

Nice-to-have Linux commands (not XE-commands)xe-toolstack-restart Restarts the XAPI-tools df -h Shows the amount of free disk spacexsconsole Starts the text based menu console fdisk -l List the disk partitionsxentop Lists top Xen processes iostat -d 2 6 Shows Storage trafic stats (6 reports, 2sec a part)top Lists top processes in Dom0 netstat -s Shows networking statisticsxen-bugtool --yes Builds a status report when Xapi is down mpstat 2 Shows processor statistics in Dom0 (every 2 sec)less /var/log/dmesg Displays Boot Messages from Linux vmstat 2 Show virtual memory in Dom0 (every 2 sec)tail /var/log/xensource.log Look at xapi messages as they happen list_domains Lists all VMs that are running (on this server)

Some good logfiles (for troubleshooting)/var/log/messages Logs for the system (the host)/var/log/xensource XenServer only logs (XAPI)/var/log/xha Logs regarding High Availability/var/log/audit Kinda what it sounds like... J Audit logs./etc/xensource-inventory Info about the server (version, build, hypvervisor, when the server was installe...)/var/log/dmesg Boot messages from Linux

Some good links at Citrix.comhttp://support.citrix.com/article/CTX130418 XenServer 6.0 Release Notes http://support.citrix.com/article/CTX131214 Hotfix XS60E001 - For XenServer 6.0 http://support.citrix.com/article/CTX130421 XenServer 6.0 Installation Guide http://support.citrix.com/article/CTX131400 Hotfix XS60E002 - For XenServer 6.0 http://support.citrix.com/article/CTX130420 XenServer 6.0 Administrator's Guide http://support.citrix.com/article/CTX130924 Designing XS 6.0 Network Configurations http://support.citrix.com/article/CTX130422 XenServer 6.0 Virtual Machine Installation Guidehttp://support.citrix.com/article/CTX130423 XenServer 6.0 vSwitch Controller User Guide http://support.citrix.com/article/CTX130437 XenServer 6.0 Web Self Service Administrator's Guidehttp://support.citrix.com/article/CTX131047 XenServer 6.0 Configuration Limits