Oracle® VM
Manager Command Line Interface User's Guide for Release 3.4
Oracle Legal Notices
Copyright © 2012, 2021 Oracle and/or its affiliates. All rights reserved.
This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs) and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are "commercial computer software" or "commercial computer software documentation" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained in the applicable contract. The terms governing the U.S. Government's use of Oracle cloud services are defined by the applicable contract for such services. No other rights are granted to the U.S. Government.
This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.
This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.
Oracle Documentation License
This document uses the Web-based Help format from DocBook XML. The following license information applies to this format.
Copyright © 1999-2007 Norman Walsh
Copyright © 2003 Jiri Kosek
Copyright © 2004-2007 Steve Ball
Copyright © 2005-2008 The DocBook Project
Copyright © 2011-2012 O'Reilly Media
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ``Software''), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
Except as contained in this notice, the names of individuals credited with contribution to this software shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization from the individuals in question.
Any stylesheet derived from this Software that is publicly distributed will be identified with a different name and the version strings in any derived Software will be changed so that no possibility of confusion between the derived package and this Software will exist.
Warranty
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL NORMAN WALSH OR ANY OTHER CONTRIBUTOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Web-based Help from DocBook XML
Copyright © 2008-2012 Kasun Gajasinghe, David Cramer
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
Except as contained in this notice, the names of individuals credited with contribution to this software shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization from the individuals in question.
-
Any stylesheet derived from this Software that is publicly distributed will be identified with a different name and the version strings in any derived Software will be changed so that no possibility of confusion between the derived package and this Software will exist.
Warranty: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL DAVID CRAMER, KASUN GAJASINGHE, OR ANY OTHER CONTRIBUTOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Certain search characteristics associated with the DocBook XSL webhelp stylesheets are provided as javascript files generated using Apache Lucene and other fourth party technologies, which are licensed under the Apache License reproduced below.
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use,
reproduction, and distribution as defined by Sections 1 through
9 of this document.
"Licensor" shall mean the copyright owner or entity authorized
by the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under
common control with that entity. For the purposes of this
definition, "control" means (i) the power, direct or indirect,
to cause the direction or management of such entity, whether by
contract or otherwise, or (ii) ownership of fifty percent (50%)
or more of the outstanding shares, or (iii) beneficial ownership
of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making
modifications, including but not limited to software source code,
documentation source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or
Object form, that is based on (or derived from) the Work and
for which the editorial revisions, annotations, elaborations,
or other modifications represent, as a whole, an original work
of authorship. For the purposes of this License, Derivative
Works shall not include works that remain separable from, or
merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or
additions to that Work or Derivative Works thereof, that is
intentionally submitted to Licensor for inclusion in the Work
by the copyright owner or by an individual or Legal Entity
authorized to submit on behalf of the copyright owner.
For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication
sent to the Licensor or its representatives, including but not
limited to communication on electronic mailing lists, source
code control systems, and issue tracking systems that are
managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work,
but excluding communication that is conspicuously marked or
otherwise designated in writing by the copyright owner as
"Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal
Entity on behalf of whom a Contribution has been received by
Licensor and subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions
of this License, each Contributor hereby grants to You a
perpetual, worldwide, non-exclusive, no-charge, royalty-free,
irrevocable copyright license to reproduce, prepare Derivative
Works of, publicly display, publicly perform, sublicense, and
distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have
made, use, offer to sell, sell, import, and otherwise transfer
the Work, where such license applies only to those patent claims
licensable by such Contributor that are necessarily infringed
by their Contribution(s) alone or by combination of their
Contribution(s) with the Work to which such Contribution(s) was
submitted. If You institute patent litigation against any entity
(including a cross-claim or counterclaim in a lawsuit) alleging
that the Work or a Contribution incorporated within the Work
constitutes direct or contributory patent infringement, then any
patent licenses granted to You under this License for that Work
shall terminate as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute
must include a readable copy of the attribution notices
contained within such NOTICE file, excluding those notices
that do not pertain to any part of the Derivative Works, in
at least one of the following places: within a NOTICE text
file distributed as part of the Derivative Works; within
the Source form or documentation, if provided along with
the Derivative Works; or, within a display generated by the
Derivative Works, if and wherever such third-party notices
normally appear. The contents of the NOTICE file are for
informational purposes only and do not modify the License.
You may add Your own attribution notices within Derivative
Works that You distribute, alongside or as an addendum to
the NOTICE text from the Work, provided that such additional
attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications
and may provide additional or different license terms and
conditions for use, reproduction, or distribution of Your
modifications, or for any such Derivative Works as a whole,
provided Your use, reproduction, and distribution of the Work
otherwise complies with the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state
otherwise, any Contribution intentionally submitted for
inclusion in the Work by You to the Licensor shall be under the
terms and conditions of this License, without any additional
terms or conditions. Notwithstanding the above, nothing herein
shall supersede or modify the terms of any separate license
agreement you may have executed with Licensor regarding such
Contributions.
6. Trademarks. This License does not grant permission to use the
trade names, trademarks, service marks, or product names of the
Licensor, except as required for reasonable and customary use in
describing the origin of the Work and reproducing the content of
the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or
conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or
FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible
for determining the appropriateness of using or redistributing
the Work and assume any risks associated with Your exercise of
permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and
grossly negligent acts) or agreed to in writing, shall any
Contributor be liable to You for damages, including any direct,
indirect, special, incidental, or consequential damages of any
character arising as a result of this License or out of the use
or inability to use the Work (including but not limited to
damages for loss of goodwill, work stoppage, computer failure
or malfunction, or any and all other commercial damages or
losses), even if such Contributor has been advised of the
possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty,
indemnity, or other liability obligations and/or rights
consistent with this License. However, in accepting such
obligations, You may act only on Your own behalf and on Your
sole responsibility, not on behalf of any other Contributor,
and only if You agree to indemnify, defend, and hold each
Contributor harmless for any liability incurred by, or claims
asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied. See the License for the specific language governing
permissions and limitations under the License.
E64086-07
April 2021
Document generated on: 2021-04-13 (revision: 7587)
- Preface
- 1 What's New in the Oracle VM Manager Command Line Interface (CLI)?
-
2 Introduction to the Oracle VM Manager Command Line Interface (CLI)
- 2.1 Starting and Stopping the CLI
- 2.2 Connecting to the CLI
- 2.3 SSH Host Keys
- 2.4 Key-Based Authentication
- 2.5 Using SSH to Run Background Processes
- 2.6 Using the Oracle VM CLI and Getting Help
- 2.7 Passing in a CLI Command at the Command Line
- 2.8 Sample Scripts
- 2.9 Integrating the CLI into Your Applications
- 2.10 Configuring the Oracle VM CLI
- 2.11 CLI Logs
- I Using the CLI
-
II CLI Command Reference
-
A CLI Command Reference
- A.1 abort Job
- A.2 ackEvent
- A.3 addAccessHost
- A.4 addAdminServer
- A.5 addPolicyServer
- A.6 addRefreshServer
- A.7 add BondPort
- A.8 add FileSystem
- A.9 add PhysicalDisk
- A.10 add Port
- A.11 add Server
- A.12 add ServerPool
- A.13 add StorageInitiator
- A.14 add Tag
- A.15 add VlanInterface
- A.16 add Vm
- A.17 add Vnic
- A.18 changeServerAgentPassword
- A.19 checkUpToDate
- A.20 clearVmAllRcvdMessages
- A.21 clearVmAllSentMessages
- A.22 clearVmRcvdMessage
- A.23 clearVmSentMessage
- A.24 clone Vm
- A.25 cloneCdToRepo
- A.26 clonePdToPd
- A.27 clonePdToRepo
- A.28 clonePdToStorageArray
- A.29 cloneVdToPd
- A.30 cloneVdToRepo
- A.31 createVmFromAssembly (Deprecated)
- A.32 createVmFromVirtualAppliance
- A.33 createVmFromVirtualApplianceVm
- A.34 create AccessGroup
- A.35 create AntiAffinityGroup
- A.36 create BondPort
- A.37 create CpuCompatibilityGroup
- A.38 create FileServer
- A.39 create FileSystem
- A.40 create Network
- A.41 create PhysicalDisk
- A.42 create Repository
- A.43 create RepositoryExport
- A.44 create ServerController
- A.45 create ServerPool
- A.46 create ServerPoolNetworkPolicy
- A.47 create ServerUpdateGroup
- A.48 create ServerUpdateRepository
- A.49 create StorageArray
- A.50 create Tag
- A.51 create VirtualDisk
- A.52 create VlanInterface
- A.53 create Vm
- A.54 create VmCloneCustomizer
- A.55 create VmCloneNetworkMapping
- A.56 create VmCloneStorageMapping
- A.57 create VmDiskMapping
- A.58 create Vnic
- A.59 delete
- A.60 discoverServer
- A.61 edit AccessGroup
- A.62 edit AntiAffinityGroup
- A.63 edit Assembly (Deprecated)
- A.64 edit AssemblyVirtualDisk (Deprecated)
- A.65 edit AssemblyVm (Deprecated)
- A.66 edit BondPort
- A.67 edit ControlDomain
- A.68 edit Cpu
- A.69 edit CpuCompatibilityGroup
- A.70 edit FileServer
- A.71 edit FileServerPlugin
- A.72 edit FileSystem
- A.73 edit Manager
- A.74 edit Network
- A.75 edit PeriodicTask
- A.76 edit PhysicalDisk
- A.77 edit Port
- A.78 edit Repository
- A.79 edit RepositoryExport
- A.80 edit Server
- A.81 edit ServerController
- A.82 edit ServerPool
- A.83 edit ServerPoolNetworkPolicy
- A.84 edit ServerUpdateGroup
- A.85 edit ServerUpdateRepository
- A.86 edit StorageArray
- A.87 edit StorageArrayPlugin
- A.88 edit Tag
- A.89 edit VirtualAppliance
- A.90 edit VirtualApplianceVirtualDisk
- A.91 edit VirtualApplianceVm
- A.92 edit VirtualCdrom
- A.93 edit VirtualDisk
- A.94 edit VlanInterface
- A.95 edit Vm
- A.96 edit VmCloneCustomizer
- A.97 edit VmCloneNetworkMapping
- A.98 edit VmCloneStorageMapping
- A.99 edit VmDiskMapping
- A.100 edit Vnic
- A.101 edit VolumeGroup
- A.102 embeddedCreate
- A.103 embeddedDelete
- A.104 embeddedEdit
- A.105 exit
- A.106 exportVirtualAppliance
- A.107 getArchiveConfig
- A.108 getAverageStat
- A.109 getDbBackupConfig
- A.110 getDebugTranscript
- A.111 getDescriptor
- A.112 getEventListByQuery
- A.113 getEvents
- A.114 getEventsForObject
- A.115 getJobs
- A.116 getLatestStat
- A.117 getLatestStatForList
- A.118 getManagerTime
- A.119 getQueuedJobInfo
- A.120 getStatsConfig
- A.121 getStatList
- A.122 getStatListByQuery
- A.123 getTriageEvent
- A.124 getTriageEventSeverityList
- A.125 getVmCfgFileContent
- A.126 getVmOsTypes
- A.127 getVmReceivedMessages
- A.128 getVmSentMessages
- A.129 getVnicMacAddrRange
- A.130 help
- A.131 importAssembly (Deprecated)
- A.132 importTemplate
- A.133 importVirtualAppliance
- A.134 importVirtualCdrom
- A.135 importVirtualDisk
- A.136 importVirtualMachine
- A.137 kill
- A.138 list
- A.139 migrate Vm
- A.140 migrateWithLocalStorage Vm
- A.141 moveVmToRepository
- A.142 refresh
- A.143 refreshAll
- A.144 refreshStorageLayer
- A.145 releaseOwnership
- A.146 removeAccessHost
- A.147 removeAdminServer
- A.148 removePolicyServer
- A.149 removeRefreshServer
- A.150 remove BondPort
- A.151 remove FileSystem
- A.152 remove PhysicalDisk
- A.153 remove Port
- A.154 remove Server
- A.155 remove ServerPool
- A.156 remove StorageInitiator
- A.157 remove Tag
- A.158 remove VlanInterface
- A.159 remove Vm
- A.160 remove Vnic
- A.161 resize
- A.162 restart
- A.163 resume
- A.164 sendVmMessage
- A.165 set
- A.166 setArchiveConfig
- A.167 setDbBackupConfig
- A.168 setMaintenanceMode
- A.169 setStatsConfig
- A.170 setVnicMacAddrRange
- A.171 show
- A.172 showallcustomcmds
- A.173 showclisession
- A.174 showcustomcmds
- A.175 showobjtypes
- A.176 showversion
- A.177 start
- A.178 stop
- A.179 suspend
- A.180 takeOwnership
- A.181 upgrade
- A.182 validate
-
A CLI Command Reference
- Glossary
- Index