パブリック API を使用した vRealize Business for Cloud レポートの生成

vRealize Business for Cloud では、一連のデフォルトのレポートをエクスポートすることができます。また、要件に従い、これらのデフォルトのレポートに基づいてカスタマイズされたレポートを作成およびエクスポートすることもできます。

手順

vRealize Business for Cloud 仮想アプライアンスにログインします。
設定に基づき、次のいずれかのコマンドを実行してトークンを生成します。
- vRealize Automation を統合した vRealize Business for Cloud 設定の場合
  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
  値の意味は、次のとおりです。
  - USER_NAME は、vRealize Business for Cloud にアクセスするための管理者権限を持つユーザー名です。
  - PASSWORD は管理者アカウントのパスワードです。
  - TENANT は vRealize Business for Cloud で登録されたテナントです。
  - vRA_SERVER は vRealize Automation サーバの IP アドレスまたは FQDN です。
- VMware Identity Manager を統合した vRealize Business for Cloud 設定の場合
  curl -k -X POST -H "Authorization:Basic CODE" https://vIDM_SERVER/SAAS/API/1.0/oauth2/token?grant_type=client_credentials
  値の意味は、次のとおりです。
  - CODE は Base64(client_id:client_secret) です。
  - vIDM_SERVER は VMware Identity Manager サーバの IP アドレスまたは FQDN です。
注：
https://www.base64encode.org/を使用して、基本認証ヘッダーの Base64 を生成できます。また、/server/conf/itfm-oauth.properties から client_id および client_secret の値を取得することもできます。

出力にトークンが表示されます。次に例を示します。

