Automate Model. ManageIQ 6.0 5.2

ManageIQ 6.0 Management Engine 5.2 Lifecycle and Automation Guide

Automate Model

This appendix lists the Namespaces, Classes, Methods, and Instances for the Automate Model. The

Namespace hierarchy for the model is defined as follows:

Alert

Automation

EVMApplications

Operations

Profile

Provisioning

Profile

Factory

StateMachines

Integration

MIQ_IPAM

Sample

System

B.1. Namespace: Alert

Class: Email Notifications (EmailNotifications)

Instance: (MiqHostProvisionRequest_Approved)

Contains configurable parameters for the MiqHostProvisionRequest_Approved method.

to_email_address - used to specify an email address in the case where vm's owner does not have an email address. To specify more than one email address, separate email addresses with commas.

from_email_address - used to specify an email address in the event the requester replies to the email.

signature - used to stamp the email with a custom signature.

Instance: (MiqHostProvisionRequest_Complete)

Contains configurable parameters for the MiqHostProvisionRequest_Complete method.

to_email_address - used to specify an email address in the case where vm's owner does not have an email address. To specify more than one email address, separate email addresses with commas.

from_email_address - used to specify an email address in the event the requester replies to the email.

94

Automate Model signature - used to stamp the email with a custom signature.

Instance: (MiqProvisionRequest_Approved)

Contains configurable parameters for the MiqProvisionRequest_Approved method.

to_email_address - used to specify an email address in the case where vm's owner does not have an email address. To specify more than one email address, separate email addresses with commas.

from_email_address - used to specify an email address in the event the requester replies to the email.

signature - used to stamp the email with a custom signature.

Instance: (MiqProvisionRequest_Denied)

Contains configurable parameters for the MiqProvisionRequest_Denied method.

to_email_address - used to specify an email address in the case where vm's owner does not have an email address. To specify more than one email address, separate email addresses with commas.

from_email_address - used to specify an email address in the event the requester replies to the email.

signature - used to stamp the email with a custom signature.

Instance: (MiqProvisionRequest_Pending)

Contains configurable parameters for the MiqProvisionRequest_Pending method.

to_email_address - used to specify an email address in the case where vm's owner does not have an email address. To specify more than one email address, separate email addresses with commas.

from_email_address - used to specify an email address in the event the requester replies to the email.

signature - used to stamp the email with a custom signature.

Instance: (MiqProvision_Complete)

Contains configurable parameters for the MiqProvision_Complete method.

to_email_address - used to specify an email address in the case where vm's owner does not have an email address. To specify more than one email address, separate email addresses with commas.

from_email_address - used to specify an email address in the event the requester replies to the email.

signature - used to stamp the email with a custom signature.

Instance: (ServiceProvision_Complete)

Contains configurable parameters for the ServiceProvision_Complete method.

to_email_address - used to specify an email address in the case where vm's owner does not have an email address. To specify more than one email address, separate email addresses with

95

ManageIQ 6.0 Management Engine 5.2 Lifecycle and Automation Guide commas.

from_email_address - used to specify an email address in the event the requester replies to the email.

signature - used to stamp the email with a custom signature.

Instance: (ServiceTemplateProvisionRequest_Approved)

Contains configurable parameters for the MiqProvisionRequest_Approved method.

to_email_address - used to specify an email address in the case where vm's owner does not have an email address. To specify more than one email address, separate email addresses with commas.

from_email_address - used to specify an email address in the event the requester replies to the email.

signature - used to stamp the email with a custom signature.

Instance: (VmMigrateRequest_Approved)

Contains configurable parameters for the VmMigrateRequest_Approved method.

to_email_address - used to specify an email address in the case where vm's owner does not have an email address. To specify more than one email address, separate email addresses with commas.

from_email_address - used to specify an email address in the event the requester replies to the email.

signature - used to stamp the email with a custom signature.

Instance: (VmMigrateTask_Complete)

Contains configurable parameters for the VmMigrateTask_Complete method.

to_email_address - used to specify an email address in the case where vm's owner does not have an email address. To specify more than one email address, separate email addresses with commas.

from_email_address - used to specify an email address in the event the requester replies to the email.

signature - used to stamp the email with a custom signature.

Instance: (vm_retire_extend)

Contains configurable parameters for the vm_retire_extend method.

to_email_address - used to specify an email address in the case where vm's owner does not have an email address. To specify more than one email address, separate email addresses with commas.

from_email_address - used to specify an email address in the event the requester replies to the email.

signature - used to stamp the email with a custom signature.

vm_retire_extend - number of days to extend retirement.

96

Automate Model

Instance: (vm_retirement_emails)

Contains configurable parameters for the vm_retirement_emails method.

to_email_address - used to specify an email address in the case where vm's owner does not have an email address. To specify more than one email address, separate email addresses with commas.

from_email_address - used to specify an email address in the event the requester replies to the email.

signature - used to stamp the email with a custom signature.

Method: (MiqHostProvisionRequest_Approved)

This method is used to email the provision requester that the Host provisioning request has been approved.

Method: (MiqHostProvisionRequest_Complete)

This method sends an email when the host_provisioned event is raised.

Method: (MiqProvisionRequest_Approved)

This method is used to email the provision requester that the VM provisioning request has been approved.

Method: (MiqProvisionRequest_Denied)

This method is used to email the provision requester and approver that the VM provisioning request has been denied.

Method: (MiqProvisionRequest_Pending)

This method is launched from the not_approved method which raises the requst_pending event when the provisioning request is NOT auto-approved.

Method: (MiqProvision_Complete)

This method sends an email when the vm_provisioned event is raised.

