Usar la API pública para generar informes de vRealize Business for Cloud

vRealize Business for Cloud le permite exportar un conjunto de informes predeterminados. Además, puede crear y exportar informes personalizados basados en estos informes predeterminados según sus necesidades.

Procedimiento

Inicie sesión en el dispositivo virtual de vRealize Business for Cloud.
En función de la instalación, ejecute uno de los siguientes comandos para generar el token:
- Para la instalación de vRealize Business for Cloud integrada con vRealize Automation
  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
  Donde:
  - USER_NAME es el nombre de usuario con permisos de administrador para acceder a vRealize Business for Cloud.
  - PASSWORD es la contraseña para la cuenta de administrador.
  - TENANT es el arrendatario registrado de vRealize Business for Cloud.
  - vRA_SERVER es la dirección IP o el FQDN del servidor de vRealize Automation.
- Para la instalación de vRealize Business for Cloud integrada con VMware Identity Manager
  curl -k -X POST -H "Authorization:Basic CODE" https://vIDM_SERVER/SAAS/API/1.0/oauth2/token?grant_type=client_credentials
  Donde:
  - CODE es Base64(client_id:client_secret).
  - vIDM_SERVER es la dirección IP o el FQDN del servidor de VMware Identity Manager.
Nota:
Puede generar Base64 de encabezado de autenticación básica mediante: https://www.base64encode.org/. También puede obtener los valores de client_id y client_secret de /server/conf/itfm-oauth.properties.

Puede ver el token en la salida. Por ejemplo,

{"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"}

El valor de access_token es el token para la autenticación.

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

Nota:
El token tiene una hora de vencimiento.

Ejecute el comando para obtener el informe que desea.

Tipo de informe

Comando

Informe personalizado

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, donde:

VRB_SERVER es la dirección IP o el FQDN del servidor de vRealize Business for Cloud.
REPORT_NAME es el nombre que se proporciona para un informe personalizado.

Informe predeterminado

Para exportar todos los datos, ejecute el siguiente comando.

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, donde DEFAULT_REPORT_NAME es el nombre del informe estándar mencionado en la tabla siguiente.

Tipo de informe	Nombre de informe estándar
Informes de vCenter Server	`servers` `datastores` `vsan-datastores` `vms` `clusters`
Informes de vCloud Director	`vcd-orgs` `vcd-org-vdcs` `vcd-vms` `vcd-vapps` `vcd-cis`
Informes de máquinas virtuales de vRealize Automation	`vcac-vms`
Informes de almacenamiento	`storage-arrays` `storage-luns`
Informes de AWS	`aws-resources` `aws-vms`
Informes de distribución de costos.	`showback-vms` `showback-add-svcs`
Informes de presupuesto	`rest/budget/export`

Para exportar un informe de un periodo específico, ejecute el siguiente comando.
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, donde DEFAULT_REPORT_NAME es el nombre del informe estándar mencionado en la tabla.
- Si especifica startmonth y endmonth, vRealize Business for Cloud generará un informe desde el primer día del mes que configure en startmonth hasta el mes que configure en endmonth (hasta el último día del mes anterior).
  Por ejemplo, si introduce startmonth=2016-02&&endmonth=2016-06, se exportará un informe desde el primer día de febrero hasta el último día de mayo.
- Si solo especifica startmonth, vRealize Business for Cloud genera un informe desde el primer día del mes que haya especificado hasta el mes actual.
  Por ejemplo, si especifica startmonth=2016-02, se exportará un informe desde el primer día de febrero hasta el mes actual.
- Si solo especifica endmonth, vRealize Business for Cloud generará un informe desde el mes que tenga datos disponibles hasta el mes que haya especificado en endmonth (hasta el último día del mes anterior).
  Por ejemplo, si especifica endmonthendmonth=2016-10, se exportará un informe hasta el último día de septiembre.
Nota:
Puede especificar el período para los informes de máquinas virtuales de vCenter Server (vms), los informes de máquinas virtuales de vRealize Automation (vcac-vms), los informes de AWS (aws-vms, aws-resources) y los informes de visibilidad completa de gastos (showback-vms, showback-add-svcs). No se pueden generar informes de vCloud Director ni de presupuestos para un período concreto.