{"access_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJqdGkiOiIyYzJlZDRjMi0wYjcyLTQ5MDYtODE3MC0wYzhjYjUzNjJjNTMiLCJwcm4iOiJ2cmJfb2F1dGhfY2xpZW50aWRfYzk5ODUzYzYtMmY5MC00OTMwLWI2ZjktYzJjM2U3YmQ5Nzk5QEJMUi1WMTQ0LUlQLTE4NCIsImRvbWFpbiI6IlN5c3RlbSBEb21haW4iLCJ1c2VyX2lkIjoiMTkwIiwiYXV0aF90aW1lIjoxNTUzMjAyMDExLCJpc3MiOiJodHRwczovL2Jsci12MTQ0LWlwLTE4NC5lbmcudm13YXJlLmNvbS9TQUFTL2F1dGgiLCJhdWQiOiJodHRwczovL2Jsci12MTQ0LWlwLTE4NC5lbmcudm13YXJlLmNvbS9TQUFTL2F1dGgvb2F1dGh0b2tlbiIsImN0eCI6Ilt7XCJtdGRcIjpcInVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMDphYzpjbGFzc2VzOlBhc3N3b3JkUHJvdGVjdGVkVHJhbnNwb3J0XCIsXCJpYXRcIjoxNTUzMjAyMDExLFwiaWRcIjoxNX1dIiwic2NwIjoib3BlbmlkIGFkbWluIHVzZXIiLCJpZHAiOiIwIiwiZW1sIjoiT0F1dGhDbGllbnRfdnJiX29hdXRoX2NsaWVudGlkX2M5OTg1M2M2MmY5MDQ5MzBiNmY5YzJjM2U3YmQ5Nzk5QG5vcmVwbHkuY29tIiwiY2lkIjoidnJiX29hdXRoX2NsaWVudGlkX2M5OTg1M2M2LTJmOTAtNDkzMC1iNmY5LWMyYzNlN2JkOTc5OSIsImRpZCI6IiIsIndpZCI6IiIsInJ1bGVzIjp7ImV4cGlyeSI6MTU1MzIzMDgxMSwicnVsZXMiOlt7InJlc291cmNlcyI6WyIqIl0sImFjdGlvbnMiOlsiKiJdLCJjb25kaXRpb25zIjpudWxsfV0sImxpbmsiOm51bGx9LCJleHAiOjE1NTMyMzA4MTEsImlhdCI6MTU1MzIwMjAxMSwic3ViIjoiMzU3OTEyZGMtYWJkZS00YjIwLWI1MGQtY2I5ZDhhZmRiZTQ4IiwicHJuX3R5cGUiOiJTRVJWSUNFIn0.TEsB5mkpXED7VzuhiL66I4ls6cEYsWUcq_iKetDmTFxi8xQXr56uDChOBQtUerGkDXdKht6QflVd86BtqOTyBKYr8ndlD14DqujhRHq3aB5HmFA4jVB-vr7nhJNzpCHwD1BKWwjyTvCdMccYC-vwpCHx_dcEdbJiqdpejJPJfNbsN8MITUQtk_yk2ia3fkrBRt8Pv_VPm-xYIC_qHumaEiompB_iRLk3AfnZgx7yhdv3yarGrocFWKsizvpRbfFsf3T3EPIzACV_bGoX-syvGW9sdEjWlsBidSNRTgdOTaikIwoW1cyc3WbMeThIx7PeRop_Z-DB5a0yvL6uWfWNtw","token_type":"Bearer","expires_in":28799,"scope":"openid admin user","id_token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6IjE1NDkzNjI4MzYifQ.eyJ1cGRhdGVkX2F0IjowLCJleHAiOjE1NTMyMDIxMzEsImlhdCI6MTU1MzIwMjAxMSwic3ViIjoidnJiX29hdXRoX2NsaWVudGlkX2M5OTg1M2M2LTJmOTAtNDkzMC1iNmY5LWMyYzNlN2JkOTc5OUBCTFItVjE0NC1JUC0xODQiLCJpc3MiOiJodHRwczovL2Jsci12MTQ0LWlwLTE4NC5lbmcudm13YXJlLmNvbS9TQUFTL2F1dGgiLCJhdWQiOlsidnJiX29hdXRoX2NsaWVudGlkX2M5OTg1M2M2LTJmOTAtNDkzMC1iNmY5LWMyYzNlN2JkOTc5OSJdLCJhdXRoX3RpbWUiOjE1NTMyMDIwMTEsImF6cCI6InZyYl9vYXV0aF9jbGllbnRpZF9jOTk4NTNjNi0yZjkwLTQ5MzAtYjZmOS1jMmMzZTdiZDk3OTkiLCJhdF9oYXNoIjoicGR6ajhEX2kyVUt2bWc1YWlSRnVUdyJ9.LD0SOVvPhxUno06ATZyE1__MI0xNcgzdR9JTT2yxBkaWf3x11nKijfaasTClgGy4llo0FJezmYAQkuCese3ge2Ub2ZBOHZ9bN98yjVXzQ5BzLZarImD727YYUiauB-pPmyvjaW-K2QH7-bIAQ8OMO0gxP_cYuol61oo9N3hwU4ocJqg2M-ir_B3PHUG5S0Ads2tlrmoObuYQ_YeMhSMyBGKCQuqgjU_Eva3PoaEaDRCRiffDVYCc0CHw08Qcb6PtcoHaltWlhWm93gBrUw4fHZKhMspapuLVFBZF7jZF56D9JJR-M2w2LiZYRRg-a_97wZ9MO810ASbFfehB__LspQ"}

access_token 値は、認証に使用するトークンです。