Method: (ServiceProvision_Complete)

This method sends an email when the service_provisioned event is raised.

Method: (ServiceTemplateProvisionRequest_Approved)

This method is used to email the provision requester that the Service provisioning request has been approved.

Method: (VmMigrateRequest_Approved)

This method is used to email the provision requester that the VM Migrate request has been approved.

Method: (VmMigrateTask_Complete)

This method sends an email when the VmMigrateTask-Complete event is raised.

Method: (vm_retire_extend)

97

ManageIQ 6.0 Management Engine 5.2 Lifecycle and Automation Guide

This method is used to add 14 days to retirement date when target VM has a retires_on value and is not already retired.

Method: (vm_retirement_emails)

This method sends out retirement emails when the following events are raised: vm_retire_warn, vm_retired, vm_entered_retirement

Class: General Email Alerts (Email_Alerts)

Instance: (EMS_Cluster_Alert)

Contains configurable parameters for the EMS_Cluster_Alert method.

to_email_address - used to specify an email address in the case where vm's owner does not have an email address. To specify more than one email address, separate email addresses with commas.

from_email_address - used to specify an email address in the event the requester replies to the email.

signature - used to stamp the email with a custom signature.

Instance: (Ext_Management_System_Alert)

Contains configurable parameters for the Ext_Management_System _Alert method.

to_email_address - used to specify an email address in the case where vm's owner does not have an email address. To specify more than one email address, separate email addresses with commas.

from_email_address - used to specify an email address in the event the requester replies to the email.

signature - used to stamp the email with a custom signature.

Instance: (Host_Alert)

Contains configurable parameters for the Host_Alert method.

to_email_address - used to specify an email address in the case where vm's owner does not have an email address. To specify more than one email address, separate email addresses with commas.

from_email_address - used to specify an email address in the event the requester replies to the email.

signature - used to stamp the email with a custom signature.

Instance: (MIQ_Server_Alert)

Contains configurable parameters for the MIQ_Server_Alert method.

to_email_address - used to specify an email address in the case where vm's owner does not have an email address. To specify more than one email address, separate email addresses with commas.

from_email_address - used to specify an email address in the event the requester replies to the email.

98

Automate Model signature - used to stamp the email with a custom signature.

Instance: (Parse_Alerts)

Contains configurable parameters for the Parse_Alerts method.

to_email_address - used to specify an email address in the case where vm's owner does not have an email address. To specify more than one email address, separate email addresses with commas.

from_email_address - used to specify an email address in the event the requester replies to the email.

signature - used to stamp the email with a custom signature.

Instance: (Storage_Alert)

Contains configurable parameters for the Storage_Alert method.

to_email_address - used to specify an email address in the case where vm's owner does not have an email address. To specify more than one email address, separate email addresses with commas.

from_email_address - used to specify an email address in the event the requester replies to the email.

signature - used to stamp the email with a custom signature.

Instance: (VM_Alert)

Contains configurable parameters for the VM_Alert method.

to_email_address - used to specify an email address in the case where vm's owner does not have an email address. To specify more than one email address, separate email addresses with commas.

from_email_address - used to specify an email address in the event the requester replies to the email.

signature - used to stamp the email with a custom signature.

Method: (EMS_Cluster_Alert)

This method is used to send Email Alerts based on Cluster.

Method: (Ext_Management_System_Alert)

This method is used to send Email Alerts based on Provider.

Method: (Host_Alert)

This method is used to send Email Alerts based on Host.

Method: (MIQ_Server_Alert)

This method is used to send Email Alerts based on ManageIQ Management Engine Server.

Method: (Parse_Alerts)

This method is used to parse incoming Email Alerts.

99

ManageIQ 6.0 Management Engine 5.2 Lifecycle and Automation Guide

Method: (Storage_Alert)

This method is used to send Email Alerts based on Datastore.

Method: (VM_Alert)

This method is used to send Email Alerts based on Virtual Machine.

B.2. Namespace: Automation

Class: Host Lifecycle Management (HostLifecycle)

Instance: Host Discovery (Discovery)

For internal use. Do not modify.

Instance: Host Migrate (Migrate)

For internal use. Do not modify.

Instance: Host Provisioning (Provisioning)

For internal use. Do not modify.

Instance: VM Retirement (Retirement)

For internal use. Do not modify.

Class: VM Lifecycle Management (VMLifecycle)

Instance: VM Discovery (Discovery)

For internal use. Do not modify.

Instance: VM Migrate (Migrate)

For internal use. Do not modify.

Instance: VM Provisioning (Provisioning)

For internal use. Do not modify.

Instance: VM Retirement (Retirement)

For internal use. Do not modify.

Class: VM Management (vm)

Instance: (.missing)

For internal use. Do not modify.

B.3. Namespace: EVMApplications

B.3.1. Namespace: Operations

Class: Intelligent Workload Management (Intelligent_Workload_Management)

100

Automate Model

Instance: (Cluster_Workload_Management)

Contains configurable parameters for the Cluster_Workload_Management method.

to_email_address - where to send email from_email_address - specify the from email.

signature - used to stamp the email with a custom signature.

host_scope: specify scope of other hosts to which this VM can be Vmotioned. Default is to get ESX

Hosts from the Cluster source VM resides.

Instance: Host_Evacuation

Contains configurable parameters for the Host_Evacuation method.

to_email_address - where to send email if the VM is going to be Vmotioned.

from_email_address - specify the from email if the VM is going to be Vmotioned.

signature - used to stamp the email with a custom signature.

host_scope: specify scope of hosts to be evacuated.

Instance: VM_Placement_Optimization (VM_Placement_Optimization)

