Patch 1 for Service Pack 1: 3.1.01.001

Recommendation

Patch 2 for BMC Cloud Lifecycle Management 3.1.01 is released and includes Patch 1 updates and corrected issues. BMC recommends that you directly upgrade to Patch-2-for-Service-Pack-1-3-1-01-002.

This topic contains information about fixes and updates in this patch, and provides instructions for downloading and installing the patch.

Tip

For information about issues corrected in this patch, see Known-and-corrected-issues.

Updates

Patch 1 for Service Pack 1 provides the following updates.

New installer for installing the patch

For this patch, an installation wizard is available that enables a quick installation. For earlier patches, you could install a patch only manually. For details, see Installing the patch.

Support for standard switch in Microsoft Hyper-V environments

BMC Cloud Lifecycle Management now supports the standard switch in addition to the logical switch in Microsoft Hyper-V environments.

Support for BMC Capacity Optimization 9.0 Service Pack 4 and 9.5 Cumulative Patch 1

BMC Cloud Lifecycle Management version 3.1.01 Patch 1 supports BMC Capacity Optimization 9.0 Service Pack 4 and BMC Capacity Optimization 9.5 Cumulative Patch 1.

Support for adding callouts by using the GUI

In the earlier versions of BMC Cloud Lifecycle Management, you could use the REST API calls only to create callouts. This patch enables you to create, edit, or delete callouts from the BMC Cloud Lifecycle Management – Administration Console. For details, see Working-with-callouts.

Changes to contract lines

Contract lines for a service offering instance (SOI) are created in the enterprise BMC Remedy AR System server in draft mode and then transitioned to the cloud BMC Remedy AR System. After the SOI is provisioned, a notification for task completion is sent to the GUI, triggering the service request to be closed. After the service request is closed, Service Request Management changes the status of the contract lines to Active. If any error occurs in provisioning, the contract lines are set to Cancelled.

When you use the ServiceOfferingInstance bulkcreate request and the ServiceOfferingInstance-applyOptionChoice-request, contract lines for each SOI are created in a draft mode before the provisioning starts. If one of the SOIs fails, all contract lines are canceled even if the rest of the SOIs are provisioned successfully.

In patch 1, contract lines are created in the cloud AR System server first and then set to the Active state only after the provisioning is successful. These contract lines are then transitioned from the cloud AR System server to the enterprise AR System server.

The following list describes the changes to the ServiceOfferingInstance bulkCreate request

The contractLineID parameter is deprecated.

The following list describes the changes to the ServiceOfferingInstance applyOptionChoice request

The new requestableOfferingID parameter is added.
The contractLineID parameter is deprecated.
The new, optional serviceRequestID parameter is added.

The following list describes the changes to the Object Model

The new RequestableOffering class is added.

A new relationship is added between the RequestableOffering class and the ServiceOffering class.
A new relationship is added between the Price class and the RequestableOffering class.
A new relationship added between the Price class and the OptionChoice class.

New Access attribute for Workload Manager provider

Starting with this patch, you can use a new attribute, forceSOICleanup, in the provider.json file to indicate whether to continue clean or decommission flow when SOI creation fails.

By default, this attribute is set to true. Setting its value to false prevents cleanup of resources when provisioning fails and the SOI remains in a failed state. A decommission can then be initiated, which cleans the resources.

Click here to view a code snippet of provider.json that includes the forceSOICleanup attribute.

{
     "cloudClass" : "com.bmc.cloud.model.beans.AccessAttribute",
     "datatype" : "BOOLEAN",
     "description" : "Force SOI Cleanup",
     "guid" : "857e7b27-9b97-4ebc-ac80-fd40a11faf1a",
     "hasValueObject" : [ {
       "cloudClass" : "com.bmc.cloud.model.beans.AccessAttributeValue",
       "attributeValue" : "true",
       "guid" : "3db29a4e-eaab-442d-aa10-c899e8a9e551",
       "name" : "forceSOICleanup"
      } ],
     "isOptional" : true,
     "isPassword" : false,
     "modifiableWithoutRestart" : false,
     "name" : "forceSOICleanup"
    }

Downloading the patch

For download instructions, see Downloading-the-installation-files.

Preparing to install the patch

The following table describes the steps you need to perform before installing this patch.

