Appendix A. Objects
A.1. Virtual Machine Properties
When using these items in a method, prefix them with vm.. For example: vm.storage_id.
Table A.1. Virtual Machine Properties
| Friendly Name or Description | Raw Column Name |
|---|---|
| Allocated Disk Storage | allocated_disk_storage |
| Autostart | autostart |
| Blackbox Exists | blackbox_exists |
| Blackbox Validated | blackbox_validated |
| Boot Time | boot_time |
| Busy | busy |
| Cluster | ems_cluster_name |
| Configuration XML | config_xml |
| Connection State | connection_state |
| CPU Affinity | cpu_affinity |
| CPU Limit | cpu_limit |
| CPU Reserve | cpu_reserve |
| CPU Reserve Expand | cpu_reserve_expand |
| CPU Shares | cpu_shares |
| CPU Shares Level | cpu_shares_level |
| Created on Time | ems_created_on |
| Currently Used Space | used_storage_by_state |
| Datastore Path | v_datastore_path |
| Date Created | created_on |
| Date Updated | updated_on |
| Description | description |
| Ems | ems_id |
| Evm Owner | evm_owner_id |
| Evm Owner Email | evm_owner_email |
| Evm Owner Name | evm_owner_name |
| CloudForms Management Engine Unique ID (Guid) | guid |
| Format | format |
| Host | host_id |
| Host Name | host_name |
| Id | id |
| Is a Template | v_is_a_template |
| Last Analysis Attempt On | last_scan_attempt_on |
| Last Analysis Time | last_scan_on |
| Last Compliance Status | last_compliance_status |
| Last Compliance Timestamp | last_compliance_timestamp |
| Last Perf Capture On | last_perf_capture_on |
| Last Sync Time | last_sync_on |
| Location | location |
| Memory Limit | memory_limit |
| Memory Reserve | memory_reserve |
| Memory Reserve Expand | memory_reserve_expand |
| Memory Shares | memory_shares |
| Memory Shares Level | memory_shares_level |
| Name | name |
| OS Name | os_image_name |
| Owner | owner |
| Paravirtualization | paravirtualization |
| Parent Cluster | v_owning_cluster |
| Parent Datacenter | v_owning_datacenter |
| Parent Folder (Hosts & Clusters) | v_owning_folder |
| Parent Folder (VMs & Templates) | v_owning_blue_folder |
| Parent Folder Path (Hosts & Clusters) | v_owning_folder_path |
| Parent Folder Path (VMs & Templates) | v_owning_blue_folder_path |
| Parent Host Platform | v_host_vmm_product |
| Parent Resource Pool | v_owning_resource_pool |
| Pct Free Disk | v_pct_free_disk_space |
| Platform | platform |
| Power State | power_state |
| Previous State | previous_state |
| Registered | registered |
| Reserved | reserved |
| Retired | retired |
| Retirement | retirement |
| Retires On | retires_on |
| Service | service_id |
| Smart | smart |
| Standby Action | standby_action |
| State Changed On | state_changed_on |
| Storage | storage_id |
| Storage Name | storage_name |
| Template | template |
| Thin Provisioned | thin_provisioned |
| Tools Status | tools_status |
| Total Provisioned Space | provisioned_storage |
| Total Snapshots | v_total_snapshots |
| Total Used Disk Space | used_disk_storage |
| Uid Ems | uid_ems |
| Uncommitted Space | uncommitted_storage |
| Used Storage | used_storage |
| V Pct Used Disk Space | v_pct_used_disk_space |
| VDI Available | vdi_available |
| VDI Connection DNS Name | vdi_connection_dns_name |
| VDI Connection Logon Server | vdi_connection_logon_server |
| VDI Connection Name | vdi_connection_name |
| VDI Connection Remote IP Address | vdi_connection_remote_ip_address |
| VDI Connection Session Name | vdi_connection_session_name |
| VDI Connection Session Type | vdi_connection_session_type |
| VDI Connection URL | vdi_connection_url |
| VDI Endpoint IP Address | vdi_endpoint_ip_address |
| VDI Endpoint MAC Address | vdi_endpoint_mac_address |
| VDI Endpoint Name | vdi_endpoint_name |
| VDI Endpoint Type | vdi_endpoint_type |
| VDI User Appdata | vdi_user_appdata |
| VDI User DNS Domain | vdi_user_dns_domain |
| VDI User Domain | vdi_user_domain |
| VDI User Home Drive | vdi_user_home_drive |
| VDI User Home Path | vdi_user_home_path |
| VDI User Home Share | vdi_user_home_share |
| VDI User Logon Time | vdi_user_logon_time |
| VDI User Name | vdi_user_name |
| Vendor | vendor |
| Version | version |
| VMsafe Agent Address | vmsafe_agent_address |
| VMsafe Agent Port | vmsafe_agent_port |
| VMsafe Enable | vmsafe_enable |
| VMsafe Fail Open | vmsafe_fail_open |
| VMsafe Immutable VM | vmsafe_immutable_vm |
| VMsafe Timeout (ms) | vmsafe_timeout_ms |
A.2. CloudForms Management Engine Methods for use in Ruby Scripts
To use one of these in one of your own Ruby methods, use the syntax of vm.method. For example, to reboot the guest operating system, use vm.rebootGuest.
| Method | Description |
|---|---|
| start | Start Virtual Machine container. |
| stop | Stop Virtual Machine container. |
| suspend | Suspend Virtual Machine container. |
| unregister | Unregister Virtual Machine. |
| collect_running_processes | Collect the running processes from a started Virtual Machine. |
| shutdownGuest | Shutdown the guest operating system of the VM container. Requires VMware tools (or vendors tools) installed on the guest. |
| standbyGuest | Put the guest operating system into standby. Requires VMware tools (or vendors tools) installed on the guest. |
| rebootGuest | Reboot the guest operating system. Requires VMware tools (or vendors tools) installed on the guest. |
A.3. Host Properties
When using these items in a method, prefix them with host, such as host.ems_id.
| Friendly Name or Description | Raw Column Name |
|---|---|
| All Enabled Ports | all_enabled_ports |
| Annotation | v_annotation |
| Authentication Status | Authentication_status |
| Connection State | connection_state |
| CPU usage MHz rate average over time period | cpu_usagemhz_rate_average_avg_over_time_period |
| CPU usage MHz rate high over time period | cpu_usagemhz_rate_average_high_over_time_period |
| CPU usage MHz rate low over time period | cpu_usagemhz_rate_average_low_over_time_period |
| Custom Attribute 1 | custom_1 |
| Custom Attribute 2 | custom_2 |
| Custom Attribute 3 | custom_3 |
| Custom Attribute 4 | custom_4 |
| Custom Attribute 5 | custom_5 |
| Custom Attribute 6 | custom_6 |
| Custom Attribute 7 | custom_7 |
| Custom Attribute 8 | custom_8 |
| Custom Attribute 9 | custom_9 |
| Date Created | created_on |
| Derived memory usage average over time period | derived_memory_used_avg_over_time_period |
| Derived memory usage high over time period | derived_memory_used_high_over_time_period |
| Derived memory usage low over time period | derived_memory_used_low_over_time_period |
| Ems | ems_id |
| Enabled Inbound Ports | enabled_inbound_ports |
| Enabled Outbound Ports | enabled_outbound_ports |
| Enabled Run Level 0 Services | enabled_run_level_0_services |
| Enabled Run Level 1 Services | enabled_run_level_1_services |
| Enabled Run Level 2 Services | enabled_run_level_2_services |
| Enabled Run Level 3 Services | enabled_run_level_3_services |
| Enabled Run Level 4 Services | enabled_run_level_4_services |
| Enabled Run Level 5 Services | enabled_run_level_5_services |
| Enabled Run Level 6 Services | enabled_run_level_6_services |
| Enabled TCP Inbound Ports | enabled_tcp_inbound_ports |
| Enabled TCP Outbound Ports | enabled_tcp_outbound_ports |
| Enabled UDP Inbound Ports | enabled_udp_inbound_ports |
| Enabled UDP Outbound Ports | enabled_udp_outbound_ports |
| EVM Unique ID (Guid) | guid |
| Hostname | hostname |
| Id | id |
| IP Address | ipaddress |
| Last Compliance Status | last_compliance_status |
| Last Compliance Timestamp | last_compliance_timestamp |
| Last Perf Capture On | last_perf_capture_on |
| Last Analysis Time | last_scan_on |
| Name | name |
| OS Name | os_image_name |
| Platform | platform |
| Power State | power_state |
| Region Description | region_description |
| Region Number | region_number |
| Reserved | reserved |
| Service Names | service_names |
| Settings | settings |
| Smart | smart |
| SSH Root Access | ssh_permit_root_login |
| Uid Ems | uid_ems |
| Date Updated | updated_on |
| User Assigned Os | user_assigned_os |
| Parent Cluster | v_owning_cluster |
| Parent Datacenter | v_owning_datacenter |
| Parent Folder (Hosts & Clusters) | v_owning_folder |
| Total Datastores | v_total_storages |
| Total VMs | v_total_vms |
| VMM Build Number | vmm_buildnumber |
| VMM Platform | vmm_product |
| VMM Vendor | vmm_vendor |
| VMM Version | vmm_version |
A.4. Provider Properties
When using these items in a method, prefix them with ems, such as ems.ems_id.
| Friendly Name or Description | Raw Column Name |
|---|---|
| Aggregate VM CPUs | aggregate_vm_cpus |
| Aggregate VM Memory | aggregate_vm_memory |
| CPU Ratio | v_cpu_vr_ratio |
| CPU Usage MHZ Rate Average High Over Time Period | cpu_usagemhz_rate_average_high_over_time_period" |
| CPU Usage MHZ Rate Average Low Over Time Period | cpu_usagemhz_rate_average_low_over_time_period |
| CPU Usage MHZ Rate Average Over Time Period | cpu_usagemhz_rate_average_avg_over_time_period |
| Date Created | created_on |
| Date Updated | updated_on |
| Derived Memory Usage Rate Average High Over Time Period | derived_memory_used_high_over_time_period |
| Derived Memory Usage Rate Average Low Time Period | derived_memory_used_low_over_time_period |
| Derived Memory Usage Rate Average Over Time Period | derived_memory_used_avg_over_time_period |
| Distributed Resource Scheduler Automation Level | drs_automation_level |
| Distributed Resource Scheduler Enabled | drs_enabled |
| Distributed Resource Scheduler Migration Threshold | drs_migration_threshold |
| EMS ID | ems_id |
| EVM Zone | zone_name |
| High-Availability Admission Control | ha_admit_control |
| High-Availability Enabled | ha_enabled |
| High-Availability Max Failures | ha_max_failures |
| Id | id |
| Last Performance Data Captured | last_perf_capture_on |
| Last Smart State Analysis | last_scan_on |
| Memory Ratio | v_ram_vr_ratio |
| Name | name |
| Parent Datacenter | v_parent_datacenter |
| Qualified Description | v_qualified_desc |
| Region Description | region_description |
| Region Number | region_number |
| Reserved | reserved |
| Total CPU Speed | aggregate_cpu_speed |
| Total Hosts | total_hosts |
| Total Memory | aggregate_memory |
| Total Number of Logical CPUs | aggregate_logical_cpus |
| Total Number of Physical CPUs | aggregate_physical_cpus |
| Total Vms | total_vms |
| Unique Identifier | uid_ems |
A.5. Storage Properties
When using these items in a method, prefix them with storage, such as storage.name.
Table A.2. Storage Properties
| Friendly Name or Description | Raw Column Name |
|---|---|
| Date Created | created_on |
| Date Updated | updated_on |
| Disk Files Percent of Used | v_disk_percent_of_used |
| Free Space | free_space |
| Free Space Percent of Total | v_free_space_percent_of_total |
| Id | id |
| Last Analysis Time | last_scan_on |
| Last Perf Capture On | last_perf_capture_on |
| Location | location |
| Multiple Host Access | multiplehostaccess |
| Name | name |
| Non-VM Files Percent of Used | v_debris_percent_of_used |
| Other VM Files Percent of Used | v_vm_misc_percent_of_used |
| Provisioned Space Percent of Total | v_provisioned_percent_of_total |
| Reserved | reserved |
| Size of Non-VM Files | v_total_debris_size |
| Size of Other VM Files | v_total_vm_misc_size |
| Size of VM Memory Files | v_total_vm_ram_size |
| Size of VM Snapshot Files | v_total_snapshot_size |
| Snapshot Files Percent of Used | v_snapshot_percent_of_used |
| Store Type | store_type |
| Total Hosts | v_total_hosts |
| Total Managed Registered Vms | total_managed_registered_vms |
| Total Managed Unregistered Vms | total_managed_unregistered_vms |
| Total Provisioned Space | v_total_provisioned |
| Total Space | total_space |
| Total Unmanaged Vms | total_unmanaged_vms |
| Total VMs | v_total_vms |
| Uncommitted | uncommitted |
| Used Space | v_used_space |
| Used Space Percent of Total | v_used_space_percent_of_total |
| VM Memory Files Percent of Used | v_memory_percent_of_used |
Where did the comment section go?
Red Hat's documentation publication system recently went through an upgrade to enable speedier, more mobile-friendly content. We decided to re-evaluate our commenting platform to ensure that it meets your expectations and serves as an optimal feedback mechanism. During this redesign, we invite your input on providing feedback on Red Hat documentation via the discussion platform.