Contains configurable parameters for the VM_Placement_Optimization method.

to_email_address - where to send email if the VM is going to be Vmotioned.

from_email_address - specify the from email if the VM is going to be Vmotioned.

signature - used to stamp the email with a custom signature.

host_scope: specify scope of other hosts to which this VM can be Vmotioned. Default is to get ESX

Hosts from the Cluster source VM resides.

Method: (Cluster Workload Management)

This method will find a VM that is running hot in a given cluster and vMotion the VM to a more desirable host within that cluster.

Method: (Host_Evacuation)

When a VM encounters high CPU % Ready, VMotions VM to a more suitable host.

Method: (VM_Placement_Optimization)

When a VM encounters high CPU % Ready, VMotion VM to a more suitable host.

B.3.1.1. Namespace: Profile

Class: VM Migrate Group (VmMigrate)

Instance: (.missing)

Default instance used when no group is found for the user creating a migrate request.

Instance: (EVMGroup-super_administrator)

101

ManageIQ 6.0 Management Engine 5.2 Lifecycle and Automation Guide

Instance used when the user is part of the Super Administrator Group. Configurable items: pre_dialog_name dialog_name state_machine

Instance: (EVMGroup-user_self_service)

Instance used when the user is part of the User Self Service Group. Configurable items: pre_dialog_name dialog_name state_machine

Instance: (Super_Admin) pre_dialog_name dialog_name state_machine

Method: (get_deploy_dialog)

Dynamically choose dialog based on Category:environment chosen in pre-dialog.

B.3.2. Namespace: Provisioning

Class: ActiveDirectory Domain (Domain)

Empty

Class: DHCP Server (DHCP_Server)

Empty

Class: VM Naming Profiles (Naming)

Instance: (default)

Calls the vmname method.

Method: Default (vmname)

If VM Name was not chosen during dialog processing then use prefix and [:environment] to generate name (The prefix currently coded into the method is miq). Otherwise, use VM name chosen in dialog. When provisioning multiple Virtual Machines, a number will be appended to the

VM Name.

Class: VM Placement Profiles (Where)

Instance: (best_fit_cluster)

Calls the best_fit_cluster method.

Instance: best_fit_default (best_fit)

102

Automate Model

Calls the /factory/method/host_and_storage_least_utilized method.

Instance: (best_fit_least_utilized)

Calls the least_utilized method.

Instance: (best_fit_with_scope)

Calls the best_fit_with_scope method.

Instance: (best_fit_with_tags)

Calls the best_fit_with_tags method.

Instance: (best_placement_with_scope)

Calls the best_placement_with_scope method.

Method: (best_fit_cluster)

Used to find the cluster with best fit.

Method: (best_fit_with_scope)

Used to find all hosts, datastores that have the tag category prov_scope = 'all'|| prov_scope =

<group-name>

Method: (best_fit_with_tags)

Used to find all hosts, datastores that match the required tag.

Method: (best_placement_with_scope)

This method is used to find the incoming templates cluster as well as hosts and storage that have the tag category prov_scope = 'all' && prov_scope = <group-name>

Method: (least_utilized)

Used to find all hosts, datastores that are the least utilized.

Class: vLANs in Virtual Center (Network)

Empty

B.3.2.1. Namespace: Profile

Class: Host Provisioning Group (Host)

Instance: (.missing)

Default instance used when no group is found for the user creating a host provision request.

Instance: (EVMGroup-super_administrator)

Instance used when the user is part of the Super Administrator Group. Configurable items: pre_dialog_name dialog_name state_machine

103

ManageIQ 6.0 Management Engine 5.2 Lifecycle and Automation Guide

Method: (get_deploy_dialog)

Dynamically choose dialog based on Category:environment chosen in pre-dialog.

Class: Service Provisioning Group (service)

Instance: (.missing)

Default instance used when no group is found for the user creating a provision request.

Class: VM Provisioning Group (VM)

Instance: (.missing)

Default instance used when no group is found for the user creating a provision request.

Instance: (EVMGroup-super_administrator)

Instance used when the user is part of the Super Administrator Group. Configurable items: where domains networks vmname pre_dialog_name: Name of pre-provisioning dialog dialog_name: Name of dialog file auto_approval_state_machine quota_state_machine state_machine

Instance: (EVMGroup-user_self_service)

Instance used when the user is part of the User Self Service Group. Configurable items: where domains networks vmname pre_dialog_name: Name of pre-provisioning dialog dialog_name: Name of dialog file auto_approval_state_machine: quota_state_machine state_machine

Method: (get_deploy_dialog)

104

Dynamically choose dialog based on Category:environment chosen in pre-dialog.

Method: (vm_dialog_name_prefix)

This is the default method to determine the dialog prefix name to use.

B.4. Namespace: Factory

Class: Host(Host)

Instance: (CheckProvisioned)

Calls the check_provisioned method.

Instance: (CustomizeRequest)

Calls the CustomizeRequest and vm_email_owner method.

Instance: (PostProvision_Host)

Calls the PostProvision_Host method.

Instance: (PreProvision_Host)

Calls the PreProvision_Host method.

Instance: (Provision)

Calls the Provision method.

Method: (CustomizeRequest)

This method is used to Customize the provisioning request.

Method: (PostProvision_Host)

This method is used to perform post provisioning tasks.

Method: (PreProvision_Host)

This method is used to customize the provisioning request.

Method: (Provision)

Launches the provisioning job.

Method: (checkprovisioned)

This method checks to see if the host has been provisioned.

Class: Methods

Instance: host_and_storage_least_utilized

