Common OVF Tool (COT)
Introduction
Examples
Installing COT
System requirements
Download COT
Install the COT libraries and script
Install helper programs
Using COT
Getting CLI help
Verifying and installing helper programs with
cot
install-helpers
Inspecting OVF contents with
cot
info
Updating version information with
cot
edit-product
Adding disks to an OVF with
cot
add-disk
Packaging additional files into an OVF with
cot
add-file
Customizing hardware profiles with
cot
edit-hardware
Customizing OVF environment settings with
cot
edit-properties
Embedding bootstrap configuration with
cot
inject-config
Deploying an OVF to create a VM with
cot
deploy
Creating a VM on VMware vCenter/vSphere with
cot
deploy
esxi
Contributing to COT
Follow coding guidelines
Add automated unit tests
Update documentation
Add yourself as a contributor
Credits
COT
package reference
Virtual machine definition modules
Command modules
Helper library modules
User interface modules
COT.helpers
package reference
API
Exceptions
Helper modules
Common OVF Tool (COT)
Docs
»
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
X
|
Y
_
__init__() (Helper method)
A
add_child() (COT.xml_file.XML class method)
add_controller_device() (OVF method)
(VMDescription method)
add_disk() (OVF method)
(VMDescription method)
add_disk_device() (OVF method)
(VMDescription method)
add_disk_worker() (in module COT.add_disk)
add_file() (OVF method)
(VMDescription method)
add_item() (OVFItem method)
add_profile() (OVFItem method)
address (COTAddDisk attribute)
apt_install() (COT.helpers.helper.Helper class method)
ATTRIB_KEY_SUFFIX (OVFItem attribute)
B
BOOTSTRAP_DISK_TYPE (GenericPlatform attribute)
(IOSv attribute)
byte_count() (in module COT.ovf)
byte_string() (in module COT.ovf)
C
call_helper() (Helper method)
check_for_conflict() (in module COT.data_validation)
check_sanity_of_disk_device() (OVF method)
(VMDescription method)
choose_from_list() (UI method)
CLI (class in COT.cli)
clone_item() (OVFHardware method)
config_file (COTEditProperties attribute)
(COTInjectConfig attribute)
config_file_to_properties() (OVF method)
(VMDescription method)
config_profiles (OVF attribute)
(VMDescription attribute)
CONFIG_TEXT_FILE (CSR1000V attribute)
(GenericPlatform attribute)
(IOSXRv attribute)
(IOSXRvLC attribute)
(IOSv attribute)
(NXOSv attribute)
configuration (COTDeploy attribute)
confirm() (CLI method)
(UI method)
confirm_or_die() (UI method)
controller (COTAddDisk attribute)
controller_type_for_device() (COT.platforms.CSR1000V class method)
(COT.platforms.GenericPlatform class method)
convert_disk_if_needed() (OVF method)
(VMDescription method)
convert_disk_image() (in module COT.helpers.api)
(QEMUImg method)
(VmdkTool method)
COT (module)
COT.add_disk (module)
COT.add_file (module)
COT.cli (module)
COT.data_validation (module)
COT.deploy (module)
COT.edit_hardware (module)
COT.edit_product (module)
COT.edit_properties (module)
COT.help (module)
COT.helpers (module)
COT.helpers.api (module)
COT.helpers.fatdisk (module)
COT.helpers.helper (module)
COT.helpers.mkisofs (module)
COT.helpers.ovftool (module)
COT.helpers.qemu_img (module)
COT.helpers.vmdktool (module)
COT.info (module)
COT.inject_config (module)
COT.install_helpers (module)
COT.ovf (module)
COT.platforms (module)
COT.submodule (module)
COT.ui_shared (module)
COT.vm_context_manager (module)
COT.vm_description (module)
COT.vm_factory (module)
COT.xml_file (module)
COTAddDisk (class in COT.add_disk)
COTAddFile (class in COT.add_file)
COTDeploy (class in COT.deploy)
COTDeployESXi (class in COT.deploy)
COTEditHardware (class in COT.edit_hardware)
COTEditProduct (class in COT.edit_product)
COTEditProperties (class in COT.edit_properties)
COTGenericSubmodule (class in COT.submodule)
COTHelp (class in COT.help)
COTInfo (class in COT.info)
COTInjectConfig (class in COT.inject_config)
COTInstallHelpers (class in COT.install_helpers)
COTReadOnlySubmodule (class in COT.submodule)
COTSubmodule (class in COT.submodule)
cpus (COTEditHardware attribute)
create() (COT.vm_factory.VMFactory class method)
create_blank_disk() (QEMUImg method)
create_configuration_profile() (OVF method)
(VMDescription method)
create_disk_image() (in module COT.helpers.api)
create_envelope_section_if_absent() (OVF method)
create_iso() (MkIsoFS method)
create_network() (OVF method)
(VMDescription method)
create_parser() (CLI method)
create_raw_image() (FatDisk method)
create_subparser() (COTAddDisk method)
(COTAddFile method)
(COTDeploy method)
(COTDeployESXi method)
(COTEditHardware method)
(COTEditProduct method)
(COTEditProperties method)
(COTGenericSubmodule method)
(COTHelp method)
(COTInfo method)
(COTInjectConfig method)
(COTInstallHelpers method)
create_subparsers() (CLI method)
CSR1000V (class in COT.platforms)
D
datastore (COTDeployESXi attribute)
default_config_profile (VMDescription attribute)
default_confirm_response (UI attribute)
description (COTAddDisk attribute)
destroy() (COTGenericSubmodule method)
(VMDescription method)
detect_type_from_name() (COT.ovf.OVF class method)
(COT.vm_description.VMDescription class method)
device_address() (in module COT.data_validation)
device_info_str() (OVF method)
disk_image (COTAddDisk attribute)
diskname (COTAddDisk attribute)
download_and_expand() (COT.helpers.helper.Helper class method)
E
edit_properties_interactive() (COTEditProperties method)
ELEMENT_KEY_SUFFIX (OVFItem attribute)
environment_properties (OVF attribute)
(VMDescription attribute)
F
factor_bytes() (in module COT.ovf)
FatDisk (class in COT.helpers.fatdisk)
file (COTAddFile attribute)
file_id (COTAddDisk attribute)
(COTAddFile attribute)
fill_examples() (CLI method)
(UI method)
fill_usage() (CLI method)
(UI method)
find_all_children() (COT.xml_file.XML class method)
find_all_items() (OVFHardware method)
find_child() (COT.xml_file.XML class method)
find_device_location() (OVF method)
(VMDescription method)
find_disk_from_file_id() (OVF method)
find_empty_drive() (OVF method)
(VMDescription method)
find_executable() (COT.helpers.helper.Helper class method)
find_item() (OVFHardware method)
find_item_from_disk() (OVF method)
find_item_from_file() (OVF method)
find_open_controller() (OVF method)
(VMDescription method)
find_parent_from_item() (OVF method)
find_unused_instance_id() (OVFHardware method)
finished() (COTGenericSubmodule method)
(COTSubmodule method)
force (UI attribute)
formatter() (CLI method)
full_version (COTEditProduct attribute)
G
generate_items() (OVFItem method)
generate_manifest() (OVF method)
generic_parser (COTDeploy attribute)
GenericPlatform (class in COT.platforms)
get() (OVFItem method)
get_all_values() (OVFItem method)
get_capacity_from_disk() (OVF method)
get_checksum() (in module COT.helpers.api)
get_common_subtype() (OVF method)
(VMDescription method)
get_disk_capacity() (in module COT.helpers.api)
(QEMUImg method)
get_disk_format() (in module COT.helpers.api)
(QEMUImg method)
get_file_ref_from_disk() (OVF method)
(VMDescription method)
get_id_from_file() (OVF method)
(VMDescription method)
get_input() (CLI method)
(UI method)
get_item_count() (OVFHardware method)
get_item_count_per_profile() (OVFHardware method)
get_nic_count() (OVF method)
(VMDescription method)
get_ns() (COT.xml_file.XML class method)
get_password() (CLI method)
(UI method)
get_path_from_file() (OVF method)
(VMDescription method)
get_property_value() (OVF method)
(VMDescription method)
get_serial_count() (OVF method)
(VMDescription method)
get_subtype_from_device() (OVF method)
(VMDescription method)
get_type_from_device() (OVF method)
(VMDescription method)
get_value() (OVFItem method)
guess_nic_name() (COT.platforms.CSR1000V class method)
(COT.platforms.GenericPlatform class method)
(COT.platforms.IOSXRv class method)
(COT.platforms.IOSXRvLC class method)
(COT.platforms.IOSXRvRP class method)
(COT.platforms.IOSv class method)
(COT.platforms.NXOSv class method)
H
has_profile() (OVFItem method)
Helper (class in COT.helpers.helper)
HelperError
HelperNotFoundError
hypervisor (COTDeploy attribute)
I
ide_subtype (COTEditHardware attribute)
info_string() (OVF method)
(VMDescription method)
input_file (VMDescription attribute)
install_helper() (COTInstallHelpers method)
(FatDisk method)
(Helper method)
(MkIsoFS method)
(OVFTool method)
(QEMUImg method)
(VmdkTool method)
install_manpages() (COTInstallHelpers method)
InvalidInputError
IOSv (class in COT.platforms)
IOSXRv (class in COT.platforms)
IOSXRvLC (class in COT.platforms)
IOSXRvRP (class in COT.platforms)
L
LITERAL_CLI_STRING (CSR1000V attribute)
(GenericPlatform attribute)
(IOSXRv attribute)
(IOSv attribute)
(NXOSv attribute)
locator (COTDeployESXi attribute)
M
mac_address() (in module COT.data_validation)
mac_addresses_list (COTEditHardware attribute)
main() (CLI method)
(in module COT.cli)
match_or_die() (in module COT.data_validation)
memory (COTEditHardware attribute)
MkIsoFS (class in COT.helpers.mkisofs)
N
name (Helper attribute)
(MkIsoFS attribute)
natural_sort() (in module COT.data_validation)
network_map (COTDeploy attribute)
networks (OVF attribute)
(VMDescription attribute)
new_item() (OVFHardware method)
nic_names (COTEditHardware attribute)
nic_networks (COTEditHardware attribute)
nic_type (COTEditHardware attribute)
nics (COTEditHardware attribute)
no_whitespace() (in module COT.data_validation)
non_negative_int() (in module COT.data_validation)
NXOSv (class in COT.platforms)
O
output (COTSubmodule attribute)
output_file (OVF attribute)
(VMDescription attribute)
OVF (class in COT.ovf)
OVFHardware (class in COT.ovf)
OVFHardwareDataError (class in COT.ovf)
OVFItem (class in COT.ovf)
OVFItemDataError (class in COT.ovf)
OVFNameHelper (class in COT.ovf)
OVFTool (class in COT.helpers.ovftool)
ovftool_args (COTDeployESXi attribute)
P
package (COTReadOnlySubmodule attribute)
(COTSubmodule attribute)
package_list (COTInfo attribute)
PACKAGE_MANAGERS (Helper attribute)
parse_args() (CLI method)
password (COTDeploy attribute)
path (Helper attribute)
(MkIsoFS attribute)
platform (OVF attribute)
(VMDescription attribute)
PLATFORM_NAME (CSR1000V attribute)
(GenericPlatform attribute)
(IOSXRv attribute)
(IOSXRvLC attribute)
(IOSXRvRP attribute)
(IOSv attribute)
(NXOSv attribute)
port_install() (COT.helpers.helper.Helper class method)
positive_int() (in module COT.data_validation)
power_on (COTDeploy attribute)
profile_info_list() (OVF method)
profile_info_string() (OVF method)
(VMDescription method)
profiles (COTEditHardware attribute)
properties (COTEditProperties attribute)
Q
QEMUImg (class in COT.helpers.qemu_img)
R
read_xml() (XML method)
ready_to_run() (COTAddDisk method)
(COTAddFile method)
(COTDeploy method)
(COTDeployESXi method)
(COTEditHardware method)
(COTEditProduct method)
(COTGenericSubmodule method)
(COTInfo method)
(COTInjectConfig method)
(COTReadOnlySubmodule method)
(COTSubmodule method)
register_namespace() (XML method)
remove_profile() (OVFItem method)
run() (CLI method)
(COTAddDisk method)
(COTAddFile method)
(COTDeployESXi method)
(COTEditHardware method)
(COTEditProduct method)
(COTEditProperties method)
(COTGenericSubmodule method)
(COTHelp method)
(COTInfo method)
(COTInjectConfig method)
(COTInstallHelpers method)
(COTSubmodule method)
S
scsi_subtype (COTEditHardware attribute)
search_from_controller() (OVF method)
(VMDescription method)
search_from_file_id() (OVF method)
(VMDescription method)
search_from_filename() (OVF method)
(VMDescription method)
secondary_config_file (COTInjectConfig attribute)
SECONDARY_CONFIG_TEXT_FILE (GenericPlatform attribute)
(IOSXRv attribute)
(IOSXRvLC attribute)
serial_connectivity (COTEditHardware attribute)
serial_ports (COTEditHardware attribute)
set_capacity_of_disk() (OVF method)
set_cpu_count() (OVF method)
(VMDescription method)
set_ide_subtype() (OVF method)
(VMDescription method)
set_item_count_per_profile() (OVFHardware method)
set_item_values_per_profile() (OVFHardware method)
set_memory() (OVF method)
(VMDescription method)
set_nic_count() (OVF method)
(VMDescription method)
set_nic_mac_addresses() (OVF method)
(VMDescription method)
set_nic_names() (OVF method)
(VMDescription method)
set_nic_networks() (OVF method)
(VMDescription method)
set_nic_type() (OVF method)
(VMDescription method)
set_or_make_child() (COT.xml_file.XML class method)
set_property() (OVFItem method)
set_property_value() (OVF method)
(VMDescription method)
set_scsi_subtype() (OVF method)
(VMDescription method)
set_serial_connectivity() (OVF method)
(VMDescription method)
set_serial_count() (OVF method)
(VMDescription method)
set_value_for_all_items() (OVFHardware method)
set_verbosity() (CLI method)
strip_ns() (COT.xml_file.XML class method)
subcommand (COTHelp attribute)
subparsers (COTDeploy attribute)
subtype (COTAddDisk attribute)
system_types (OVF attribute)
(VMDescription attribute)
T
tar() (OVF method)
terminal_width (CLI attribute)
(UI attribute)
to_string() (in module COT.data_validation)
type (COTAddDisk attribute)
U
UI (class in COT.ui_shared)
(COTGenericSubmodule attribute)
untar() (OVF method)
update_xml() (OVFHardware method)
username (COTDeploy attribute)
V
valid_list_only() (COT.platforms.GenericPlatform class method)
validate() (OVFItem method)
validate_controller_address() (COTAddDisk method)
validate_cpu_count() (COT.platforms.CSR1000V class method)
(COT.platforms.GenericPlatform class method)
(COT.platforms.IOSXRv class method)
(COT.platforms.IOSv class method)
(COT.platforms.NXOSv class method)
validate_int() (in module COT.data_validation)
validate_memory_amount() (COT.platforms.CSR1000V class method)
(COT.platforms.GenericPlatform class method)
(COT.platforms.IOSXRv class method)
(COT.platforms.IOSv class method)
(COT.platforms.NXOSv class method)
validate_nic_count() (COT.platforms.CSR1000V class method)
(COT.platforms.GenericPlatform class method)
(COT.platforms.IOSXRv class method)
(COT.platforms.IOSXRvRP class method)
(COT.platforms.IOSv class method)
validate_nic_type() (COT.platforms.GenericPlatform class method)
(COT.platforms.IOSXRv class method)
(COT.platforms.IOSv class method)
(COT.platforms.NXOSv class method)
validate_ovf() (OVFTool method)
validate_serial_count() (COT.platforms.CSR1000V class method)
(COT.platforms.GenericPlatform class method)
(COT.platforms.IOSXRv class method)
(COT.platforms.IOSXRvLC class method)
(COT.platforms.IOSv class method)
(COT.platforms.NXOSv class method)
ValueMismatchError
ValueTooHighError
ValueTooLowError
ValueUnsupportedError
verbosity (COTInfo attribute)
verbosity_options (VMDescription attribute)
version (COTEditProduct attribute)
(Helper attribute)
version_long (OVF attribute)
(VMDescription attribute)
version_short (OVF attribute)
(VMDescription attribute)
virtual_system_type (COTEditHardware attribute)
vm (COTGenericSubmodule attribute)
vm_name (COTDeploy attribute)
VMContextManager (class in COT.vm_context_manager)
VMDescription (class in COT.vm_description)
VmdkTool (class in COT.helpers.vmdktool)
VMFactory (class in COT.vm_factory)
VMInitError
W
write() (OVF method)
(VMDescription method)
write_xml() (XML method)
X
XML (class in COT.xml_file)
xml_reindent() (XML method)
Y
yum_install() (COT.helpers.helper.Helper class method)
Read the Docs
v: v1.3.0
Versions
latest
stable
develop
v1.3.0
v1.2.4
v1.2.3
v1.2.2
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.