Skip to main content
Pure Technical Services

vSphere Plugin User Guide: Installing the vSphere Plugin with the Pure Storage VMware Appliance

Currently viewing public documentation. Please login to access the full scope of documentation.

The Pure Storage Plugin for the vSphere Client provides the ability to VMware users to have insight into and control of their Pure Storage FlashArray environment while directly logged into the vSphere Client. The Pure Storage plugin extends the vSphere Client interface to include environmental statistics and objects that underpin the VMware objects in use and to provision new resources as needed.

Deploying the Pure Storage VMware Appliance

Requirements

  • Pure Storage Appliance OVA Requirements
    • 4 vCPUs and 8GB Memory
    • 3.6GB datastore space thin provisioned / 40GB datastore space thick provisioned
    • Supported to be deployed on vCenter 6.7 U3
    • Can be deployed on VMFS or vVols datastores
    • Single static IP address on management network (or DHCP scope) required
  • Pure Storage vSphere Plugin Requirements
    • IP address or FQDN of vCenter
    • A remote plugin OVA instance may be registered against a single vCenter instance or a set of vCenters that are in linked-mode.  For the linked-mode scenario, the plugin must be registered against every vCenter instance that is linked.  Non-linked vCenter instances each require their own Pure Storage VMware appliance.  
    • Please note that a unique folder will be created in vCenter to store individual FlashArrays.  It is important that these folder names are not changed or modified.  More information on vCenter Folders used with the vSphere Remote plugin can be found here.

Download Location

The Pure VMware Appliance is an OVA that can be downloaded from HERE.

Deployment Procedure

Deployment of the Pure Storage Appliance is very similar to a typical OVA deployment.  We outline the steps below.

To start, right-click on the cluster you wish to deploy the OVA to, and then select Deploy OVF Template...

install1.png

In the Deploy OVF template wizard, either provide the URL for the OVA or if it has been downloaded locally, select Local File, then click on Upload Files and choose the OVA file from your local hard drive.

install2.png

Click Next when the OVA file has been specified.

install3.png

Optionally provide a unique Virtual machine name and select a folder for it to be deployed into.  Click on Next when these selections have been made.

install4.png

Pick the ESXi cluster or Host where you want to deploy the OVA.  Click on Next once the selection has been made.

install5.png

Confirm the details selected thus far and then click on Next.

install6.png

Read the licensing agreement and then click the checkbox to accept to the licensing terms and click Next.

install7.png

Pick a storage device to install the OVA template to.  Optionally change the virtual disk format and/or select a VM storage policy and then click on Next.

install8.png

Pick the network you wish to use for the appliance.  Note that it must be routable to the vCenter management network.  Click on Next to continue.

install9.png

In the OVA customization template, at the top of the screen first pick the vSphere Remote Client Plugin option from the Appliance Type list.

install10.png

Keep the DHCP option selected if DHCP will be used, otherwise deselect it.

install11.png

If a static IP address is to be associated with the Pure VMware Appliance, fill out the relevant networking information including IP address, netmask, gateway, DNS Server(s).  Optionally specificy a custom hostname and if a Proxy is being used, supply the URL, Port and login information for the proxy.  Click on Next when finished filling out the required custom template fields.

install12.png

Review the details of the OVA deployment and then click on Finish to deploy.

install13.png

Once the OVA has finished deployment within vCenter, power it on to finish its configuration and to make it available to login to.

Configure the VMware Appliance and Register the vSphere Plugin

Perform these steps after the OVA has been installed in vCenter.

You are required to change the password for the pureuser account when you first log in. Be sure to note your new password. If pureuser cannot log in, you will have to redeploy the OVA to gain access.

  1. Open an SSH connection to the appliance using the OVA VM's DNS name or IP address displayed in vCenter.
  2. In the Pure VMware Appliance shell:
    1. On first login, you are prompted to change the pureuserpassword.
    2. Log back in to the appliance with the new password for the pureuseraccount.

Running the following command will confirm that the appliance is using the correct domain and DNS servers.  Both are required to be set for the plugin to function correctly.

$ puredns list

 If any DNS changes are required, run the following command:

$ puredns setattr --search <Domain Name> --nameserver <DNS Server(s)>

The vSphere Remote plugin is then installed to the vCenter instance by running the following command: 

$ pureplugin register --host <IP_or_FQDN_of_vCenter> --user <vSphere Administrative Account>

Optionally, the --plugin-fqdn <IP address or FQDN> argument can be appended to the above command line for instances where the plugin does not have external internet access.

A successful registration will appear within vCenter soon after.

plugin-deploy1.png

plugin-deploy2.png

Make sure that the Pure VMware appliance OVA remains powered on after the plugin has been registered to vCenter as it actively communicates with vCenter and stores relevant configuration information.

For environments where there are vCenter instances in linked-mode, repeat the pureplugin registration process for each unique vCenter IP address or FQDN.

Below is an example of two vCenter instances in linked-mode that have each been registered with the pureplugin command with their IP addresses:

$ pureplugin status
Plugin   Status   Version  Registrations
vSphere  running  5.0.0    10.21.143.120
                           10.21.143.150

It is important to note that multiple vCenter registrations agains the same appliance instance are only applicable to vCenters in linked-mode.  Non-linked vCenter instances will each require their own separate VMware appliance instance to be registered against.

Unregister the vSphere Plugin

  1. Open an SSH connection to the appliance using the OVA VM's DNS name or IP address displayed in vCenter.
  2. Login with thepureuseraccount.
  3. Run the following command:
$ pureplugin unregister --host <IP_or_FQDN_of_vCenter> --user <vSphere Administrative Account>

Technical Demo Video

A demo video showing how to deploy the OVA and register a vCenter instance with it can be viewed below.