"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJqdGkiOiIyYzJlZDRjMi0wYjcyLTQ5MDYtODE3MC0wYzhjYjUzNjJjNTMiLCJwcm4iOiJ2cmJfb2F1dGhfY2xpZW50aWRfYzk5ODUzYzYtMmY5MC00OTMwLWI2ZjktYzJjM2U3YmQ5Nzk5QEJMUi1WMTQ0LUlQLTE4NCIsImRvbWFpbiI6IlN5c3RlbSBEb21haW4iLCJ1c2VyX2lkIjoiMTkwIiwiYXV0aF90aW1lIjoxNTUzMjAyMDExLCJpc3MiOiJodHRwczovL2Jsci12MTQ0LWlwLTE4NC5lbmcudm13YXJlLmNvbS9TQUFTL2F1dGgiLCJhdWQiOiJodHRwczovL2Jsci12MTQ0LWlwLTE4NC5lbmcudm13YXJlLmNvbS9TQUFTL2F1dGgvb2F1dGh0b2tlbiIsImN0eCI6Ilt7XCJtdGRcIjpcInVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMDphYzpjbGFzc2VzOlBhc3N3b3JkUHJvdGVjdGVkVHJhbnNwb3J0XCIsXCJpYXRcIjoxNTUzMjAyMDExLFwiaWRcIjoxNX1dIiwic2NwIjoib3BlbmlkIGFkbWluIHVzZXIiLCJpZHAiOiIwIiwiZW1sIjoiT0F1dGhDbGllbnRfdnJiX29hdXRoX2NsaWVudGlkX2M5OTg1M2M2MmY5MDQ5MzBiNmY5YzJjM2U3YmQ5Nzk5QG5vcmVwbHkuY29tIiwiY2lkIjoidnJiX29hdXRoX2NsaWVudGlkX2M5OTg1M2M2LTJmOTAtNDkzMC1iNmY5LWMyYzNlN2JkOTc5OSIsImRpZCI6IiIsIndpZCI6IiIsInJ1bGVzIjp7ImV4cGlyeSI6MTU1MzIzMDgxMSwicnVsZXMiOlt7InJlc291cmNlcyI6WyIqIl0sImFjdGlvbnMiOlsiKiJdLCJjb25kaXRpb25zIjpudWxsfV0sImxpbmsiOm51bGx9LCJleHAiOjE1NTMyMzA4MTEsImlhdCI6MTU1MzIwMjAxMSwic3ViIjoiMzU3OTEyZGMtYWJkZS00YjIwLWI1MGQtY2I5ZDhhZmRiZTQ4IiwicHJuX3R5cGUiOiJTRVJWSUNFIn0.TEsB5mkpXED7VzuhiL66I4ls6cEYsWUcq_iKetDmTFxi8xQXr56uDChOBQtUerGkDXdKht6QflVd86BtqOTyBKYr8ndlD14DqujhRHq3aB5HmFA4jVB-vr7nhJNzpCHwD1BKWwjyTvCdMccYC-vwpCHx_dcEdbJiqdpejJPJfNbsN8MITUQtk_yk2ia3fkrBRt8Pv_VPm-xYIC_qHumaEiompB_iRLk3AfnZgx7yhdv3yarGrocFWKsizvpRbfFsf3T3EPIzACV_bGoX-syvGW9sdEjWlsBidSNRTgdOTaikIwoW1cyc3WbMeThIx7PeRop_Z-DB5a0yvL6uWfWNtw"

注：
トークンには有効期限があります。

レポートを指定して取得するには、コマンドを実行します。

レポートのタイプ

コマンド

カスタムレポート

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。値の意味は、次のとおりです。

VRB_SERVER は vRealize Business for Cloud サーバの IP アドレスまたは FQDN です。
REPORT_NAME は、カスタムレポートに設定する名前です。

デフォルトレポート

完全なデータをエクスポートするには、次のコマンドを実行します。

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。ここで、DEFAULT_REPORT_NAME は以下の表に示す標準のレポート名です。

レポートタイプ	標準のレポート名
vCenter Server レポート	`servers` `datastores` `vsan-datastores` `vms` `clusters`
vCloud Director レポート	`vcd-orgs` `vcd-org-vdcs` `vcd-vms` `vcd-vapps` `vcd-cis`
vRealize Automation 仮想マシンレポート	`vcac-vms`
ストレージレポート	`storage-arrays` `storage-luns`
AWS レポート	`aws-resources` `aws-vms`
ショーバックレポート	`showback-vms` `showback-add-svcs`
予算レポート	`rest/budget/export`

特定の期間のレポートをエクスポートするには、次のコマンドを実行します。
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。ここで、DEFAULT_REPORT_NAME はテーブルに記載されている標準レポート名です。
- startmonth および endmonth を指定すると、vRealize Business for Cloud は startmonth で指定した月の第 1 日目から endmonth で指定した月まで（前月の最終日まで）のレポートを生成します。
  たとえば、startmonth=2016-02&&endmonth=2016-06 と入力した場合は、2 月の第 1 日目から 5 月の最終日までのレポートが生成されます。
- startmonth のみを指定すると、vRealize Business for Cloud では指定した月の第 1 日目から、現在の月までのレポートが生成されます。
  たとえば、startmonth=2016-02 と指定すると、2 月の第 1 日目から現在の月までのレポートがエクスポートされます。
- endmonth のみを指定すると、vRealize Business for Cloud では、データを利用できる月から、endmonth で指定した月まで（前月の最終日まで）のレポートが生成されます。
  たとえば、endmonthendmonth=2016-10 と指定すると、9 月の最終日までのレポートがエクスポートされます。