Calls the host_and_storage_least_utilized method.

Instance: log_Vm_event

Calls the log_vm_event method.

Automate Model

105

ManageIQ 6.0 Management Engine 5.2 Lifecycle and Automation Guide

Instance: Vm_allowed

Calls the vm_allowed2 method.

Instance: Vm_email_remedy

Calls the vm_email_remedy and send_email methods. Send_email is an internal method that is not visible in the model.

Instance: Stop VM, Unregister and Email Owner (Vm_Post_Retire)

Calls the vm_stop_and_unregister and vm_email_owner methods.

Instance: Vm_scan

Calls the vm_scan method.

Method: host_and_storage_least_utilized

Built in method to find least used host and storage.

Method: log_vm_event

Used to log VM events.

Method: vm_allowed

Parse a text file for VM names.

Method: vm_allowed2

Parse .csv file for VM names.

Method: vm_email_remedy

Used to send an email to Remedy.

Method: vm_scan

Used to launch a SmartState Analysis on a VM.

Method: vm_stop_and_unregister

Used to stop a VM and unregister it from the VC.

Class: Service-Now

Class used for integration with Service-Now.com

Instance: Create CI in Service Now (create_ci_in_eccq).

Create CMDB CI for Service-now.

Unknown: Create Incident in Service Now (create_incident_in_eccq).

Create CMDB incident in Service-now.

Instance: (eccq_insert)

Inserts a record into Service-Now's eccq queue.

Instance: (eccq_insert1)

106

Automate Model

Inserts a record into Service-Now's eccq queue.

Class: Service (Service)

Instance: (CatalogBundleInitialization)

Executes ConfigureParentProvisioningService.

Instance: (CatalogItemInitialization)

Executes ConfigureChildProvisioningService.

Instance: (CheckProvisioned)

Executes check_provisioned.

Instance: (ConfigureChildDialog)

Executes configurechilddialog.

Instance: Provision (provision)

Executes provision method.

Method: (CatalogBundleInitialization)

This method looks for all service dialog variables that start with "dialog_option_[0-9]" and

"dialog_tag_[0-9]" and passes them down to their appropriate child tasks.

Method: (CatalogItemInitialization)

This method first looks in the options hash for :child_options and :child_tags then sets the options/tags for the appropriate task.

Method: Check_Provisioned(CheckProvisioned)

Checks to see if the service has been provisioned.

Method: (ConfigureChildDialog)

Configures the child dialogs for the service.

Method: Provision (provision)

Launches the provisioning job.

Class: VM Migrate (VMMigrate)

Instance: (BestHost)

Executes BestHost.

Instance: (BestStorage)

Executes BestStorage.

Instance: (CheckMigration)

Executes CheckMigration.

Instance: (Migrate)

107

ManageIQ 6.0 Management Engine 5.2 Lifecycle and Automation Guide

108

Executes Migrate.

Instance: (PostMigration)

Executes PostMigration.

Instance: (PreMigration)

Executes PreMigration.

Method: (BestHost)

Future Use.

Method: (BestStorage)

Future Use.

Method: (CheckMigration)

Checks to see if the VM has been migrated.

Instance: (Migrate)

Launches the migration job.

Instance: (PostMigration)

Steps to run after migration.

Instance: (PreMigration)

Steps to run before migration.

Class: Virtual Machine (VM)

Instance: (CheckPoweredOff)

Executes check_powered_off.

Instance: (CheckProvisioned)

Executes check_provisioned.

Instance: (CheckUnregisteredFromVC)

Executes check_unregistered_from_vc.

Instance: (CustomizeRequest)

Executes CustomizeRequest.

Instance: (DeleteFromVC)

Executes delete_from_vc.

Instance: (DeleteFromVMDB)

Executes delete_from_vmdb.

Instance: (PostProvision)

Executes PostProvision.

Instance: (PostProvision_Clone_to_VM)

Executes PostProvision._Clone_to_VM.

Instance: (PowerOff)

Executes power_off.

Instance: (PreDeleteFromVC)

Executes PreDeleteFromVC.

Instance: (PreProvision)

Executes PreProvision.

Instance: (PreProvision_Clone_to_Template)

Executes PreProvision_Clone_to_Template.

Instance: (PreProvision_Clone_to_VM)

Executes PreProvision_Clone_to_VM.

Instance: (Provision)

Executes provision.

Instance: (UnregisterFromVC)

Executes unregister_from_vc.

Instance: (VdiAddVmToDesktopPool)

Executes vdi_add_vm_to_desktop_pool.

Instance: (VdiWaitForHostname)

Executes vdi_wait_for_hostname.

Method: CheckPoweredOff (check_powered_off)

Checks to see if the VM has been deleted from the VC.

Method: CheckProvisioned (check_provisioned)

Checks to see if the vm has been provisioned.

Method: CheckUnregisteredFromVC (check_unregistered_from_vc)

Checks to see if the VM is unregistered from the VC.

Method: (CustomizeRequest)

This method is used to Customize the Provisioning Request:

1. Customization Specification Mapping for VMware provisioning.

2. Customization Template and PXE for RHEV provisioning.

Automate Model

109

ManageIQ 6.0 Management Engine 5.2 Lifecycle and Automation Guide

Method: DeleteFromVCCheck (delete_from_vc_check)

Checks to see if the VM has been deleted from the VC.

Method: DeleteFromVC (delete_from_vc)

Deletes the VM from the VC.

Method: DeleteFromVMDB (delete_from_vmdb)

Removes the VM from the VMDB database.

Method: (PostProvision)

Used to customize the provisioning object prior to provisioning.

Method: (PostProvision_Clone_to_VM)

