Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 1067165

Summary:	Some capabilities not documented
Product:	Red Hat Enterprise Virtualization Manager	Reporter:	Thom Carlin <tcarlin>
Component:	Documentation	Assignee:	Andrew Dahms <adahms>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Lucy Bopf <lbopf>
Severity:	unspecified	Docs Contact:
Priority:	unspecified
Version:	3.3.0	CC:	acathrow, bazulay, gklein, juwu, sgordon, yeylon
Target Milestone:	---
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:	Build Name: 12978, Developer Guide-3.3-1 Build Date: 09-01-2014 10:14:45 Topic ID: 8599-563585 [Latest]
Last Closed:	2014-07-18 01:19:04 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:
Bug Depends On:
Bug Blocks:	1054973

Description Thom Carlin 2014-02-19 21:08:10 UTC

Title: Capabilities

Describe the issue:

Capabilities not documented

Suggestions for improvement:

Add documentation for missing types/states

Additional information:

Doing a simple compare, came up with the following list.  Some may already be in Appendix D.  From https://rhevm_url/api/capabilities for RHEV 3.3:
[...]
<configuration_types>
<configuration_type>ovf</configuration_type>
</configuration_types>
[...]
<creation_states>
<creation_state>pending</creation_state>
<creation_state>in_progress</creation_state>
<creation_state>complete</creation_state>
<creation_state>failed</creation_state>
</creation_states>
<power_management_states>
<power_management_state>on</power_management_state>
<power_management_state>off</power_management_state>
<power_management_state>unknown</power_management_state>
</power_management_states>
<host_states>
<host_state>down</host_state>
<host_state>error</host_state>
<host_state>initializing</host_state>
<host_state>installing</host_state>
<host_state>install_failed</host_state>
<host_state>maintenance</host_state>
<host_state>non_operational</host_state>
<host_state>non_responsive</host_state>
<host_state>pending_approval</host_state>
<host_state>preparing_for_maintenance</host_state>
<host_state>connecting</host_state>
<host_state>reboot</host_state>
<host_state>unassigned</host_state>
<host_state>up</host_state>
</host_states>
<host_non_operational_details>
<host_non_operational_detail>none</host_non_operational_detail>
<host_non_operational_detail>general</host_non_operational_detail>
<host_non_operational_detail>cpu_type_incompatible_with_cluster</host_non_operational_detail>
<host_non_operational_detail>storage_domain_unreachable</host_non_operational_detail>
<host_non_operational_detail>network_unreachable</host_non_operational_detail>
<host_non_operational_detail>version_incompatible_with_cluster</host_non_operational_detail>
<host_non_operational_detail>kvm_not_running</host_non_operational_detail>
<host_non_operational_detail>timeout_recovering_from_crash</host_non_operational_detail>
<host_non_operational_detail>vm_network_is_bridgeless</host_non_operational_detail>
<host_non_operational_detail>gluster_command_failed</host_non_operational_detail>
<host_non_operational_detail>gluster_host_uuid_not_found</host_non_operational_detail>
<host_non_operational_detail>emulated_machines_incompatible_with_cluster</host_non_operational_detail>
<host_non_operational_detail>untrusted</host_non_operational_detail>
<host_non_operational_detail>uninitialized</host_non_operational_detail>
<host_non_operational_detail>cluster_version_incompatible_with_cluster</host_non_operational_detail>
</host_non_operational_details>
<network_states>
<network_state>operational</network_state>
<network_state>non_operational</network_state>
</network_states>
<storage_domain_states>
<storage_domain_state>active</storage_domain_state>
<storage_domain_state>inactive</storage_domain_state>
<storage_domain_state>locked</storage_domain_state>
<storage_domain_state>mixed</storage_domain_state>
<storage_domain_state>unattached</storage_domain_state>
<storage_domain_state>maintenance</storage_domain_state>
<storage_domain_state>unknown</storage_domain_state>
</storage_domain_states>
<template_states>
<template_state>illegal</template_state>
<template_state>locked</template_state>
<template_state>ok</template_state>
</template_states>
<vm_states>
<vm_state>unassigned</vm_state>
<vm_state>down</vm_state>
<vm_state>up</vm_state>
<vm_state>powering_up</vm_state>
<vm_state>paused</vm_state>
<vm_state>migrating</vm_state>
<vm_state>unknown</vm_state>
<vm_state>not_responding</vm_state>
<vm_state>wait_for_launch</vm_state>
<vm_state>reboot_in_progress</vm_state>
<vm_state>saving_state</vm_state>
<vm_state>restoring_state</vm_state>
<vm_state>suspended</vm_state>
<vm_state>image_locked</vm_state>
<vm_state>powering_down</vm_state>
</vm_states>
<vm_pause_details>
<vm_pause_detail>none</vm_pause_detail>
<vm_pause_detail>eother</vm_pause_detail>
<vm_pause_detail>eio</vm_pause_detail>
<vm_pause_detail>enospc</vm_pause_detail>
<vm_pause_detail>eperm</vm_pause_detail>
<vm_pause_detail>noerr</vm_pause_detail>
</vm_pause_details>
<disk_states>
<disk_state>illegal</disk_state>
<disk_state>locked</disk_state>
<disk_state>ok</disk_state>
</disk_states>
<host_nic_states>
<host_nic_state>down</host_nic_state>
<host_nic_state>up</host_nic_state>
</host_nic_states>
<data_center_states>
<data_center_state>uninitialized</data_center_state>
<data_center_state>up</data_center_state>
<data_center_state>maintenance</data_center_state>
<data_center_state>not_operational</data_center_state>
<data_center_state>problematic</data_center_state>
<data_center_state>contend</data_center_state>
</data_center_states>
[...]
<usages>
<usage>display</usage>
<usage>vm</usage>
<usage>migration</usage>
</usages>
<nfs_versions>
<nfs_version>auto</nfs_version>
<nfs_version>v3</nfs_version>
<nfs_version>v4</nfs_version>
</nfs_versions>
<pm_proxy_types>
<type>cluster</type>
<type>dc</type>
</pm_proxy_types>
<cpu_modes>
<cpu_mode>custom</cpu_mode>
<cpu_mode>host_model</cpu_mode>
<cpu_mode>host_passthrough</cpu_mode>
</cpu_modes>
<sgio_options>
<sgio_options>filtered</sgio_options>
<sgio_options>unfiltered</sgio_options>
</sgio_options>
[...]
<authentication_methods>
<authentication_method>password</authentication_method>
<authentication_method>publickey</authentication_method>
</authentication_methods>
<step_types>
<step_type>validating</step_type>
<step_type>executing</step_type>
<step_type>finalizing</step_type>
<step_type>unknown</step_type>
</step_types>
<payload_encodings>
<payload_encodings>base64</payload_encodings>
<payload_encodings>plaintext</payload_encodings>
</payload_encodings>
[...]
<brick_states>
<state>up</state>
<state>down</state>
</brick_states>
<reported_device_types>
<reported_device_type>network</reported_device_type>
</reported_device_types>
<ip_versions>
<ip_version>v4</ip_version>
<ip_version>v6</ip_version>
</ip_versions>
<snapshot_statuses>
<snapshot_status>ok</snapshot_status>
<snapshot_status>locked</snapshot_status>
<snapshot_status>in_preview</snapshot_status>
</snapshot_statuses>
<content_types>
<content_type>text</content_type>
<content_type>binary</content_type>
</content_types>
<hook_states>
<hook_state>enabled</hook_state>
<hook_state>disabled</hook_state>
<hook_state>missing</hook_state>
</hook_states>
<stages>
<stage>pre</stage>
<stage>post</stage>
</stages>