Step	Procedure
1.	Upgrade to BMC Cloud Lifecycle Management version 3.1 Service Pack 1 before installing this patch. For details about upgrading to 3.1.01, see Upgrading.
2.	(Optional) Install only if you require the fix for QM001790410, else, skip to step 3. Note QM001790410: Issues with SOI provisioning rollback behavior cause problems such as improper clean up of VMs from the infrastructure or IP address conflicts. Upgrade BMC Server Automation to version 8.3 Service Pack 2 and then apply the hotfix. Contact BMC Customer Support to obtain the hotfix. Perform the following steps to install the hotfix on BMC Server Automation version 8.3 Service Pack 2 Apply the latest hotfix applicable to BMC Server Automation 8.3 Service Pack 2. Contact BMC Customer Support to obtain the latest hotfix. Log on to BMC Server Automation Console as a BLAdmin user. Distribute the configuration object with version 83010118 on the SCVMM Hyper-v Server. After the distribution is complete, you can access the standard switch in the REST response. Verify whether the hotfix is applied successfully by accessing the following sample REST URI: *https://localhost:9843/group/Servers/Vmware/SCVMMHyper-vServerName/Assets/BMC_SCVMM/BMC_SCVMM_Cloud/?username=BLAdmin&password=PASSWORD&role=BLAdmins. An added attribute, Host Standard Switches*, which contains the comma-separated values of the standard switches, is visible.
3.	(Perform this step only if you have skipped step 2) Install the hotfix for BMC Server Automation 8.3 from the following location. ftp://ftp.bmc.com/pub/CLM3.1SP1HF3/scvmm.zip Perform the following steps to install the hot fix on BMC Server Automation version 8.3 Take a snapshot of the BMC Server Automation server and back up the associated database. Log on to BMC Server Automation Console as a BLAdmin user. From the Configuration menu, select the Config Object Dictionary View check box. In the Config Object Dictionary tab, click Add Configuration Object and import the configuration object. Select Server Object and then select the scvmm.zip file as the implementation file. This imports the System Center Virtual Machine Manager (SCVMM) configuration object in the BMC Server Automation 8.3 application server. Distribute the configuration object with version 83010118 on the SCVMM Hyper-v Server. After the distribution is complete, you can access the standard switch in the REST response. Verify whether the hotfix is applied successfully by accessing the following sample REST URI: *https://localhost:9843/group/Servers/Vmware/SCVMMHyper-vServerName/Assets/BMC_SCVMM/BMC_SCVMM_Cloud/?username=BLAdmin&password=PASSWORD&role=BLAdmins. An added attribute, Host Standard Switches*, which contains the comma-separated values of the standard switches, is visible.
4.	On the Platform Manager, edit the providers.json file to include the attributes required for Patch 1. Perform the following steps to edit the providers.json file On the Platform Manager, stop the Platform Manager service. In the providers.json file, search for the following snippet. { { "cloudClass" : "com.bmc.cloud.model.beans.AccessAttributeValue", "accessAttribute" : { "cloudClass" : "com.bmc.cloud.model.beans.AccessAttribute", "datatype" : "BOOLEAN", "description" : "Enable SOI Rollback", "guid" : "021d03d1-2b50-4b96-9281-728b2e0fff88", "isOptional" : true, "isPassword" : false, "modifiableWithoutRestart" : false, "name" : "enableSOIRollback" }, "attributeValue" : "true", "description" : "Enable SOI Rollback", "guid" : "92af9b10-3df3-4663-8ac3-aeeeec5531c5", "name" : "enableSOIRollback" } Add the following AccessAttributeValue lines after the above snippet. ,{ { "cloudClass" : "com.bmc.cloud.model.beans.AccessAttribute", "datatype" : "BOOLEAN", "description" : "Force SOI Cleanup", "guid" : "857e7b27-9b97-4ebc-ac80-fd40a11faf1a", "isOptional" : true, "isPassword" : false, "modifiableWithoutRestart" : false, "name" : "forceSOICleanup" }, "attributeValue" : "true", "description" : "Force SOI Cleanup", "guid" : "3db29a4e-eaab-442d-aa10-c899e8a9e551", "name" : "forceSOICleanup" } Search for the following snippet in the CSM WorkLoad Manager provider. { "cloudClass" : "com.bmc.cloud.model.beans.ProviderDefinition", "accessAttributes" : [ { "cloudClass" : "com.bmc.cloud.model.beans.AccessAttribute", "datatype" : "BOOLEAN", "description" : "Enable SOI Rollback", "guid" : "021d03d1-2b50-4b96-9281-728b2e0fff88", "hasValueObject" : [ { "cloudClass" : "com.bmc.cloud.model.beans.AccessAttributeValue", "attributeValue" : "true", "guid" : "8a1fda43-0ed7-43fe-821f-032a1af9e588", "name" : "enableSOIRollback" } ], "isOptional" : true, "isPassword" : false, "modifiableWithoutRestart" : false, "name" : "enableSOIRollback" } If found, add the following lines after the above snippet. If the snippet is not available in the file, add the above lines and then append the following snippet to the CSM WorkLoad Manager provider. See the example provided in the next step. ,{ "cloudClass" : "com.bmc.cloud.model.beans.AccessAttribute", "datatype" : "BOOLEAN", "description" : "Force SOI Cleanup", "guid" : "857e7b27-9b97-4ebc-ac80-fd40a11faf1a", "hasValueObject" : [ { "cloudClass" : "com.bmc.cloud.model.beans.AccessAttributeValue", "attributeValue" : "true", "guid" : "3db29a4e-eaab-442d-aa10-c899e8a9e551", "name" : "forceSOICleanup" } ], "isOptional" : true, "isPassword" : false, "modifiableWithoutRestart" : false, "name" : "forceSOICleanup" } Clear cache and restart the service. The following figure displays the changes to the file after the CSM WorkLoad Managerprovider and provider definition sections are updated. Example { "cloudClass" : "com.bmc.cloud.model.beans.Provider", "accessValues" : [ { "cloudClass" : "com.bmc.cloud.model.beans.AccessAttributeValue", "accessAttribute" : { "cloudClass" : "com.bmc.cloud.model.beans.AccessAttribute", "datatype" : "BOOLEAN", "description" : "Enable SOI Rollback", "guid" : "021d03d1-2b50-4b96-9281-728b2e0fff88", "isOptional" : true, "isPassword" : false, "modifiableWithoutRestart" : false, "name" : "enableSOIRollback" }, "attributeValue" : "true", "description" : "Enable SOI Rollback", "guid" : "92af9b10-3df3-4663-8ac3-aeeeec5531c5", "name" : "enableSOIRollback" }, { "cloudClass" : "com.bmc.cloud.model.beans.AccessAttributeValue", "accessAttribute" : { "cloudClass" : "com.bmc.cloud.model.beans.AccessAttribute", "datatype" : "BOOLEAN", "description" : "Force SOI Cleanup", "guid" : "857e7b27-9b97-4ebc-ac80-fd40a11faf1a", "isOptional" : true, "isPassword" : false, "modifiableWithoutRestart" : false, "name" : "forceSOICleanup" }, "attributeValue" : "true", "description" : "Force SOI Cleanup", "guid" : "3db29a4e-eaab-442d-aa10-c899e8a9e551", "name" : "forceSOICleanup" } ], "description" : "CSM WorkLoad Manager provider", "guid" : "e8a02dbc-9eec-4a75-a187-d706713d7997", "isDisabled" : false, "name" : "WLM", "providerDefinition" : "/providerdefinition/528aa788-8311-42e4-8379-3a603c221bd2", "providerDefinitionObject" : { "cloudClass" : "com.bmc.cloud.model.beans.ProviderDefinition", "accessAttributes" : [ { "cloudClass" : "com.bmc.cloud.model.beans.AccessAttribute", "datatype" : "BOOLEAN", "description" : "Enable SOI Rollback", "guid" : "021d03d1-2b50-4b96-9281-728b2e0fff88", "hasValueObject" : [ { "cloudClass" : "com.bmc.cloud.model.beans.AccessAttributeValue", "attributeValue" : "true", "guid" : "8a1fda43-0ed7-43fe-821f-032a1af9e588", "name" : "enableSOIRollback" } ], "isOptional" : true, "isPassword" : false, "modifiableWithoutRestart" : false, "name" : "enableSOIRollback" }, { "cloudClass" : "com.bmc.cloud.model.beans.AccessAttribute", "datatype" : "BOOLEAN", "description" : "Force SOI Cleanup", "guid" : "857e7b27-9b97-4ebc-ac80-fd40a11faf1a", "hasValueObject" : [ { "cloudClass" : "com.bmc.cloud.model.beans.AccessAttributeValue", "attributeValue" : "true", "guid" : "3db29a4e-eaab-442d-aa10-c899e8a9e551", "name" : "forceSOICleanup" } ], "isOptional" : true, "isPassword" : false, "modifiableWithoutRestart" : false, "name" : "forceSOICleanup" } ], "description" : "CSM WorkLoad Manager provider", "guid" : "528aa788-8311-42e4-8379-3a603c221bd2", "isInternal" : true, "name" : "WLM", "parent" : "528aa787-8310-42e3-8379-3a603c221bd1", "supportedOperations" : […..
5.	If you have changed the administrator user password for the enterprise AR System and cloud AR System after the last time you installed BMC Cloud Lifecycle Management, you must ensure that the passwords match the installation configuration file. If the passwords do not match, the installation fails. Perform the following steps to ensure that the passwords match Generate an encrypted password: On the Cloud Platform Manager, go to C:\Program Files\BMC Software\BMCCloudLifeCycleManagement\Utilities. Run the BMCCloudLifeCycleManagementMaintenanceTool.bat/sh file. Click Encrypt. In the Password and Confirm Password fields, enter the new password. Click Encrypt. Copy the new encrypted password. Update the encrypted password in the installation configuration file on the enterprise AR System: Go to InstallationDirectory\BMCCloudLifeCycleManagement\ and open theBMCCloudLifeCycleManagementInstalledConfiguration.xml file. Search for the BMC_AR_PASSWORD_HOSTING attribute. In the value field for the attribute, enter the encrypted password. On the cloud AR System server, follow the same steps to update the encrypted password in the installation configuration file.
6.	Take a VM snapshot and a database backup of the enterprise AR System server, cloud AR System, Platform Manager, and BMC Atrium Orchestrator. After you install this patch, the enterprise AR System server and the mid-tier service is restarted and any customization done in the non-overlay mode is lost.
7.	Ensure that the supported products are at the latest service pack or patch level. For details, see Component-BMC-product-service-pack-and-patch-levels.

Installing the patch

Download and extract the installation zip file and place a copy on each of the virtual machines (VM) that have the following components installed:
1. Enterprise BMC Remedy AR System server
2. Cloud BMC Remedy AR System server
3. Cloud Platform Manager
  Note
  Install patch 1 on the cloud AR System server only when the installation on the enterprise AR System server is complete. Similarly, install patch 1 on the Cloud Platform Manager only when the installation on the cloud AR System server is complete.
On the Enterprise AR System server, install patch 1:
1. Start one of the following installation programs:
  - On Microsoft Windows, double-click the setup.cmd file.
  - On Linux, launch the installer by using Xmanager.
    With Xmanager, X applications installed on remote UNIX-based computers run seamlessly with Windows applications side by side.
    Note
    You can also use VConsole to launch the installer.
2. On the Welcome pane, note the warnings and click Next.
3. On the Directory selection pane, navigate to the location on the host where you want to install the BMC Cloud Lifecycle Management products and click Next.
  You can accept the default value if you do not have a specific location for the installation files.
4. On the Installation Preview pane, review the summary and click Next.
Repeat step 2 on the Cloud AR System server.
Repeat step 2 on the Cloud Platform Manager.

Post-installation activities

Before launching the BMC Cloud Lifecycle Management console:

Clear the mid-tier cache.
If the mid-tier used by the BMC Cloud Lifecycle Management console is different than the mid-tier running on the enterprise AR System server, then you need to clear the cache.
1. Log on to the Mid Tier Configuration Tool.
2. Perform a flush cache.
  The flush cache removes all items from the caches that BMC Remedy Mid Tier maintains. The next time the mid tier needs those objects, the most up-to-date versions are retrieved from the AR System server.
Clear the browser cache.
Delete the mid-tier cache.
Perform the following steps to hard delete the mid-tier cache
1. Stop the MidTier service.
2. Clear contents of the following folders:
  <BMC Software>\ARSystem\midtier\cache
  <BMC Software>\ARSystem\midtier\PluginsCache
  <Apache Software Foundation>\Tomcat6.0\work
3. Restart MidTier service.
Note
You can view the list of AR objects updated with the patch on the Enterprise AR System server at the C:\Program Files\BMC Software\CLMPatchInstaller\clmpatchinstaller\P1_CLM_3.1.01_backup\ear location, in the Stepstracker.txt file.