|
1 | 1 | ---
|
2 |
| -title: Connect your VMware vCenter to Azure Arc using the helper script |
3 |
| -description: In this quickstart, you'll learn how to use the helper script to connect your VMware vCenter to Azure Arc. |
| 2 | +title: Connect VMware vCenter Server to Azure Arc by using the helper script |
| 3 | +description: In this quickstart, you'll learn how to use the helper script to connect your VMware vCenter Server instance to Azure Arc. |
4 | 4 | ms.topic: quickstart
|
5 | 5 | ms.custom: references_regions
|
6 | 6 | ms.date: 11/10/2021
|
7 | 7 |
|
8 |
| -# Customer intent: As a VI admin, I want to connect my vCenter to Azure to enable self-service through Arc. |
| 8 | +# Customer intent: As a VI admin, I want to connect my vCenter Server instance to Azure to enable self-service through Azure Arc. |
9 | 9 | ---
|
10 | 10 |
|
11 |
| -# Quickstart: Connect your VMware vCenter to Azure Arc using the helper script |
| 11 | +# Quickstart: Connect VMware vCenter Server to Azure Arc by using the helper script |
12 | 12 |
|
13 |
| -To start using the Azure Arc-enabled VMware vSphere (preview) features, you'll need to connect your VMware vCenter Server to Azure Arc. This quickstart shows you how to connect your VMware vCenter Server to Azure Arc using a helper script. |
| 13 | +To start using the Azure Arc-enabled VMware vSphere (preview) features, you need to connect your VMware vCenter Server instance to Azure Arc. This quickstart shows you how to connect your VMware vCenter Server instance to Azure Arc by using a helper script. |
14 | 14 |
|
15 |
| -First, the script deploys a virtual appliance, called [Azure Arc resource bridge (preview)](../resource-bridge/overview.md), in your vCenter environment. Then, it installs a VMware cluster extension to provide a continuous connection between your vCenter Server and Azure Arc. |
| 15 | +First, the script deploys a virtual appliance called [Azure Arc resource bridge (preview)](../resource-bridge/overview.md) in your vCenter environment. Then, it installs a VMware cluster extension to provide a continuous connection between vCenter Server and Azure Arc. |
16 | 16 |
|
17 | 17 | > [!IMPORTANT]
|
18 |
| -> In the interest of ensuring new features are documented no later than their release, this page may include documentation for features that may not yet be publicly available. |
| 18 | +> In the interest of ensuring that new features are documented no later than their release, this article might include documentation for features that aren't yet publicly available. |
19 | 19 |
|
20 | 20 | ## Prerequisites
|
21 | 21 |
|
22 | 22 | ### Azure
|
23 | 23 |
|
24 | 24 | - An Azure subscription.
|
25 | 25 |
|
26 |
| -- A resource group in the subscription where you are a member of the *Owner/Contributor* role. |
| 26 | +- A resource group in the subscription where you're a member of the *Owner/Contributor* role. |
27 | 27 |
|
28 | 28 | ### vCenter Server
|
29 | 29 |
|
30 |
| -- vCenter Server running version 6.7 |
| 30 | +- vCenter Server version 6.7. |
31 | 31 |
|
32 |
| -- Allow inbound connections on TCP port (usually 443) so that the Arc resource bridge and VMware cluster extension can communicate with the vCenter server. |
| 32 | +- Inbound connections allowed on TCP port (usually 443) so that the Azure Arc resource bridge and VMware cluster extension can communicate with the vCenter Server instance. |
33 | 33 |
|
34 |
| -- A resource pool or a cluster with a minimum capacity of 16 GB of RAM, four vCPUs. |
| 34 | +- A resource pool or a cluster with a minimum capacity of 16 GB of RAM and four vCPUs. |
35 | 35 |
|
36 | 36 | - A datastore with a minimum of 100 GB of free disk space available through the resource pool or cluster.
|
37 | 37 |
|
38 | 38 | - An external virtual network/switch and internet access, directly or through a proxy.
|
39 | 39 |
|
40 | 40 | > [!NOTE]
|
41 |
| -> Azure Arc-enabled VMware vSphere (preview) supports vCenters with a maximum of 2500 VMs. If your vCenter has more than 2500 VMs, it is not recommended to use Arc-enabled VMware vSphere with it at this point. |
| 41 | +> Azure Arc-enabled VMware vSphere (preview) supports vCenter Server instances with a maximum of 2,500 virtual machines (VMs). If your vCenter Server instance has more than 2,500 VMs, we don't recommend that you use Azure Arc-enabled VMware vSphere with it at this point. |
42 | 42 |
|
43 |
| -### vSphere accounts |
| 43 | +### vSphere account |
44 | 44 |
|
45 |
| -A vSphere account that can: |
46 |
| -- read all inventory |
47 |
| -- deploy, and update VMs to all the resource pools (or clusters), networks, and virtual machine templates that you want to use with Azure Arc. |
| 45 | +You need a vSphere account that can: |
| 46 | +- Read all inventory. |
| 47 | +- Deploy and update VMs to all the resource pools (or clusters), networks, and VM templates that you want to use with Azure Arc. |
48 | 48 |
|
49 |
| -This account is used for the ongoing operation of Azure Arc-enabled VMware vSphere (preview) and the Azure Arc resource bridge (preview) VM deployment. |
| 49 | +This account is used for the ongoing operation of Azure Arc-enabled VMware vSphere (preview) and the deployment of the Azure Arc resource bridge (preview) VM. |
50 | 50 |
|
51 | 51 | ### Workstation
|
52 | 52 |
|
53 |
| -A Windows or Linux machine that can access both your vCenter Server and internet, directly or through a proxy. |
| 53 | +You need a Windows or Linux machine that can access both your vCenter Server instance and the internet, directly or through a proxy. |
54 | 54 |
|
55 | 55 | ## Prepare vCenter Server
|
56 | 56 |
|
57 | 57 | 1. Create a resource pool with a reservation of at least 16 GB of RAM and four vCPUs. It should also have access to a datastore with at least 100 GB of free disk space.
|
58 | 58 |
|
59 |
| -2. Ensure the vSphere accounts have the appropriate permissions. |
| 59 | +2. Ensure that the vSphere accounts have the appropriate permissions. |
60 | 60 |
|
61 | 61 | ## Download the onboarding script
|
62 | 62 |
|
63 |
| -1. Go to Azure portal. |
| 63 | +1. Go to the Azure portal. |
64 | 64 |
|
65 |
| -2. Search for **Azure Arc** and click on it. |
| 65 | +2. Search for **Azure Arc** and select it. |
66 | 66 |
|
67 |
| -3. On the **Overview** page, click on **Add** under **Add your infrastructure for free** or move to the **Infrastructure** tab. |
| 67 | +3. On the **Overview** page, select **Add** under **Add your infrastructure for free** or move to the **Infrastructure** tab. |
68 | 68 |
|
69 |
| -4. Under **Platform** section, click on **Add** under VMware. |
| 69 | +4. In the **Platform** section, select **Add** under **VMware vCenter**. |
70 | 70 |
|
71 |
| - :::image type="content" source="media/add-vmware-vcenter.png" alt-text="Screenshot showing how to add a VMware vCenter through Azure Arc center"::: |
| 71 | + :::image type="content" source="media/add-vmware-vcenter.png" alt-text="Screenshot that shows how to add VMware vCenter through Azure Arc."::: |
72 | 72 |
|
73 |
| -5. Select **Create a new resource bridge** and click **Next** |
| 73 | +5. Select **Create a new resource bridge**, and then select **Next**. |
74 | 74 |
|
75 |
| -6. Provide a name of your choice for Arc resource bridge. Eg. `contoso-nyc-resourcebridge` |
| 75 | +6. Provide a name of your choice for the Azure Arc resource bridge. For example: **contoso-nyc-resourcebridge**. |
76 | 76 |
|
77 |
| -7. Select a Subscription and Resource group where the resource bridge would be created. |
| 77 | +7. Select a subscription and resource group where the resource bridge will be created. |
78 | 78 |
|
79 |
| -8. Under Region, select an Azure location where the resource metadata would be stored. Currently supported regions are `East US` and `West Europe`. |
| 79 | +8. Under **Region**, select an Azure location where the resource metadata will be stored. Currently, supported regions are **East US** and **West Europe**. |
80 | 80 |
|
81 |
| -9. Provide a name for the Custom location. This will be the name which you will see when you deploy VMs. Name it for the datacenter or physical location of your datacenter. Eg: `contoso-nyc-dc` |
| 81 | +9. Provide a name for **Custom location**. This is the name that you'll see when you deploy VMs. Name it for the datacenter or the physical location of your datacenter. For example: **contoso-nyc-dc**. |
82 | 82 |
|
83 |
| -10. Leave the option for **Use the same subscription and resource group as your resource bridge** checked. |
| 83 | +10. Leave **Use the same subscription and resource group as your resource bridge** selected. |
84 | 84 |
|
85 |
| -11. Provide a name for your vCenter in Azure. Eg: `contoso-nyc-vcenter` |
| 85 | +11. Provide a name for your vCenter Server instance in Azure. For example: **contoso-nyc-vcenter**. |
86 | 86 |
|
87 |
| -12. Click on **Next: Download and run script >** |
| 87 | +12. Select **Next: Download and run script**. |
88 | 88 |
|
89 |
| -13. If your subscription is not registered with all the required resource providers, a **Register** button will appear. Click the button before proceeding to the next step. |
| 89 | +13. If your subscription is not registered with all the required resource providers, a **Register** button will appear. Select the button before you proceed to the next step. |
90 | 90 |
|
91 |
| - :::image type="content" source="media/register-arc-vmware-providers.png" alt-text="Screenshot showing button to register required resource providers during vCenter onboarding to Arc"::: |
| 91 | + :::image type="content" source="media/register-arc-vmware-providers.png" alt-text="Screenshot that shows the button to register required resource providers during vCenter onboarding to Azure Arc."::: |
92 | 92 |
|
93 |
| -14. Based on the operating system of your workstation, download the powershell or bash script, and copy it to the [workstation](#prerequisites). |
| 93 | +14. Based on the operating system of your workstation, download the PowerShell or Bash script and copy it to the [workstation](#prerequisites). |
94 | 94 |
|
95 |
| -15. [Optional] Click on **Next : Verification**. This page will show you the status of your onboarding once you run the script on your workstation. Closing this page will not affect the onboarding. |
| 95 | +15. If you want to see the status of your onboarding after you run the script on your workstation, select **Next: Verification**. Closing this page won't affect the onboarding. |
96 | 96 |
|
97 | 97 | ## Run the script
|
98 | 98 |
|
99 |
| -### Windows |
| 99 | +Use the following instructions to run the script, depending on which operating system your machine is using. |
100 | 100 |
|
101 |
| -Follow the below instructions to run the script on a windows machine: |
| 101 | +### Windows |
102 | 102 |
|
103 |
| -1. Open a PowerShell window and navigate to the folder where you have downloaded the powershell script. |
| 103 | +1. Open a PowerShell window and go to the folder where you've downloaded the PowerShell script. |
104 | 104 |
|
105 |
| -2. Execute the following command to allow the script to run as it is an unsigned script (if you close the session before you complete all the steps, run this again for new session.) |
| 105 | +2. Run the following command to allow the script to run, because it's an unsigned script. (If you close the session before you complete all the steps, run this command again for the new session.) |
106 | 106 |
|
107 | 107 | ``` powershell-interactive
|
108 | 108 | Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
|
109 | 109 | ```
|
110 | 110 |
|
111 |
| -3. Execute the script |
| 111 | +3. Run the script: |
112 | 112 |
|
113 | 113 | ``` powershell-interactive
|
114 | 114 | ./resource-bridge-onboarding-script.ps1
|
115 | 115 | ```
|
116 | 116 |
|
117 | 117 | ### Linux
|
118 | 118 |
|
119 |
| -Follow the below instructions to run the script on a Linux machine: |
120 |
| -
|
121 |
| -1. Open the terminal and navigate to the folder where you have downloaded the bash script. |
| 119 | +1. Open the terminal and go to the folder where you've downloaded the Bash script. |
122 | 120 |
|
123 |
| -2. Execute the script using the following command: |
| 121 | +2. Run the script by using the following command: |
124 | 122 |
|
125 | 123 | ``` sh
|
126 | 124 | bash resource-bridge-onboarding-script.sh
|
127 | 125 | ```
|
128 | 126 |
|
129 | 127 | ## Inputs for the script
|
130 | 128 |
|
131 |
| -A typical onboarding using the script takes about 30-60 minutes and you will be prompted for the various details during the execution. Refer to the table below for information on them: |
| 129 | +A typical onboarding that uses the script takes 30 to 60 minutes. During the process, you're prompted for the following details: |
132 | 130 |
|
133 |
| -| **Requirements** | **Details** | |
| 131 | +| **Requirement** | **Details** | |
134 | 132 | | --- | --- |
|
135 |
| -| **Azure login** | Log in to Azure by visiting [this](https://www.microsoft.com/devicelogin) site and using the code when prompted. | |
136 |
| -| **vCenter FQDN/Address** | FQDN for the vCenter (or an ip address). </br> Eg: `10.160.0.1` or `nyc-vcenter.contoso.com` | |
137 |
| -| **vCenter Username** | Username for the vSphere account. The required permissions for the account are listed in the prerequisites above. | |
138 |
| -| **vCenter password** | Password for the vSphere account | |
139 |
| -| **Data center selection** | Select the name of the datacenter (as shown in vSphere client) where the Arc resource bridge VM should be deployed | |
140 |
| -| **Network selection** | Select the name of the virtual network or segment to which VM must be connected. This network should allow the appliance to talk to the vCenter server and the Azure endpoints (or internet). | |
141 |
| -| **Static IP / DHCP** | If you have DHCP server in your network and want to use it, type ‘y’ else ‘n’. On choosing static IP configuration, you will be asked the following </br> 1. `Static IP address prefix` : Network address in CIDR notation E.g. `192.168.0.0/24` </br> 2. `Static gateway`: Eg. `192.168.0.0` </br> 3. `DNS servers`: Comma-separated list of DNS servers </br> 4. `Start range IP`: Minimum size of 2 available addresses is required, one of the IP is for the VM, and another one is reserved for upgrade scenarios. Provide the start IP of that range </br> 5. `End range IP`: the last IP of the IP range requested in previous field. </br> 6. `VLAN ID` (Optional) | |
142 |
| -| **Resource pool** | Select the name of the resource pool to which the Arc resource bridge VM would be deployed | |
143 |
| -| **Data store** | Select the name of the datastore to be used for Arc resource bridge VM | |
144 |
| -| **Folder** | Select the name of the vSphere VM and Template folder where Arc resource bridge VM should be deployed. | |
145 |
| -| **VM template Name** | Provide a name for the VM template that will be created in your vCenter based on the downloaded OVA. Eg: arc-appliance-template | |
146 |
| -| **Control Pane IP** | Provide a reserved IP address (a reserved IP address in your DHCP range or a static IP outside of DHCP range but still available on the network). Ensure this IP address isn't assigned to any other machine on the network. | |
147 |
| -| **Appliance proxy settings** | Type ‘y’ if there is proxy in your appliance network, else type ‘n’. </br> You need to populate the following when you have proxy setup: </br> 1. `Http`: Address of http proxy server </br> 2. `Https`: Address of https proxy server </br> 3. `NoProxy`: Addresses to be excluded from proxy </br> 4. `CertificateFilePath`: For ssl based proxies, path to certificate to be used |
148 |
| -
|
149 |
| -Once the command execution completed, your setup is complete and you can try out the capabilities of Azure Arc-enabled VMware vSphere. You can proceed to the [next steps.](browse-and-enable-vcenter-resources-in-azure.md). |
| 133 | +| **Azure login** | When you're prompted, go to the [device sign-in page](https://www.microsoft.com/devicelogin), enter the authorization code shown in the terminal, and sign in to Azure. | |
| 134 | +| **vCenter FQDN/Address** | Enter the fully qualified domain name for the vCenter Server instance (or an IP address). For example: **10.160.0.1** or **nyc-vcenter.contoso.com**. | |
| 135 | +| **vCenter Username** | Enter the username for the vSphere account. The required permissions for the account are listed in the [prerequisites](#prerequisites). | |
| 136 | +| **vCenter password** | Enter the password for the vSphere account. | |
| 137 | +| **Data center selection** | Select the name of the datacenter (as shown in the vSphere client) where the Azure Arc resource bridge's VM should be deployed. | |
| 138 | +| **Network selection** | Select the name of the virtual network or segment to which the VM must be connected. This network should allow the appliance to communicate with vCenter Server and the Azure endpoints (or internet). | |
| 139 | +| **Static IP / DHCP** | If you have DHCP server in your network and want to use it, enter **y**. Otherwise, enter **n**. </br>When you choose a static IP configuration, you're asked for the following information: </br> 1. **Static IP address prefix**: Network address in CIDR notation. For example: **192.168.0.0/24**. </br> 2. **Static gateway**: Gateway address. For example: **192.168.0.0**. </br> 3. **DNS servers**: Comma-separated list of DNS servers. </br> 4. **Start range IP**: Minimum size of two available IP addresses is required. One IP address is for the VM, and the other is reserved for upgrade scenarios. Provide the starting IP of that range. </br> 5. **End range IP**: Last IP address of the IP range requested in the previous field. </br> 6. **VLAN ID** (optional) | |
| 140 | +| **Resource pool** | Select the name of the resource pool to which the Azure Arc resource bridge's VM will be deployed. | |
| 141 | +| **Data store** | Select the name of the datastore to be used for the Azure Arc resource bridge's VM. | |
| 142 | +| **Folder** | Select the name of the vSphere VM and the template folder where the Azure Arc resource bridge's VM will be deployed. | |
| 143 | +| **VM template Name** | Provide a name for the VM template that will be created in your vCenter Server instance based on the downloaded OVA file. For example: **arc-appliance-template**. | |
| 144 | +| **Control Pane IP** | Provide a reserved IP address in your DHCP range, or provide a static IP address that's outside the DHCP range but still available on the network. Ensure that this IP address isn't assigned to any other machine on the network. | |
| 145 | +| **Appliance proxy settings** | Enter **y** if there's a proxy in your appliance network. Otherwise, enter **n**. </br> You need to populate the following boxes when you have a proxy set up: </br> 1. **Http**: Address of the HTTP proxy server. </br> 2. **Https**: Address of the HTTPS proxy server. </br> 3. **NoProxy**: Addresses to be excluded from the proxy. </br> 4. **CertificateFilePath**: For SSL-based proxies, the path to the certificate to be used. |
| 146 | +
|
| 147 | +After the command finishes running, your setup is complete. You can now try out the capabilities of Azure Arc-enabled VMware vSphere. |
150 | 148 |
|
151 | 149 | ## Next steps
|
152 | 150 |
|
|
0 commit comments