Used to customize the provisioning object prior to provisioning.

Method: PowerOff (power_off) powers-off the VM on the VC.

Method: (PreDeleteFromVC) runs prior to deleting the VM from VC.

Method: (PreProvision)

Used to apply PreProvision customizations as follows:

Customization Spec

VLAN

VM Description/Annotations

Target VC Folder

Resource Pool

Method: (PreProvision_Clone_to_Template)

This default method is used to apply PreProvision customizations as follows:

1. VM Description/Annotations

2. Target VC Folder

3. Tag Inheritance

Method: (PreProvision_Clone_to_VM)

Used to apply PreProvision customizations during the cloning to a VM:

Customization Spec

VLAN

VM Description/Annotations

110

Automate Model

Target VC Folder

Resource Pool

Method: Provision (provision)

Launches the provisioning job.

Unknown: Scan (scan)

Performs SmartState analysis on a VM.

Method: UnregisterFromVC (unregister_from_vc)

Unregisters the VM from the VC.

Method: VDI Add VM to Desktop Pool (vdi_add_vm_to_desktop_pool)

Adds a provisioned VM to a VDI Desktop Group and optionally creates the Desktop Group.

Method: VDI wait for hostname (vid_wait_for_hostname)

Waits for the VM's hostname, then starts the VM.

B.4.1. Namespace: StateMachines

Class: Host Provision State Machine (HostProvision)

Instance: Provision Host from PXE (host_pxe_install)

Steps to complete to provision a Host using PXE.

Method: (update_provision_status)

Updates provisioning status.

Class: Service Provision Request Approval (ServiceProvisionRequestApproval)

Instance: Default (Default)

Validates or approves request.

Method: (approve_request)

Executed when the provisioning request is auto-approved.

Method: (pending_request)

Executed when the provisioning request is NOT auto-approved.

Method: (validate_request)

Validates the request.

Class: Service Provision State Machine (ServiceProvision_Template)

Instance: clone_to_service (clone_to_service)

Steps to complete to clone a service to a service template.

Method: (update_provision_status)

111

ManageIQ 6.0 Management Engine 5.2 Lifecycle and Automation Guide

Updates provisioning status.

Class: VM Migration State Machine (VMMigrate)

Instance: (default)

Steps to complete to migrate a Virtual Machine.

Method: (update_migration_status)

Updates provisioning status.

Class: VM Provision Approval State Machine (ProvisionRequestApproval)

Instance: Default (Default)

Create new instances for group profiles for automatic approval.

Configurable parameters for autoapproval: max_cpus: maximum number of cpus allowed for autoapproval.

max_vms: maximum number of VMs allowed for autoapproval.

max_memory: maximum amount of memory allowed for autoapproval.

max_retirement_days: maximum number of days until retirement allowed for autoapproval.

Method: (approve_request)

Executed when the provisioning request is auto-approved.

Method: (pending_request)

Executed when the provisioning request is NOT auto-approved.

Method: (validate_request)

This method validates the provisioning request using the values [max_vms, max_cpus, max_memory, max_retirement_days] from values in the following order:

1. In the model.

2. Template tags - This looks at the source provisioning template/VM for the following tags: category values: [prov_max_cpu, prov_max_vm, prov_max_memory, prov_max_retirement_days].

Tag values supersede values in the model.

Class: VM Provision Quota Verification State Machine (ProvisionRequestQuotaVerification)

Instance: Default (Default)

Default instance for quotas for user group provisioning profiles.

Configurable parameter for group quotas: max_owner_cpu: maximum number of cpus allowed for the VM Owner max_owner_memory: maximum memory allowed for the VM Owner max_owner_storage: maximum storage allowed for the VM Owner

112

max_group_cpu: maximum number cpus allowed for the Owner's Group max_group_memory: maximum memory allowed for the Owner's Group max_group_storage: maximum storage allowed for the Owner's Group

Method: (rejected)

Runs when the provision request quota validation has failed.

Method: (validate_quotas)

This method validates the group and owner quotas using the values [max_owner_cpu, max_owner_memory, max_owner_storage, max_group_cpu, max_group_memory, max_group_storage] from values in the following order:

1. In the model

2. Group tags - This looks at the Group for the following tag values: [quota_max_cpus, quota_max_memory, quota_max_storage]

3. Owner tags - This looks at the User for the following tag values: [quota_max_cpus, quota_max_memory, quota_max_storage]

Tags supersede values in the model.

Class: VM Provision State Machine (VMProvision_Template)

Instance: Clone VM to Template (clone_to_template)

Steps to complete for cloning a Virtual Machine to a template.

Method: (update_provision_status)

Updates provisioning status. Calls Service Now if applicable.

Class: VM Provision State Machine (VMProvision_VM)

Instance: Clone VM (clone_to_vm)

Steps to complete for cloning a Virtual Machine.

Instance: Provision VM from Template (template)

Steps to complete for creating a Virtual Machine from a template.

Method: (update_provision_status)

Updates provisioning status. Calls Service Now if applicable.

Class: VM Retirement State Machine (VMRetirement)

Instance: Default

Steps to complete for retiring a Virtual Machine.

Method: (update_retirement_status)

Updates retirement status.

Automate Model

113

ManageIQ 6.0 Management Engine 5.2 Lifecycle and Automation Guide

B.5. Namespace: Integration

Class: BMC Remedy (Remedy)

Integration with Remedy

Instance: (Remedy_Change_Query_Service)

Executes (Remedy_Change_Query_Service).

Instance: (Remedy_ReassignRFC)

Executes (Remedy_ReassignRFC).

