azure-om-upgrade.html.md.erb

---
title: Upgrading BOSH Director on Azure
owner: Ops Manager
---

This topic describes how to upgrade BOSH Director for <%= vars.product_name  %> on Azure.

Complete the tasks in this topic as part of the Pivotal Operations Manager upgrade process. For more information, see [Upgrading <%= vars.product_name %>](upgrading-pcf.html#upgrade_ops).

##<a id='overview'></a> Overview

<%# Find this partial in GitHub at `pivotal-cf/docs-partials` %>
<%= partial "/pcf/core/#{vars.current_major_version.sub('.', '-')}/om_upgrade_overview" %>

<p class="note"><strong>Note:</strong> The Azure portal sometimes displays the names of resources with incorrect capitalization. Always use the Azure CLI to retrieve the correctly capitalized name of a resource.</p>

To create an Ops Manager VM instance, do the following:

1. Export environment variables. See [Export Environment Variables](#env-vars). 

1. Copy the Ops Manager image into your storage account. See [Copy the Ops Manager Image](#setup).

1. Configure the Ops Manager IP Address. See [Configure Ops Manager IP Address](#config-ip).

1. Create Ops Manager VM instance. See [Create Ops Manager VM Instance](#boot).


##<a id='prerequisites'></a> Prerequisites

<%# Find this partial in GitHub at `pivotal-cf/docs-partials` %>
<%= partial "/pcf/core/#{vars.current_major_version.sub('.', '-')}/om_upgrade_prerequisite" %> 


## <a id='env-vars'></a> Export Environment Variables

Export the `connectionString` variable for your Azure account and assign it to a new environment variable. You use the `connectionString` environment variable when you copy the Ops Manager image in the following procedure.

To export environment variables, do the following:

1. Install the Azure CLI v2.0 by following the instructions for your operating system in the [Azure documentation](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli).

1. Set your cloud:
    <pre class="terminal">
    $ az cloud set --name AzureCloud
    </pre>
    If you deployed <%= vars.product_name %> in an environment other than Azure Cloud, consult the following list: 
    * For Azure China, replace <code>AzureCloud</code> with <code>AzureChinaCloud</code>. If logging in to <code>AzureChinaCloud</code> fails with a <code>CERT_UNTRUSTED</code> <a href="https://github.com/Azure/azure-xplat-cli/issues/2725">error</a>, use the latest version of node, 4.x or later.
    * For Azure Government Cloud, replace `AzureCloud` with `AzureUSGovernment`.
    * For Azure Germany, replace `AzureCloud` with `AzureGermanCloud`.

1. Log in:
    <pre class="terminal">
    $ az login
    </pre>
    Authenticate by navigating to the URL in the output, entering the provided code, and clicking your account.

1. Ensure that the following environment variables are set to the names of the resources you created when deploying Ops Manager as part of the procedures in [Deploying Ops Manager on Azure Manually](/platform/ops-manager/<%= vars.current_major_version.sub('.', '-') %>/azure/deploy-manual.html).
    * `$RESOURCE_GROUP`: This should be set to the name of your resource group. Run `az group list` to list the resource groups for your subscription.
    * `$LOCATION`: This should be set to your location, such as `westus`. For a list of available locations, run `az account list-locations`.
    * `$STORAGE_NAME`: This should be set to your BOSH storage account name. Run `az storage account list` to list your storage accounts.

1. Retrieve the connection string for the account.
    <pre class="terminal">
    $ az storage account show-connection-string \
    --name $STORAGE_NAME --resource-group $RESOURCE_GROUP
    </pre>
The command returns output similar to the following:
    <pre class="terminal">
    {
      "connectionString": "DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=cfdocsboshstorage;AccountKey=EXAMPLEaaaaaaaaaleiIy/Lprnc5igFxYWsgq016Tu9uGwseOl8bqNBEL/2tp7wX92QMUM19Pz9BYTXt8aq4A=="
    }
    </pre>

1. From the `data:` field in the output above, record the full value of `connectionString` from the output above, starting with and including `DefaultEndpointsProtocol=`.

1. Export the value of `connectionString` as the environment variable `$AZURE_STORAGE_CONNECTION_STRING`.
    <pre class="terminal">
    $ export AZURE_STORAGE_CONNECTION_STRING="YOUR-ACCOUNT-KEY-STRING"
    </pre>


## <a id='setup'></a> Copy the Ops Manager Image

Copy the Ops Manager image into your storage account. You use the Ops Manager image to create the VM that hosts that the new version of Ops Manager.

To copy the Ops Manager image into your storage account, do the following:

1. Navigate to [Pivotal Network](https://network.pivotal.io/products/ops-manager) and download the release of **Pivotal Ops Manager for Azure** you want to upgrade to.

1. View the downloaded PDF and locate the Ops Manager image URL appropriate for your region.

1. Export the Ops Manager image URL as an environment variable.
    <pre class="terminal">$ export OPS_MAN_IMAGE_URL="YOUR-OPS-MAN-IMAGE-URL"</pre>
    This command overrides the old Ops Manager image URL with the new Ops Manager image URL.

1. Copy the Ops Manager image into your storage account.  For compatibility when upgrading to future versions of Ops Manager, choose a unique name for the image that includes the Ops Manager version number. For example, replace <code>opsman-image-version</code> in the following examples with <code>opsman-image-2.0.1</code>.
    <pre class="terminal">
    $ az storage blob copy start --source-uri $OPS_MAN_IMAGE_URL \
    --connection-string $AZURE_STORAGE_CONNECTION_STRING \
    --destination-container opsmanager \
    --destination-blob opsman-image-version.vhd
    </pre>

1. Copying the image may take several minutes. Run the following command and examine the output under `"copy"`:
    <pre class="terminal">
    $ az storage blob show --name opsman-image-version.vhd \
    --container-name opsmanager \
    --account-name $STORAGE_NAME
    ...
    "copy": {
      "completionTime": "2017-06-26T22:24:11+00:00",
      "id": "b9c8b272-a562-4574-baa6-f1a04afcefdf",
      "progress": "53687091712/53687091712",
      "source": "http<span>s:/</span>/opsmanagerwestus.blob.core.windows.net/images/ops-manager-2.0.x.vhd",
      "status": "success",
      "statusDescription": null
    },
    </pre>
    When `status` reads `success`, continue to the next step.


## <a id='config-ip'></a> Configure Ops Manager IP Address

Remove the old Ops Manager VM and record the IP address for the Ops Manager network interface. You use this IP address when creating the new Ops Manager VM that hosts the upgraded version of Ops Manager. 

To configure the Ops Manager IP address, do one of the following:

* [Reuse the existing dynamic public IP address](#reuse-dynamic).
* [Use a new dynamic public IP address](#new-ip).

### <a id='reuse-dynamic'></a> Reuse Existing Dynamic Public IP Address

To reuse an existing dynamic public IP address, do the following:

1. List your VMs and record the name of your Ops Manager VM:
    <pre class="terminal">$ az vm list</pre>

1. Delete your old Ops Manager VM:
    <pre class="terminal">$ az vm delete --name YOUR-OPS-MAN-VM --resource-group $RESOURCE_GROUP</pre>

1. List your network interfaces and record the name of the Ops Manager network interface:
    <pre class="terminal">$ az resource list --resource-group $RESOURCE_GROUP \
    --resource-type Microsoft.Network/networkInterfaces</pre>

### <a id='new-ip'></a> Use a New Dynamic Public IP Address

To use a new dynamic public IP address, do the following:

1. Create a new public IP address named `ops-manager-ip-new`.
    <pre class="terminal">
    $ az network public-ip create --name ops-manager-ip-new \
    --resource-group $RESOURCE_GROUP --location $LOCATION \
    --allocation-method Static
   {
      "publicIp": {
        "dnsSettings": null,
        "etag": "W/\"4450ebe2-9e97-4b17-9cf2-44838339c661\"",
        "id": "/subscriptions/995b7eed-77ef-45ff-a5c9-1a405ffb8243/resourceGroups/cf-docs/providers/Microsoft.Network/publicIPAddresses/ops-manager-ip-new",
        "idleTimeoutInMinutes": 4,
        "ipAddress": "40.83.148.183",
        "ipConfiguration": null,
        "location": "westus",
        "name": "ops-manager-ip-new",
        "provisioningState": "Succeeded",
        "publicIpAddressVersion": "IPv4",
        "publicIpAllocationMethod": "Static",
        "resourceGroup": "cf-docs",
        "resourceGuid": "950d4831-1bec-42da-8a79-959bcddea9dd",
        "tags": null,
        "type": "Microsoft.Network/publicIPAddresses"
      }
    }
    </pre>

1. Record the value for `ipAddress` from the output above. This is the public IP address of Ops Manager.

1. Create a network interface for Ops Manager.
    <pre class="terminal">
    $ az network nic create --vnet-name <%= vars.product_name_lc %>-net \
    --subnet <%= vars.product_name_lc %> --network-security-group opsmgr-nsg \
    --private-ip-address 10.0.0.5 \
    --public-ip-address ops-manager-ip-new \
    --resource-group $RESOURCE_GROUP \
    --name ops-manager-nic-new --location $LOCATION
    </pre>

1. Shut down your old Ops Manager VM, if it still exists:
    <pre class="terminal">
    $ az vm deallocate --name ops-manager --resource-group $RESOURCE_GROUP
    </pre>
    If your Ops Manager VM is not named `ops-manager`, provide the correct name. To list all VMs in your account, use `az vm list`.

1. Update your DNS record to point to your new public IP address of Ops Manager.


## <a id='boot'></a> Create Ops Manager VM Instance

Create an Ops Manager VM instance to host the new version of Ops Manager. 

To create an Ops Manager VM instance, do the following:

1. To use the key pair from your previous Ops Manager, locate the path to the file on your local machine. To create a new key pair, enter the following command:
   <pre class="terminal">
   $ ssh-keygen -t rsa -f opsman -C ubuntu
   </pre>
   <br>
   When prompted for a passphrase, press the `enter` key to provide an empty passphrase.

1. Create the Ops Manager VM.
    * If you are using unmanaged disks, run the following command to create your Ops Manager VM, replacing `PATH-TO-PUBLIC-KEY` with the path to your public key .pub file, and replacing `opsman-image-version` with the version of Ops Manager you are deploying, for example `opsman-image-2.0.1`:
        <pre class="terminal">
        $ az vm create --name opsman-version --resource-group $RESOURCE_GROUP \
        --location $LOCATION \
        --nics opsman-nic \
        --image https://$STORAGE_NAME.my-azure-instance.com/opsmanager/opsman-image-version.vhd \
        --os-disk-name opsman-version-osdisk \
        --os-disk-size-gb 128 \
        --os-type Linux \
        --use-unmanaged-disk \
        --storage-account $STORAGENAME \
        --storage-container-name opsmanager \
        --admin-username ubuntu \
        --ssh-key-value PATH-TO-PUBLIC-KEY
        </pre>
        Replace `my-azure-instance.com` with the URL of your Azure instance. Find the complete source URL in the Azure UI by viewing the **Blob properties** of the Ops Manager image you created earlier in this procedure.<br><br>
    * If you are using Azure managed disks, perform the following steps, replacing `opsman-image-version` with the version of Ops Manager you are deploying, for example `opsman-image-2.0.1`.:
        1. Create a managed image from the Ops Manager VHD file:
            <pre class="terminal">
            $ az image create --resource-group $RESOURCE\_GROUP \
            --name opsman-image-version \
            --source https://$STORAGE\_NAME.blob.core.windows.net/opsmanager/opsman-image-version.vhd \
            --location $LOCATION \
            --os-type Linux
            </pre>
            If you are using Azure China, Azure Government Cloud, or Azure Germany, replace `blob.core.windows.net` with the following:
            * For Azure China, use `blob.core.chinacloudapi.cn`. See the [Azure documentation](https://docs.microsoft.com/en-us/azure/china/china-get-started-developer-guide) for more information.
            * For Azure Government Cloud, use `blob.core.usgovcloudapi.net`. See the [Azure documentation](https://docs.microsoft.com/en-us/azure/azure-government/documentation-government-services-storage) for more information.
            * For Azure Germany, use `blob.core.cloudapi.de`. See the [Azure documentation](https://docs.microsoft.com/en-us/azure/germany/germany-developer-guide) for more information.
        1. Create your Ops Manager VM, replacing `PATH-TO-PUBLIC-KEY` with the path to your public key `.pub` file, and replacing `opsman-version` and `opsman-image-version` with the version of Ops Manager you are deploying, for example `opsman-2.0.1`, `opsman-2.0.1-osdisk`, and `opsman-image-2.0.1`.
            <pre class="terminal">
             $ az vm create --name opsman-version --resource-group $RESOURCE\_GROUP \
             --location $LOCATION \
             --nics opsman-nic \
             --image opsman-image-version \
             --os-disk-name opsman-version-osdisk \
             --admin-username ubuntu \
             --size Standard\_DS2_v2 \
             --storage-sku Standard\_LRS \
             --ssh-key-value PATH-TO-PUBLIC-KEY
            </pre>

1. If you have deployed more than one tile in this Ops Manager installation, perform the following steps to increase the size of the Ops Manager VM disk. You can repeat this process and increase the disk again at a later time if necessary.
    <p class="note"><strong>Note:</strong> If you use Azure Stack, you must increase the Ops Manager VM disk size using the Azure Stack UI.</p>
    1. Run the following command to stop the VM and detach the disk, replacing `opsman-version` with the version of Ops Manager you are deploying, for example `opsman-2.0.1`:
    <pre class="terminal">
    $ az vm deallocate --name opsman-version \
    --resource-group $RESOURCE\_GROUP
    </pre>
    1. Run the following command to resize the disk to 128&nbsp;GB, replacing `opsman-version` with the version of Ops Manager you are deploying, for example `opsman-2.0.1`:
    <pre class="terminal">
    $ az disk update --size-gb 128 --name opsman-version-osdisk \
    --resource-group $RESOURCE\_GROUP
    </pre>
    1. Run the following command to start the VM, replacing `opsman-version` with the version of Ops Manager you are deploying, for example `opsman-2.0.1`:
    <pre class="terminal">
    $ az vm start --name opsman-version --resource-group $RESOURCE\_GROUP
    </pre>


## <a id='next'></a> Next Steps

After you complete this procedure, continue the upgrade instructions in Upgrading <%= vars.product_name %> topic.