Utility Billing Report Task¶
Overview¶
This document describes the API used to create and download utility billing license reports.
REST Endpoint: /mgmt/cm/device/tasks/licensing/utility-billing-reports¶
Requests¶
POST /mgmt/cm/device/tasks/licensing/utility-billing-reports¶
Request Parameters¶
Name | Type | Required | Description |
---|---|---|---|
regKey | string | True | The registration key for which a utility billing report will be created. |
reportStartDateTime | string | False | The start of the reporting period. If not provided, this defaults to the last reporting time. |
reportEndDateTime | string | False | The end of the reporting period. If not provided, this defaults to the current time. |
submissionMethod | string | True | Indicates how the report will be submitted to F5 after it is generated. Values: Automatic or Manual. If Automatic, BIG-IQ must have connectivity to api.f5.com. |
obfuscateDeviceInfo | boolean | False | If set to true, information identifying the device will be removed from the report. Defaults to false. |
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
regKey | string | The registration key for which a utility billing report will be created. |
reportStartDateTime | string | The start of the reporting period. If not provided, this defaults to the last reporting time. |
reportEndDateTime | string | The end of the reporting period. If not provided, this defaults to the current time. |
submissionMethod | string | Indicates how the report will be submitted to F5 after it is generated. Values: Automatic or Manual. If Automatic, BIG-IQ must have connectivity to api.f5.com. |
reportUri | string | Upon completion, this will be the link for downloading the report. Similar to selfLink, the host will be set to localhost and must be changed if accessing the link from outside BIG-IQ. |
obfuscateDeviceInfo | boolean | If set to true, information identifying the device will be removed from the report. Defaults to false. |
startDateTime | string | Start date and time of task. |
errorMessage | string | Error message describing details of task failure. |
endDateTime | string | End date and time of task. |
status | string | Current status of task. One of CANCELED, FAILED, or FINISHED indicates the task is complete. |
Permissions¶
Role | Allow |
---|---|
License_Manager | Yes |
device_manager | Yes |
GET /mgmt/cm/device/tasks/licensing/utility-billing-reports/<id>¶
Request Parameters¶
None
Query Parameters¶
None
Response¶
HTTP/1.1 200 OK
Name | Type | Description |
---|---|---|
regKey | string | The registration key for which a utility billing report will be created. |
reportStartDateTime | string | The start of the reporting period. If not provided, this defaults to the last reporting time. |
reportEndDateTime | string | The end of the reporting period. If not provided, this defaults to the current time. |
submissionMethod | string | Indicates how the report will be submitted to F5 after it is generated. Values: Automatic or Manual. If Automatic, BIG-IQ must have connectivity to api.f5.com. |
reportUri | string | Upon completion, this will be the link for downloading the report. Similar to selfLink, the host will be set to localhost and must be changed if accessing the link from outside BIG-IQ. |
obfuscateDeviceInfo | boolean | If set to true, information identifying the device will be removed from the report. Defaults to false. |
startDateTime | string | Start date and time of task. |
errorMessage | string | Error message describing details of task failure. |
endDateTime | string | End date and time of task. |
status | string | Current status of task. One of CANCELED, FAILED, or FINISHED indicates the task is complete. |
Permissions¶
Role | Allow |
---|---|
Application_Editor | Yes |
Device_Viewer | Yes |
Service_Catalog_Viewer | Yes |
Service_Catalog_Editor | Yes |
License_Manager | Yes |
device_manager | Yes |
Examples¶
Create a utility billing report¶
POST /mgmt/cm/device/tasks/licensing/utility-billing-reports
{
"regKey": "G6855-91330-03366-77667-7991140",
"submissionMethod": "Manual"
}
Response¶
HTTP/1.1 200 OK
{
"regKey": "G6855-91330-03366-77667-7991140",
"submissionMethod": "Manual",
"id": "0e39a1f1-c1db-4804-b651-e8c8d5fdc0f3",
"status": "STARTED",
"userReference": {
"link": "https://localhost/mgmt/shared/authz/users/dm"
},
"identityReferences": [
{
"link": "https://localhost/mgmt/shared/authz/users/dm"
}
],
"ownerMachineId": "a44c9be2-93fe-441d-acc9-e32747f9d86c",
"taskWorkerGeneration": 1,
"generation": 1,
"lastUpdateMicros": 1536088876778402,
"kind": "cm:device:tasks:licensing:utility-billing-reports:billingreporttaskitemstate",
"selfLink": "https://localhost/mgmt/cm/device/tasks/licensing/utility-billing-reports/0e39a1f1-c1db-4804-b651-e8c8d5fdc0f3"
}
View the status of a utility billing report¶
GET /mgmt/cm/device/tasks/licensing/utility-billing-reports/<id>
Response¶
HTTP/1.1 200 OK
{
"generation": 2,
"id": "0e39a1f1-c1db-4804-b651-e8c8d5fdc0f3",
"identityReferences": [
{
"link": "https://localhost/mgmt/shared/authz/users/dm"
}
],
"kind": "cm:device:tasks:licensing:utility-billing-reports:billingreporttaskitemstate",
"lastUpdateMicros": 1536088877927183,
"ownerMachineId": "a44c9be2-93fe-441d-acc9-e32747f9d86c",
"regKey": "G6855-91330-03366-77667-7991140",
"reportEndDateTime": "2018-09-04T19:21:16Z",
"reportStartDateTime": "2018-09-01T11:16:00Z",
"reportUri": "https://localhost/mgmt/cm/device/licensing/license-reports-download/575e4202-59e1-4797-bc30-bed14d8ca45c.json",
"selfLink": "https://localhost/mgmt/cm/device/tasks/licensing/utility-billing-reports/0e39a1f1-c1db-4804-b651-e8c8d5fdc0f3",
"status": "FINISHED",
"submissionMethod": "Manual",
"userReference": {
"link": "https://localhost/mgmt/shared/authz/users/dm"
},
"username": "dm"
}
Download a utility billing report¶
GET /mgmt/cm/device/licensing/license-reports-download/<report>
Response¶
HTTP/1.1 200 OK
{
"product": "big-iq",
"version": "6.1.0.0.0.361",
"reportType": "pool usage",
"poolType": "CLPv2",
"regkey": "V6692-232146-599-5020024-9126745",
"poolRegkey": "G6855-91330-03366-77667-7991140",
"poolName": "u2",
"periodStarted": "2018-09-01T11:16:00Z",
"periodEnded": "2018-09-04T19:21:16Z",
"records": []
}