Instance: (Remedy_SearchCommentbyParentId)

Executes (Remedy_SearchCommentbyParentId).

Instance: (Remedy_SubmitComment)

Executes (Remedy_SubmitComment).

Method: (Remedy_Change_Query_Service)

Query Remedy Change Management Work Details.

Method: (Remedy_ReassignRFC)

Reassign Service Request in Remedy.

Method: (Remedy_SearchCommentbyParentId)

Search Remedy Comments by Parent ID.

Method: (Remedy_SubmitComment)

Submit Comments to Remedy.

Class: Configuration Management Database (CMDB)

For future use.

Instance: Activate CI (Activate)

For future use.

Instance: Called when Specified Instance is Missing (.missing)

For future use.

Instance: Deactivate CI (Deactivate)

For future use.

Instance: Register CI (Register)

For future use.

Instance: Unregister CI (Unregister)

For future use.

114

Automate Model

Class: Event (Event)

For SNMP traps.

Instance: Event - Error (Error)

For SNMP traps categorized as an Error.

Instance: Event - Information (Information)

For SNMP traps categorized as Informational.

Instance: Event - Warning (Warning)

For SNMP traps categorized as a Warning.

Method: (EVMSNMP)

For future use.

Class: HP Operations Manager (HPOM)

Used to send HPOM Alerts.

Instance: (HPOM_EMS_Cluster_Alert)

Contains configurable parameters for the EMS_Cluster_Alert method.

to_email_address - used to specify an email address in the case where vm's owner does not have an email address. To specify more than one email address, separate email addresses with commas.

from_email_address - used to specify an email address in the event the requester replies to the email.

signature - used to stamp the email with a custom signature.

Instance: (HPOM_Ext_Management_System_Alert)

Contains configurable parameters for the HPOM_Ext_Management_System _Alert method.

to_email_address - used to specify an email address in the case where vm's owner does not have an email address. To specify more than one email address, separate email addresses with commas.

from_email_address - used to specify an email address in the event the requester replies to the email.

signature - used to stamp the email with a custom signature.

Instance: (HPOM_Host_Alert)

Contains configurable parameters for the HPOM_Host_Alert method.

to_email_address - used to specify an email address in the case where vm's owner does not have an email address. To specify more than one email address, separate email addresses with commas.

from_email_address - used to specify an email address in the event the requester replies to the email.

115

ManageIQ 6.0 Management Engine 5.2 Lifecycle and Automation Guide signature - used to stamp the email with a custom signature.

Instance: (HPOM_MIQ_Server_Alert)

Contains configurable parameters for the HPOM_MIQ_Server_Alert method.

to_email_address - used to specify an email address in the case where vm's owner does not have an email address. To specify more than one email address, separate email addresses with commas.

from_email_address - used to specify an email address in the event the requester replies to the email.

signature - used to stamp the email with a custom signature.

Instance: (HPOM_Storage_Alert)

Contains configurable parameters for the HPOM_Storage_Alert method.

to_email_address - used to specify an email address in the case where vm's owner does not have an email address. To specify more than one email address, separate email addresses with commas.

from_email_address - used to specify an email address in the event the requester replies to the email.

signature - used to stamp the email with a custom signature.

Instance: (HPOM_VM_Alert)

Contains configurable parameters for the HPOM_VM_Alert method.

to_email_address - used to specify an email address in the case where vm's owner does not have an email address. To specify more than one email address, separate email addresses with commas.

from_email_address - used to specify an email address in the event the requester replies to the email.

signature - used to stamp the email with a custom signature.

Instance: (Parse_HPOM_Alerts)

Contains configurable parameters for the Parse_ HPOM_Alerts method.

to_email_address - used to specify an email address in the case where vm's owner does not have an email address. To specify more than one email address, separate email addresses with commas.

from_email_address - used to specify an email address in the event the requester replies to the email.

signature - used to stamp the email with a custom signature.

Method: (HPOM_EMS_Cluster_Alert)

This method is used to send HPOM Alerts based on Cluster

Method: (HPOM_Ext_Management_System_Alert)

This method is used to send HPOM Alerts based on Provider.

116

Automate Model

Method: (HPOM_Host_Alert)

This method is used to send HPOM Alerts based on Host.

Method: (HPOM_MIQ_Server_Alert)

This method is used to send HPOM Alerts based on ManageIQ Management Engine Server.

Method: (HPOM_Storage_Alert)

This method is used to send HPOM Alerts based on Datastore.

Method: (HPOM_VM_Alert)

This method is used to send HPOM Alerts based on Virtual Machine.

Method: (Parse_HPOM_Alerts)

This method is used to parse incoming HPOM Alerts.

Class: IP Address Management (IPAM)

IPAM methods reside in this class.

Instance: Acquire IP Address (AcquireIPAddress)

Executes acquire_ip_address method.

Instance: Acquire MAC Address (AcquireMacAddress)

Executes acquire_mac_address method.

Instance: Called when Specified Instance is Missing (.missing)

Default instance.

Instance: Register ActiveDirectory (RegisterAD)

Executes register_ad method.

Instance: Register DNS (RegisterDNS)

Executes register_dns method.

Instance: Release DHCP (ReleaseDHCP)

Executes release_dhcp method.

Instance: Release IP Address (ReleaseIPAddress)

Executes release_ip_address method.

Instance: Release MAC Address (ReleaseMacAddress)

Recommended to be used for customer specific IPAM release of MAC address.

Instance: (ipam_release_ip_from_file)

Executes ipam_release_ip_from_file method.

Method: Acquire IP Address (acquire_ip_address)

117

