|
| 1 | +#!/usr/bin/env python |
| 2 | + |
| 3 | +""" |
| 4 | +* ******************************************************* |
| 5 | +* Copyright VMware, Inc. 2019. All Rights Reserved. |
| 6 | +* SPDX-License-Identifier: MIT |
| 7 | +* ******************************************************* |
| 8 | +* |
| 9 | +* DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT |
| 10 | +* WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN, |
| 11 | +* EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED |
| 12 | +* WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY, |
| 13 | +* NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE. |
| 14 | +""" |
| 15 | + |
| 16 | + |
| 17 | +__author__ = 'VMware, Inc.' |
| 18 | +__vcenter_version__ = '7.0.0+' |
| 19 | + |
| 20 | +from pyVmomi import vim |
| 21 | +from com.vmware.vcenter.vm_template.library_items_client import CheckOuts |
| 22 | +from com.vmware.vcenter.vm_template.library_items_client import Versions |
| 23 | + |
| 24 | +from vmware.vapi.vsphere.client import create_vsphere_client |
| 25 | + |
| 26 | +from samples.vsphere.common.id_generator import rand |
| 27 | +from samples.vsphere.common.sample_base import SampleBase |
| 28 | +from samples.vsphere.common.ssl_helper import get_unverified_session |
| 29 | +from samples.vsphere.common.vim.helpers.vim_utils import get_obj_by_moId |
| 30 | +from samples.vsphere.contentlibrary.lib.cls_api_client import ClsApiClient |
| 31 | +from samples.vsphere.contentlibrary.lib.cls_api_helper import ClsApiHelper |
| 32 | +from samples.vsphere.vcenter.helper.resource_pool_helper import ( |
| 33 | + get_resource_pool) |
| 34 | + |
| 35 | + |
| 36 | +class CheckOutVmTemplateWorkflow(SampleBase): |
| 37 | + """ |
| 38 | + Demonstrates how to check out a VM from a library item containing a virtual |
| 39 | + machine template, check in the VM checked out from the item, and rollback |
| 40 | + the item to a previous version. |
| 41 | +
|
| 42 | + Prerequisites: |
| 43 | + - A library item containing a virtual machine template |
| 44 | + - A resource pool |
| 45 | + - A datacenter |
| 46 | + """ |
| 47 | + |
| 48 | + def __init__(self): |
| 49 | + SampleBase.__init__(self, self.__doc__) |
| 50 | + self.servicemanager = None |
| 51 | + self.client = None |
| 52 | + self.helper = None |
| 53 | + self.item_name = None |
| 54 | + self.vm_name = None |
| 55 | + self.datacenter_name = None |
| 56 | + self.resource_pool_name = None |
| 57 | + |
| 58 | + def _options(self): |
| 59 | + self.argparser.add_argument('-itemname', '--itemname', |
| 60 | + required=True, |
| 61 | + help='The name of the library item ' |
| 62 | + 'containing the VM template ' |
| 63 | + 'to be checked out') |
| 64 | + self.argparser.add_argument('-datacentername', '--datacentername', |
| 65 | + required=True, |
| 66 | + help='The name of the datacenter in which ' |
| 67 | + 'to check out the VM') |
| 68 | + self.argparser.add_argument('-resourcepoolname', '--resourcepoolname', |
| 69 | + required=True, |
| 70 | + help='The name of the resource pool in ' |
| 71 | + 'the datacenter in which to place ' |
| 72 | + 'the VM') |
| 73 | + self.argparser.add_argument('-vmname', '--vmname', |
| 74 | + help='The name of the VM to check out of ' |
| 75 | + 'the library item') |
| 76 | + |
| 77 | + def _setup(self): |
| 78 | + # Required arguments |
| 79 | + self.datacenter_name = self.args.datacentername |
| 80 | + self.resource_pool_name = self.args.resourcepoolname |
| 81 | + self.item_name = self.args.itemname |
| 82 | + |
| 83 | + # Optional arguments |
| 84 | + self.vm_name = (self.args.vmname if self.args.vmname |
| 85 | + else rand('checked-out-vm-')) |
| 86 | + |
| 87 | + self.servicemanager = self.get_service_manager() |
| 88 | + self.client = ClsApiClient(self.servicemanager) |
| 89 | + self.helper = ClsApiHelper(self.client, self.skip_verification) |
| 90 | + |
| 91 | + session = get_unverified_session() if self.skip_verification else None |
| 92 | + self.vsphere_client = create_vsphere_client(server=self.server, |
| 93 | + username=self.username, |
| 94 | + password=self.password, |
| 95 | + session=session) |
| 96 | + |
| 97 | + def _execute(self): |
| 98 | + # Get the identifiers |
| 99 | + item_id = self.helper.get_item_id_by_name(self.item_name) |
| 100 | + assert item_id |
| 101 | + |
| 102 | + resource_pool_id = get_resource_pool(self.vsphere_client, |
| 103 | + self.datacenter_name, |
| 104 | + self.resource_pool_name) |
| 105 | + assert resource_pool_id |
| 106 | + |
| 107 | + version_before_check_out = self.client.library_item_service.get( |
| 108 | + item_id).content_version |
| 109 | + |
| 110 | + self.print_live_versions(item_id) |
| 111 | + |
| 112 | + # Build the check out spec |
| 113 | + check_out_spec = CheckOuts.CheckOutSpec() |
| 114 | + placement_spec = CheckOuts.PlacementSpec() |
| 115 | + placement_spec.resource_pool = resource_pool_id |
| 116 | + check_out_spec.placement = placement_spec |
| 117 | + check_out_spec.name = self.vm_name |
| 118 | + |
| 119 | + # Check out VM from item |
| 120 | + vm_id = self.client.check_outs_service.check_out(item_id, |
| 121 | + check_out_spec) |
| 122 | + print("VM (ID: {}) checked out from item".format(vm_id)) |
| 123 | + |
| 124 | + # Get library id associated with checked out VM |
| 125 | + info = self.vsphere_client.vcenter.vm.LibraryItem.get( |
| 126 | + vm_id) |
| 127 | + assert info.check_out |
| 128 | + print("Library item associated with checked out VM is {}".format( |
| 129 | + info.check_out.library_item)) |
| 130 | + |
| 131 | + # Check in VM into the library item |
| 132 | + check_in_spec = CheckOuts.CheckInSpec() |
| 133 | + check_in_spec.message = "Check in message" |
| 134 | + version_after_check_in = self.client.check_outs_service.check_in( |
| 135 | + item_id, vm_id, check_in_spec) |
| 136 | + print("VM (ID: {}) checked into item {}".format(vm_id, item_id)) |
| 137 | + self.print_live_versions(item_id) |
| 138 | + |
| 139 | + # Rollback to previous version |
| 140 | + rollback_message = "Rollback to v{}".format(version_before_check_out) |
| 141 | + rollback_spec = Versions.RollbackSpec(rollback_message) |
| 142 | + version_after_rollback = self.client.versions_service.rollback( |
| 143 | + item_id, version_before_check_out, rollback_spec) |
| 144 | + print("Item rolled back to version {}. New item version is {}".format( |
| 145 | + version_before_check_out, version_after_rollback)) |
| 146 | + self.print_live_versions(item_id) |
| 147 | + |
| 148 | + # Delete previous version |
| 149 | + self.client.versions_service.delete(item_id, version_after_check_in) |
| 150 | + print("Deleted version {} of item".format(version_after_check_in)) |
| 151 | + self.print_live_versions(item_id) |
| 152 | + self.print_change_history(item_id) |
| 153 | + |
| 154 | + def print_live_versions(self, item_id): |
| 155 | + # Get and print live versions of the VM template item |
| 156 | + versions_info = self.client.versions_service.list(item_id) |
| 157 | + print("Live versions of VM template item:") |
| 158 | + for version_info in versions_info: |
| 159 | + vm_template = get_obj_by_moId(self.servicemanager.content, |
| 160 | + [vim.VirtualMachine], |
| 161 | + version_info.vm_template) |
| 162 | + print("Version: {}, VM template name: {}".format( |
| 163 | + version_info.version, vm_template.name)) |
| 164 | + |
| 165 | + def print_change_history(self, item_id): |
| 166 | + # Get and print change history of the VM template item |
| 167 | + changes_summary = self.client.changes_service.list(item_id) |
| 168 | + print("Change history of VM template item:") |
| 169 | + for change_summary in changes_summary: |
| 170 | + print("Change version: {}, Time: {}, User: {}, Message: {}".format( |
| 171 | + change_summary.version, change_summary.time, |
| 172 | + change_summary.user, change_summary.short_message)) |
| 173 | + |
| 174 | + |
| 175 | +def main(): |
| 176 | + check_out_workflow_sample = CheckOutVmTemplateWorkflow() |
| 177 | + check_out_workflow_sample.main() |
| 178 | + |
| 179 | + |
| 180 | +if __name__ == '__main__': |
| 181 | + main() |
0 commit comments