Comment 1 Andrew Dahms 2014-02-25 22:07:25 UTC

Documentation Link
------------------------------
http://documentation-devel.engineering.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.3/html-single/Developer_Guide/index.html#Capabilities

What Changed
------------------------------
The following topics were added to the Capabilities chapter so that all capabilities would be documented.

Creation States [ 28686 ]
Power Management States [ 28687 ]
Host States [ 28688 ]
Host Non-Operational Details [ 28689 ]
Network States [ 28690 ]
Storage Domain States [ 28691 ]
Template States [ 28692 ]
Virtual Machine States [ 28693 ]
Virtual Machine Pause Details [ 28694 ]
Disk States [ 28695 ]
Host Network Interface Card States [ 28696 ]
Data Center States [ 28697 ]
Virtual Machine Device Types [ 28697 ]
Configuration Types [ 28698 ]
Usages [ 28699 ]
NFS Versions [ 28700 ]
Power Management Proxy Types [ 28717 ]
CPU Modes [ 28718 ]
SCSI Generio I/O Options [ 28719 ]
Authentication Methods [ 28720 ]
Step Types [ 28721 ]
Payload Encodings [ 28722 ]
Gluster Volume Types [ 28723 ]
Transport Types [ 28724 ]
Gluster Volume States [ 28725 ]
Brick States [ 28726 ]
Reported Device Types [ 28727 ]
IP Versions [ 28728 ]
Snapshot Status [ 28729 ]
Content Types [ 28730 ]
Hook States [ 28731 ]
Stages [ 28732 ]

I also removed one topic [ 7954 ] from this same chapter that previously acted as a catch all that listed the above states by name only. Because each of the states now has its own topic, this topic was no longer necessary.

Updated revision history: [ 21132-593250 ]

NVR
------------------------------
Red_Hat_Enterprise_Virtualization-Developer_Guide-3.3-en-US-3.3-24

Moving to ON_QA.

Comment 2 Lucy Bopf 2014-07-18 01:19:04 UTC

Peer reviewed.

The changes listed in Comment 1 are now live in the 3.3 docs. (They also persist in the more recent 3.4 Technical Guide.)

VERIFIED.