ManageIQ 6.0 Management Engine 5.2 Lifecycle and Automation Guide

Used to acquire an IP Address from an IPAM Server.

Method: Acquire MAC Address (acquire_mac_address)

Used to acquire a MAC Address.

Method: Register ActiveDirectory (register_ad)

Used to register a VM in Active Directory.

Method: Register DHCP (register_dhcp)

Used to register a VM in DHCP.

Method: Register DNS (register_dns)

Used to register a VM in DNS.

Method: Release DHCP (release_dhcp)

Used to release IP Address from DHCP.

Method: Unregister DHCP (unregister_dhcp)

Used to unregister a VM from DHCP.

Method: (ipam_release_ip_from_file)

Used to release an IP Address from an ASCII file living on an appliance.

Class: VMware SRM(SRM)

Integration with VMware SRM

Instance: (querySRM)

Executes querySRM method.

Method: (querySRM)

Calls VMware SRM to query protected group information for a VM and then dynamically tags the vm based SRM information.

Inputs: $evm.root['vm']

Class: VMware VIX(VIX)

Integration with VMware VIX

Instance: (RunProgramInGuest)

Executes (RunProgramInGuest) method.

Method: (RunProgramInGuest)

This method will run a program on a guest VM via VIX SDK/API./

B.5.1. Namespace: MIQ_IPAM

Namespace for MIQ IPAM.

118

Automate Model

Class: IPAM Database (IPAM_DB)

Class for IPAM Database instances.

Instance: (sample-10.0.0.10)

Class: (IPAM_Methods)

Instance: (IPAM_Acquire_from_MIQ)

Contains parameters and runs (IPAM_Acquire_from_MIQ) method.

Instance: (IPAM_Import)

Contains parameters and runs (IPAM_Import) method.

Instance: (IPAM_Release_from_MIQ)

Contains parameters and runs (IPAM_Release_from_MIQ) method.

Method: (IPAM_Acquire_from_MIQ)

Acquires IP Address information from ManageIQ Management Engine Automate Model.

Method: (IPAM_Import)

Imports IPAM .csv file into ManageIQ Management Engine Automate.

Method: (IPAM_Release_from_MIQ)

Releases IP Address information from ManageIQ Management Engine Automate Model.

Method: Sample (ipamdb_csv)

Sample ipam .csv file. Make necessary changes to this file and place in the /var/www/miq directory.

B.6. Namespace: Sample

Class: (Methods)

All methods in this class are samples only.

Instance: (InspectME)

Calls InspectMe method.

Method: (CheckMulticast)

For future use.

Method: (ConfigureChildDialog)

Sample method to configure/set child dialog values.

Method: (InspectMe)

Returns all properties of specified object.

Method: (PowerOn_DHOB)

119

ManageIQ 6.0 Management Engine 5.2 Lifecycle and Automation Guide

Powers On During Hours of Business is triggered using a Custom Button and allows vms to be powered on only during business hours

Method: (PreProvision_sample1)

Used to customize the provisioning object prior to provisioning.

Method: (auto_tag)

Used to Auto Tag vms based on a CA ASCII file content extracted from VM SmartState Analysis.

Method: (clone)

Run from "VM Lifecycle - Clone (vm_clone)".

Method: (cluster_cpu_utilization)

Power on or off Grid Application vm based on an alert. Can be called in three ways; high cpu utilization, low cpu utilization, and hourly for business hours check.

Method: (extend_retirement_date)

Add 14 days to retirement date when target vm has a retires_on value and is not already retired.

Method: (group_specific_quotas)

Allows for specific quotas based on LDAP group membership.

Method: (print_profiles)

Launched from "VM Lifecycle - Created (vm_created)".

Method: (vdi_reboot)

Reboots the VDI endpoint for a VM.

Method: (vm2clone)

Clone a VM to a new VM using the perl CLI.

Method: (vm2template)

Convert a VM to template using the perl CLI.

Method: (vmname_sample1)

Names a VM with the following characteristics: XXDC-WOS-INP

Where:

XX = static 2 chars that will always be the prefix when naming a vm

DC = 3 char from Tag Category Datacenter

W = 1 char from Tag Category Function

OS = 3 for Win2K3 8 for Win2K8 based on Template

IN = 3 char user will be required to input from dialog where VM Naming was before. We have renamed and set limits on this dialog field accordingly.

$n(2) = 2 digit generated number 01, 02, 03

120

Automate Model

Method: (vmname_sample2)

This method names the vm using the following: location}#{os_type}#{domain}$n{4}

Method: (vmname_sample3)

This method names the vm based on tag category chosen in dialog.

Method: (workload_manager)

For future use.

Class: (Service_Now_Methods)

Sample methods for use with Service-now.

Method: (Create_CI)

Used to create a CMDB in Service-now.

Method: (Create_CI_For_Host)

Used to create a CMDB in Service-now.

Method: (Create_Incident)

Used to create an incident in Service-now.

Method: (Tag_By_Application)

Used to tag vms by application.

B.7. Namespace: System

Class: Automation Requests (Requests)

Instance: (Cluster_Workload_Management)

Connects to /System/Event/Alert_Cluster_Workload_Management.

Instance: Default for Undefined Requests (.missing)

Default instance.

Instance: Host - EVM Provisioning Application (UI_Host_Provision_Info)

Connects request to

