To deploy vCloud Usage Meter, you configure a REST API request and provide the parameters for the vCloud Usage Meter environment.

Prerequisites

  • You must meet all requirements before deploying vCloud Usage Meter. For information, see Before you deploy vCloud Usage Meter.
  • Verify that the vCloud Usage Meter version you want to deploy is supported by VMware Cloud Provider Lifecycle Manager. For information about the interoperability between VMware Cloud Provider Lifecycle Manager 1.1 and other VMware products, see the VMware Product Interoperability Matrix.
  • In the usage/version-number/ova directory on the VMware Cloud Provider Lifecycle Manager host, save the vCloud Usage Meter OVA file.

Procedure

  1. In your Web browser start Postman and configure the following HTTPS request.
    1. On the Headers tab, add the JSESSION ID.
      Setting Value
      JSESSIONID vcp_lcm_session_id
    2. To deploy vCloud Usage Meter, configure the following HTTPS request.
      Setting Value
      HTTPS request method GET
      URL https://vcp_lcm_ip_address:port-number/api/api_versionlcm/environment?action=DEPLOY
      Body
      {
          "environmentName": "{{um_env_id}}",
          "products": [
              {
                  "properties": {
                      "auditorPassword": "{{password}}",
                      "proxy": {
                          "type": "none"
                      }
                  },
                  "productType": "USAGE",
                  "productId": "{{um_product_id}}",
                  "version": "usage_meter_version",
                  "adminPassword": "{{password}}",
                  "integrations": [
                      {
                          "integrationId": "um-01-to-vc-01",
                          "datacenterComponentType": "VCENTER",
                          "hostname": "{{vcenter_hostname}}.{{domainName}}",
                          "integrationUsername": "administrator@vsphere.local",
                          "integrationPassword": "{{vc_password}}",
                          "properties": {
                              "externalSSO": false,
                              "vcfEdition": "Enterprise"
                          }
                      },
                  "nodes": [
                      {
                          "hostName": "{{usage_meter_name}}.{{domainName}}",
                          "vmName": "{{usage_meter_name}}",
                          "rootPassword": "{{password}}",
                          "nics": [
                              {
                                  "ipAddress": "{{usage_meter_ip}}",
                                  "networkName": "mgmt-nw"
                              }
                          ]
                      }
                  ]
              }
          ],
          "deploymentInfrastructures": {
              "infra1": {
                  "vcenter": {
                      "vcenterName": "mgmt-vc",
                      "vcenterHost": "{{vcenter_hostname}}.{{domainName}}",
                      "vcenterUsername": "administrator@vsphere.local",
                      "vcenterPassword": "{{vc_password}}",
                      "datacenterName": "{{vc_datacenter}}",
                      "clusterName": "{{vc_cluster}}",
                      "resourcePool": "{{vc_res_pool}}",
                      "datastores": [
                          "{{vc_datastore}}"
                      ],
                      "networks": {
                          "mgmt-nw": {
                              "portGroupName": "{{mgmt_nw_portgroup}}",
                              "gateway": "{{mgmt_nw_gateway}}",
                              "subnetMask": "{{mgmt_nw_subnet}}",
                              "domainName": "{{domainName}}",
                              "searchPath": [
                                  "{{domainName}}"
                              ],
                              "useDhcp": false,
                              "dns": [
                                  "{{dns}}"
                              ],
                              "ntp": [
                                  "{{ntp}}"
                              ]
                          }
                      }
                  }
              }
          }
      }
  2. (Optional) You can specify the following additional properties for vCloud Usage Meter.
    Property Value Type Mandatory Description
    diskMode VC disk mode No The vCenter disk mode for the virtual disk to create. Possible values
    • thin
    • thick
    • eagerZeroedThickDefault: thin
    auditorPassword password string No The password for the umauditor account. If not defined, the admin password is configured.
    proxy sub elements No Properties needed to configure a Proxy server
    proxy.type string type (HTTP or HTTPS) Yes

    The Proxy protocol type. Supported types:

    • VCPLCM 1.0.0: HTTP and HTTPS
    • starting with version 1.0.1: none, http and https
    proxy.host string (hostname or IP address) Yes Proxy hostname or IP address
    proxy.port string (port number) No Proxy listening port
    proxy.user string (username) No Proxy user. If not defined, it can be avoided in the payload.
    proxy.password string No The proxy user password. If not defined, it can be avoided in the payload.
  3. Register the vCloud Usage Meter instance with Commerce Portal. For information, see How do I register Usage Meter instances for automatic reporting of Rental contracts.
  4. To register product servers with vCloud Usage Meter, configure the following HTTPS request.
    1. On the Headers tab, add the JSESSION ID.
      Setting Value
      JSESSIONID vcp_lcm_session_id
    2. To deploy vCloud Usage Meter, configure the following HTTPS request.
      Setting Value
      HTTPS request method GET
      URL https://vcp_lcm_ip_address:port-number/api/api_versionlcm/environment?action=DEPLOY
      Body
      {
          "environmentName": "{{um_env_id}}",
          "products": [
              {
                  "properties": {
                      "auditorPassword": "{{password}}",
                      "proxy": {
                          "type": "none"
                      }
                  },
                  "productType": "USAGE",
                  "productId": "{{um_product_id}}",
                  "version": "usage_meter_version",
                  "adminPassword": "{{password}}",
                  "integrations": [
                      {
                          "integrationId": "um-01-to-vc-01",
                          "datacenterComponentType": "VCENTER",
                          "hostname": "{{vcenter_hostname}}.{{domainName}}",
                          "integrationUsername": "administrator@vsphere.local",
                          "integrationPassword": "{{vc_password}}",
                          "properties": {
                              "externalSSO": false,
                              "vcfEdition": "Enterprise"
                          }
                      },
                      {
                          "integrationId": "um-01-to-nsx-01",
                          "datacenterComponentType": "NSXT",
                          "hostname": "{{nsxt_hostname}}.{{domainName}}",
                          "integrationUsername": "admin",
                          "integrationPassword": "{{nsx_password}}"
                      },
                      {
                          "integrationId": "um-01-to-vcd-01",
                          "productType": "VCD",
                          "hostname": "{{vcd_lb_ip}}",
                          "integrationUsername": "administrator@system",
                          "integrationPassword": "{{password}}"
                      },
                      {
                          "integrationId": "um-01-to-vrops-01",
                          "datacenterComponentType": "VROPS",
                          "hostname": "{{vrops_ip}}",
                          "integrationUsername": "admin",
                          "integrationPassword": "{{vrops_password}}",
                          "properties": {
                              "vcReferences": ["um-01-to-vc-01"],
                              "enableAutodiscovery": false
                          }
                      }
                  ],
                  "nodes": [
                      {
                          "hostName": "{{usage_meter_name}}.{{domainName}}",
                          "vmName": "{{usage_meter_name}}",
                          "rootPassword": "{{password}}",
                          "nics": [
                              {
                                  "ipAddress": "{{usage_meter_ip}}",
                                  "networkName": "mgmt-nw"
                              }
                          ]
                      }
                  ]
              }
          ],
          "deploymentInfrastructures": {
              "infra1": {
                  "vcenter": {
                      "vcenterName": "mgmt-vc",
                      "vcenterHost": "{{vcenter_hostname}}.{{domainName}}",
                      "vcenterUsername": "administrator@vsphere.local",
                      "vcenterPassword": "{{vc_password}}",
                      "datacenterName": "{{vc_datacenter}}",
                      "clusterName": "{{vc_cluster}}",
                      "resourcePool": "{{vc_res_pool}}",
                      "datastores": [
                          "{{vc_datastore}}"
                      ],
                      "networks": {
                          "mgmt-nw": {
                              "portGroupName": "{{mgmt_nw_portgroup}}",
                              "gateway": "{{mgmt_nw_gateway}}",
                              "subnetMask": "{{mgmt_nw_subnet}}",
                              "domainName": "{{domainName}}",
                              "searchPath": [
                                  "{{domainName}}"
                              ],
                              "useDhcp": false,
                              "dns": [
                                  "{{dns}}"
                              ],
                              "ntp": [
                                  "{{ntp}}"
                              ]
                          }
                      }
                  }
              }
          }
      }

Results

If the deployment is successful, you see an OK (200) status and "taskId":id-number. To check the status of the deployment, see Retrieve the status of a VMware Cloud Provider Lifecycle Manager task.