Los informes se exportan en formato CSV o XLS.

Datos de vCloud Director en el nivel de organización

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, donde:

VRB_SERVER es la dirección IP o el FQDN del servidor de vRealize Business for Cloud.
01.MM.YYYY es el parámetro para especificar el mes del que desea el informe. En este parámetro solo se pueden modificar los valores de mes y año. El valor de día debe ser 01. Por ejemplo, 01.02.2017. Si no se incluye el parámetro ?month=01.MM.YYYY en el comando, se generan los detalles del mes actual para el mes actual en el informe.

Datos de vCloud Director específicos de una organización

VRB_SERVER es la dirección IP o el FQDN del servidor de vRealize Business for Cloud.
01.MM.YYYY es el parámetro para especificar el mes del que desea el informe. En este parámetro solo se pueden modificar los valores de mes y año. El valor de día debe ser 01. Por ejemplo, 01.02.2017. Si no se incluye el parámetro ?month=01.MM.YYYY en el comando, se generan los detalles del mes actual para el mes actual en el informe.

Datos de vCloud Director en el nivel de vDC de organización

VRB_SERVER es la dirección IP o el FQDN del servidor de vRealize Business for Cloud.
01.MM.YYYY es el parámetro para especificar el mes del que desea el informe. En este parámetro solo se pueden modificar los valores de mes y año. El valor de día debe ser 01. Por ejemplo, 01.02.2017. Si no se incluye el parámetro ?month=01.MM.YYYY en el comando, se generan los detalles del mes actual para el mes actual en el informe.

Datos de vCloud Director específicos de un vDC de organización

VRB_SERVER es la dirección IP o el FQDN del servidor de vRealize Business for Cloud.
01.MM.YYYY es el parámetro para especificar el mes del que desea el informe. En este parámetro solo se pueden modificar los valores de mes y año. El valor de día debe ser 01. Por ejemplo, 01.02.2017. Si no se incluye el parámetro ?month=01.MM.YYYY en el comando, se generan los detalles del mes actual para el mes actual en el informe.

Datos de vCloud Director en el nivel de vApps

VRB_SERVER es la dirección IP o el FQDN del servidor de vRealize Business for Cloud.
01.MM.YYYY es el parámetro para especificar el mes del que desea el informe. En este parámetro solo se pueden modificar los valores de mes y año. El valor de día debe ser 01. Por ejemplo, 01.02.2017. Si no se incluye el parámetro ?month=01.MM.YYYY en el comando, se generan los detalles del mes actual para el mes actual en el informe.

Datos de vCloud Director específicos de una vApp

VRB_SERVER es la dirección IP o el FQDN del servidor de vRealize Business for Cloud.
01.MM.YYYY es el parámetro para especificar el mes del que desea el informe. En este parámetro solo se pueden modificar los valores de mes y año. El valor de día debe ser 01. Por ejemplo, 01.02.2017. Si no se incluye el parámetro ?month=01.MM.YYYY en el comando, se generan los detalles del mes actual para el mes actual en el informe.

Datos de vCloud Director en el nivel de máquinas virtuales

VRB_SERVER es la dirección IP o el FQDN del servidor de vRealize Business for Cloud.
01.MM.YYYY es el parámetro para especificar el mes del que desea el informe. En este parámetro solo se pueden modificar los valores de mes y año. El valor de día debe ser 01. Por ejemplo, 01.02.2017. Si no se incluye el parámetro ?month=01.MM.YYYY en el comando, se generan los detalles del mes actual para el mes actual en el informe.

Datos de vCloud Director específicos de una máquina virtual

VRB_SERVER es la dirección IP o el FQDN del servidor de vRealize Business for Cloud.
01.MM.YYYY es el parámetro para especificar el mes del que desea el informe. En este parámetro solo se pueden modificar los valores de mes y año. El valor de día debe ser 01. Por ejemplo, 01.02.2017. Si no se incluye el parámetro ?month=01.MM.YYYY en el comando, se generan los detalles del mes actual para el mes actual en el informe.

Detalles diarios de vCloud Director en el nivel de vDC de organización

Nota:

No se proporcionan detalles del nivel de servicio para este informe.

Detalles diarios de vCloud Director en el nivel de máquina virtual