/EVMApplications/Provisioning/Profile/Host/${/#user.normalized_ldap_group}#${process#message}.

Instance: (Host_Evacuation)

Connects to /System/Event/Alert_Host_Evacuation.

Instance: (InspectME)

Connects request to /Sample/Methods/InspectME.

121

ManageIQ 6.0 Management Engine 5.2 Lifecycle and Automation Guide

Instance: VM - EVM Provisioning Application (UI_Provision_Info)

Connects request to Group Profile

Instance: (VM_Alert_CPU_Ready)

Connects to VM_Alert CPU_Ready event.

Instance: (vm_retire_extend)

Connects to alert for retirement extension.

Class: Automation Starting Point(Process)

Instance: EVM Automation (Automation)

Connects to an instance in the Automation class.

Instance: EVM Events (Event)

Connects to instance in System/Event class.

Instance: EVM Requests (Request)

Connects to instance in System/Request class.

Method: (parse_automation_request)

Used to parse incoming automation requests.

Class: Event (Event)

Instance: Alert Cluster Workload Management (Alert_Cluster_Workload_Management)

Connects to

/EVMApplications/Operations/Intelligent_Workload_Management/Cluster_Workload_Management.

Instance: Alert Host Evacuation (Alert_Host_Evacuation)

Connects to /EVMApplications/Operations/Intelligent_Workload_Management/Host_Evacuation.

Instance: Request Approved (request_approved)

Connects to /System/Policy/request_approved.

Instance: Request Created (request_created)

Connects to /System/Policy/request_created.

Instance: Default for Missing Events (.missing)

Unknown: General Email Alerts (Email_Alerts)

Connects to appropriate Alert under Alert/Email_Alerts.

Unknown: HP Operations Manager Alerts (HPOM_Alerts)

Connects to appropriate Alert under Integration/HPOM.

Instance: Request Denied (request_denied)

Connects to /System/Policy/request_denied.

122

Automate Model

Instance: Request Pending (request_pending)

Connects to /System/Policy/request_pending.

Instance: Request Starting (request_starting)

Connects to /System/Policy/request_starting.

Instance: Request Updated (request_updated)

Connects to /System/Policy/request_updated.

Instance: VM - Alert - CPU ready (VM_Alert_CPU_Ready)

Connects to

/EVMApplications/Operations/Intelligent_Workload_Management/VM_Placement_Optimization.

Instance: VM - Analysis Aborted (vm_scan_abort)

Connects to /Automation/Vm/${#vm_scan}?vm_id=${process#vm_id}&status=error.

Instance: VM - Analysis Complete (vm_scan_complete)

Connects to /Automation/Vm/${#vm_scan}?vm_id=${process#vm_id}&status=ok.

Instance: VM - Clone Complete (CloneVM_Task_Complete)

Connects to /Automation/Vm/${#logical_event}?vm_id=${process#dest_vm_id}.

Instance: VM - Create Complete (CreateVM_Task_Complete)

Connects to /Automation/Vm/${#logical_event}?vm_id=${process#vm_id}.

Instance: VM - Creation (vm_create)

Connects to /Automation/VMLifecycle/Discovery?vm_id=${process#vm_id}.

Instance: VM - Powered Off (PowerOffVM_Task_Complete)

Connects to /Automation/Vm/${#logical_event}?vm_id=${process#vm_id}.

Instance: VM - Powered On (PowerOnVM_Task_Complete)

Connects to /Automation/vm/${#logical_event}?vm_id=${process#vm_id}.

Instance: VM - Provisioned (vm_provisioned)

Connects to /Alert/EmailNotifications/provision_complete_email.

Instance: VM - Retired (vm_retired)

Connects to /Alert/EmailNotifications/retirement_emails.

Instance: VM - Retirement Warning (vm_retire_warn)

Connects to /Alert/EmailNotifications/vm_retirement_emails.

Instance: VM - Start (vm_start)

Class: Policy (Policy)

123

ManageIQ 6.0 Management Engine 5.2 Lifecycle and Automation Guide

Instance: (.missing)

Instance: Host Provision Request Created (MiqHostProvisionRequest_created)

Connects provision request to auto-approval.

Instance: Host Provision Request Starting (Miq HostProvisionRequest_starting)

Future use.

Instance: Host Provision Request Updated (Miq HostProvisionRequest_Updated)

Future use.

Instance: Provision Request Created (MiqProvisionRequest_created)

Connects provision request to profile and state machine.

Instance: Provision Request Starting (MiqProvisionRequest_starting)

Connects provision request to profile and state machine.

Instance: Provision Request Updated (MiqProvisionRequest_Updated)

Connects provision request to profile and state machine.

Instance: Request Approved (request_approved)

Connects to /Alert/EmailNotifications/requestapproved.

Instance: Request Created (request_created)

Gets request type and connects to appropriate request instance.

Instance: Request Denied (request_denied)

Connects to /Alert/EmailNotifications/requestdenied.

Instance: Request Pending (request_pending)

Connects to /Alert/EmailNotifications/requestpending.

Instance: Request Starting (request_starting)

Gets request type and connects to appropriate request starting instance.

Instance: Request Updated (request_updated)

Gets request type and connects to appropriate request updated instance.

Instance: Request (request)

Executes auto_approve method.

Instance: Service Template Provision Request Created

(ServiceTemplateProvisionRequest_created)

Connects to profiles and state machines for service template provisioning.

Instance: VM Migration Request Created (VmMigrateRequest_created)

Connects request to auto-approval.

124

Instance: VM Migration Request Starting (VmMigrateRequest _starting)

Future use.

Instance: VM Migration Request Updated (VmMigrateRequest _Updated)

Future use.

Method: (MiqHostProvision_Auto_Approve)

This method auto-approves the host provisioning request.

Method: (VmMigrateRequest_Auto_Approve)

This method auto-approves the vm migration request.

Method: (get_request_type)

Used to get the incoming request type.

Automate Model

125