vRealize Business for Cloud allows your to export a set of default reports. In addition, you can create and export customized reports based on these default reports according to your requirements.

Procedure

  1. Log in to vRealize Business for Cloud virtual appliance.
  2. Based on your setup, run one of the following commands to generate the token:
    • For vRealize Automation integrated vRealize Business for Cloud setup

      wget --no-check-certificate -S -q --header "Accept: application/json" --header='Content-Type: application/json' --post-data '{"username":"USER_NAME","password":"PASSWORD","tenant":"TENANT"}' -output-document - vRA_SERVER/identity/api/tokens

      where

      • USER_NAME is the user name with administrator permissions to access vRealize Business for Cloud.

      • PASSWORD is the password for the administrator account.

      • TENANT is the vRealize Business for Cloud registered tenant.

      • vRA_SERVER is the IP address or FQDN of the vRealize Automation server.

    • For VMware Identity Manager integrated vRealize Business for Cloud setup

      wget --no-check-certificate -S -q --post-data=string --header 'authorization: Basic CODE' --output-document - VIDM_SERVER/SAAS/API/1.0/oauth2/token?grant_type=client_credentials

      where

      • CODE is Base64(client_id:client_secret).

      • vIDM_SERVER is the IP address or FQDN of the VMware Identity Manager server.

    You see the token in the output. For example,

    HTTP/1.1 200 OK Server: Apache-Coyote/1.1 Cache-Control: no-cache, no-store Pragma: no-cache Expires: Wed, 31 Dec 1969 23:59:59 GMT Content-Type: application/json;charset=UTF-8 Content-Length: 383 Date: Wed, 25 Nov 2015 17:25:11 GMT {"expires":"2015-11-226T01:25:11.000Z","id": "MTQ0ODQ3MjMxMTQzMDo2MjlhMWU4MTdhOTEwNTM5Y2MyNzp0ZW5hbnQ6aXRibXN1c2VybmFtZTphZG1pbkBpdGJtcy5jb21AdnNwaGVyZS5sb2NhbGV4cGlyYXRpb246MTQ0O DUwMTExMTAwMDpjNTQzNjE3YjM3NDMyZTEwMTI4MzViZDNlYzEyNDA4MGQwMjI5NTVhMTU4OTUxNjM0ZDIzZjlhOTk4OTQ0ZDM5YmY2Y2UwZjUxNDVjYjRhNGUzZWZjMjNmYjM1 NGRjZDdkYTdlOGJjMzA1MjBhM2ZhZDg0NTdhYmNiMDEwZTA3OA==","tenant":"itbms"}

    The ID value is the token to authenticate.

    "MTQ0ODQ3MjMxMTQzMDo2MjlhMWU4MTdhOTEwNTM5Y2MyNzp0ZW5hbnQ6aXRibXN1c2VybmFtZTphZG1pbkBpdGJtcy5jb21AdnNwaGVyZS5sb2NhbGV4cGlyYXRpb246MTQ0O DUwMTExMTAwMDpjNTQzNjE3YjM3NDMyZTEwMTI4MzViZDNlYzEyNDA4MGQwMjI5NTVhMTU4OTUxNjM0ZDIzZjlhOTk4OTQ0ZDM5YmY2Y2UwZjUxNDVjYjRhNGUzZWZjMjNmYjM1 NGRjZDdkYTdlOGJjMzA1MjBhM2ZhZDg0NTdhYmNiMDEwZTA3OA=="

    Note:

    The token has an expiry date.

    "2015-11-226T01:25:11.000Z"

  3. Run the command to get a report that you want.

    Type of Report

    Command

    Custom report

    wget --no-check-certificate -S -q --header "Accept: application/json" --header='Content-Type: application/json' --header='Authorization: Bearer <TOKEN>' -O - https://VRB_SERVER/itfm-cloud/rest/reports-api/export-csv?name=REPORT_NAME, where

    • VRB_SERVER is the IP address or FQDN of the vRealize Business for Cloud server.

    • REPORT_NAME is the name you provide for a custom report.

    Default report

    • To export the complete data, run the following command.

      wget --no-check-certificate -S -q --header "Accept: text/plain" --header='Content-Type: text/plain' --header "accept-encoding: gzip" --header='Authorization: Bearer TOKEN' -O - https://VRB_SERVER/itfm-cloud/rest/reports/export-filters/DEFAULT_REPORT_NAME>>out.xls, where DEFAULT_REPORT_NAME, is the standard report names mentioned in the following table.

      Report Type

      Standard Report Name

      vCenter Server reports

      • servers

      • datastores

      • vsan-datastores

      • vms

      • clusters

      vCloud Director reports

      • vcd-orgs

      • vcd-org-vdcs

      • vcd-vms

      • vcd-vapps

      • vcd-cis

      vRealize Automation virtual machine reports

      • vcac-vms

      Storage reports

      • storage-arrays

      • storage-luns

      AWS reports

      • aws-resources

      • aws-vms

      Showback reports

      • showback-vms

      • showback-add-svcs

      Budget reports

      rest/budget/export

    • To export a report for a specific period, run the following command.

      wget --no-check-certificate -S -q --header "Accept: text/plain" --header='Content-Type: text/plain' --header "accept-encoding: gzip" --header='Authorization: Bearer <TOKEN>' -O - 'https://VRB_SERVER/itfm-cloud/rest/reports/export-filters/DEFAULT_REPORT_NAME?startmonth=yyyy-mm&&endmonth=yyyy-mm'>>out.xls, where DEFAULT_REPORT_NAME is the standard report names mentioned in the table.

      • If you specify startmonth and endmonth, vRealize Business for Cloud generates a report from the first day of the month you specify in startmonth till the month that you specify in endmonth (till the last day of previous month.)

        For example, if you enter startmonth=2016-02&&endmonth=2016-06, you see the report is exported from first day of February till the last day of May.

      • If you specify startmonth only, vRealize Business for Cloud generates report from the first day of the month you specified till the current month.

        For example, if you specify startmonth=2016-02, you see the report is exported from the first day of February till the current month.

      • If you specify endmonth only, vRealize Business for Cloud generates report from the month the data is available till the month that you specified in the endmonth (till the last day of the previous month).

        For example, if you specify endmonthendmonth=2016-10, you see the report is exported till the last day of September.

      Note:

      You can specify the period for the vCenter Server virtual machine reports (vms), vRealize Automation virtual machine reports (vcac-vms), AWS reports (aws-vms, aws-resources), and Showback reports (showback-vms, showback-add-svcs). You cannot generate vCloud Director and budget reports for a specific period.

    You see the reports are exported in the CSV or XLS format.

    vCloud Director data at organization level

    wget --no-check-certificate -S -q --header "Accept: application/json" --header='Content-Type: application/json' --header "accept-encoding: gzip" --header='Authorization: Bearer <TOKEN>' -O - https://VRB_SERVER/itfm-cloud/rest/reports/v1/vcd/organization?month=01.MM.YYYY, where

    • VRB_SERVER is the IP address or FQDN of the vRealize Business for Cloud server.

    • 01.MM.YYYY is the parameter to specify the month for which you want the report. Only the month and year values can be modified in the parameter. The date value must be 01. For example, 01.02.2017. If you do not include the ?month=01.MM.YYYY parameter in the command, the month-to-date details for the current month is generated in the report.

    vCloud Director data specific to an organization

    wget --no-check-certificate -S -q --header "Accept: application/json" --header='Content-Type: application/json' --header "accept-encoding: gzip" --header='Authorization: Bearer <TOKEN>' -O - https://VRB_SERVER/itfm-cloud/rest/reports/v1/vcd/organization/{orgId}?month=01.MM.YYYY, where

    • VRB_SERVER is the IP address or FQDN of the vRealize Business for Cloud server.

    • 01.MM.YYYY is the parameter to specify the month for which you want the report. Only the month and year values can be modified in the parameter. The date value must be 01. For example, 01.02.2017. If you do not include the ?month=01.MM.YYYY parameter in the command, the month-to-date details for the current month is generated in the report.

    vCloud Director data at organization vDC level

    wget --no-check-certificate -S -q --header "Accept: application/json" --header='Content-Type: application/json' --header "accept-encoding: gzip" --header='Authorization: Bearer <TOKEN>' -O - https://VRB_SERVER/itfm-cloud/rest/reports/v1/vcd/orgVdc?month=01.MM.YYYY, where

    • VRB_SERVER is the IP address or FQDN of the vRealize Business for Cloud server.

    • 01.MM.YYYY is the parameter to specify the month for which you want the report. Only the month and year values can be modified in the parameter. The date value must be 01. For example, 01.02.2017. If you do not include the ?month=01.MM.YYYY parameter in the command, the month-to-date details for the current month is generated in the report.

    vCloud Director data specific to an organization vDC

    wget --no-check-certificate -S -q --header "Accept: application/json" --header='Content-Type: application/json' --header "accept-encoding: gzip" --header='Authorization: Bearer <TOKEN>' -O - https://VRB_SERVER/itfm-cloud/rest/reports/v1/vcd/orgVdc/{orgVdcId}?month=01.mm.yyyy, where

    • VRB_SERVER is the IP address or FQDN of the vRealize Business for Cloud server.

    • 01.MM.YYYY is the parameter to specify the month for which you want the report. Only the month and year values can be modified in the parameter. The date value must be 01. For example, 01.02.2017. If you do not include the ?month=01.MM.YYYY parameter in the command, the month-to-date details for the current month is generated in the report.

    vCloud Director data at vApps level

    wget --no-check-certificate -S -q --header "Accept: application/json" --header='Content-Type: application/json' --header "accept-encoding: gzip" --header='Authorization: Bearer <TOKEN>' -O - https://VRB_SERVER/itfm-cloud/rest/reports/v1/vcd/vapp?month=01.MM.YYYY, where

    • VRB_SERVER is the IP address or FQDN of the vRealize Business for Cloud server.

    • 01.MM.YYYY is the parameter to specify the month for which you want the report. Only the month and year values can be modified in the parameter. The date value must be 01. For example, 01.02.2017. If you do not include the ?month=01.MM.YYYY parameter in the command, the month-to-date details for the current month is generated in the report.

    vCloud Director data specific to a vApp

    wget --no-check-certificate -S -q --header "Accept: application/json" --header='Content-Type: application/json' --header "accept-encoding: gzip" --header='Authorization: Bearer <TOKEN>' -O - https://VRB_SERVER/itfm-cloud/rest/reports/v1/vcd/vapp/{vappId}?month=01.MM.YYYY, where

    • VRB_SERVER is the IP address or FQDN of the vRealize Business for Cloud server.

    • 01.MM.YYYY is the parameter to specify the month for which you want the report. Only the month and year values can be modified in the parameter. The date value must be 01. For example, 01.02.2017. If you do not include the ?month=01.MM.YYYY parameter in the command, the month-to-date details for the current month is generated in the report.

    vCloud Director data at VMs level

    wget --no-check-certificate -S -q --header "Accept: application/json" --header='Content-Type: application/json' --header "accept-encoding: gzip" --header='Authorization: Bearer <TOKEN>' -O - https://VRB_SERVER/itfm-cloud/rest/reports/v1/vcd/vm?month=01.MM.YYYY, where

    • VRB_SERVER is the IP address or FQDN of the vRealize Business for Cloud server.

    • 01.MM.YYYY is the parameter to specify the month for which you want the report. Only the month and year values can be modified in the parameter. The date value must be 01. For example, 01.02.2017. If you do not include the ?month=01.MM.YYYY parameter in the command, the month-to-date details for the current month is generated in the report.

    vCloud Director data specific to a VM

    wget --no-check-certificate -S -q --header "Accept: application/json" --header='Content-Type: application/json' --header "accept-encoding: gzip" --header='Authorization: Bearer <TOKEN>' -O - https://VRB_SERVER/itfm-cloud/rest/reports/v1/vcd/vm?month=01.MM.YYYY , where

    • VRB_SERVER is the IP address or FQDN of the vRealize Business for Cloud server.

    • 01.MM.YYYY is the parameter to specify the month for which you want the report. Only the month and year values can be modified in the parameter. The date value must be 01. For example, 01.02.2017. If you do not include the ?month=01.MM.YYYY parameter in the command, the month-to-date details for the current month is generated in the report.

    vCloud Director daily details at organization vDC level

    wget --no-check-certificate -S -q --header "Accept: application/json" --header='Content-Type: application/json' --header "accept-encoding: gzip" --header='Authorization: Bearer <TOKEN>' -O - https://VRB_SERVER/itfm-cloud/rest/reports/v1/vcd/orgVdc/daily

    Note:

    Service level details are not provided for this report.

    vCloud Director daily details at VM level

    wget --no-check-certificate -S -q --header "Accept: application/json" --header='Content-Type: application/json' --header "accept-encoding: gzip" --header='Authorization: Bearer <TOKEN>' -O - https://VRB_SERVER/itfm-cloud/rest/reports/v1/vcd/vm/daily