注：
vCenter Server 仮想マシンレポート (vms)、vRealize Automation 仮想マシンレポート (vcac-vms)、AWS レポート（aws-vms、aws-resources）、およびショーバックレポート（showback-vms、showback-add-svcs）の期間を指定できます。特定期間の vCloud Director レポートおよび予算レポートを生成することはできません。

レポートは CSV または XLS 形式でエクスポートされます。

組織レベルの vCloud Director データ

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。ここで、

VRB_SERVER は vRealize Business for Cloud サーバの IP アドレスまたは FQDN です。
01.MM.YYYY はレポートを確認する月を指定するパラメータです。このパラメータでは、月と年の値のみを変更できます。日付の値は、01 にする必要があります。たとえば、01.02.2017 のような形式で指定します。コマンドに ?month=01.MM.YYYYパラメータを含めない場合は、当月の当日までの詳細がレポートに生成されます。

組織に固有の vCloud Director データ

VRB_SERVER は vRealize Business for Cloud サーバの IP アドレスまたは FQDN です。
01.MM.YYYY はレポートを確認する月を指定するパラメータです。このパラメータでは、月と年の値のみを変更できます。日付の値は、01 にする必要があります。たとえば、01.02.2017 のような形式で指定します。コマンドに ?month=01.MM.YYYYパラメータを含めない場合は、当月の当日までの詳細がレポートに生成されます。

組織仮想データセンターレベルの vCloud Director データ

VRB_SERVER は vRealize Business for Cloud サーバの IP アドレスまたは FQDN です。
01.MM.YYYY はレポートを確認する月を指定するパラメータです。このパラメータでは、月と年の値のみを変更できます。日付の値は、01 にする必要があります。たとえば、01.02.2017 のような形式で指定します。コマンドに ?month=01.MM.YYYYパラメータを含めない場合は、当月の当日までの詳細がレポートに生成されます。

組織仮想データセンターに固有の vCloud Director データ

VRB_SERVER は vRealize Business for Cloud サーバの IP アドレスまたは FQDN です。
01.MM.YYYY はレポートを確認する月を指定するパラメータです。このパラメータでは、月と年の値のみを変更できます。日付の値は、01 にする必要があります。たとえば、01.02.2017 のような形式で指定します。コマンドに ?month=01.MM.YYYYパラメータを含めない場合は、当月の当日までの詳細がレポートに生成されます。

vApp レベルの vCloud Director データ

VRB_SERVER は vRealize Business for Cloud サーバの IP アドレスまたは FQDN です。
01.MM.YYYY はレポートを確認する月を指定するパラメータです。このパラメータでは、月と年の値のみを変更できます。日付の値は、01 にする必要があります。たとえば、01.02.2017 のような形式で指定します。コマンドに ?month=01.MM.YYYYパラメータを含めない場合は、当月の当日までの詳細がレポートに生成されます。

vApp に固有の vCloud Director データ

VRB_SERVER は vRealize Business for Cloud サーバの IP アドレスまたは FQDN です。
01.MM.YYYY はレポートを確認する月を指定するパラメータです。このパラメータでは、月と年の値のみを変更できます。日付の値は、01 にする必要があります。たとえば、01.02.2017 のような形式で指定します。コマンドに ?month=01.MM.YYYYパラメータを含めない場合は、当月の当日までの詳細がレポートに生成されます。

仮想マシンレベルの vCloud Director データ

VRB_SERVER は vRealize Business for Cloud サーバの IP アドレスまたは FQDN です。
01.MM.YYYY はレポートを確認する月を指定するパラメータです。このパラメータでは、月と年の値のみを変更できます。日付の値は、01 にする必要があります。たとえば、01.02.2017 のような形式で指定します。コマンドに ?month=01.MM.YYYYパラメータを含めない場合は、当月の当日までの詳細がレポートに生成されます。

仮想マシンに固有の vCloud Director データ

VRB_SERVER は vRealize Business for Cloud サーバの IP アドレスまたは FQDN です。
01.MM.YYYY はレポートを確認する月を指定するパラメータです。このパラメータでは、月と年の値のみを変更できます。日付の値は、01 にする必要があります。たとえば、01.02.2017 のような形式で指定します。コマンドに ?month=01.MM.YYYYパラメータを含めない場合は、当月の当日までの詳細がレポートに生成されます。

組織仮想データセンターレベルの vCloud Director の日次詳細

注：

このレポートでは、サービスレベルの詳細は提供されません。

仮想マシンレベルの vCloud Director の日次詳細