Cove Customer and Storage Inventory
Overview
MSPs use this view for three recurring jobs: reconciling what Cove protects
against what the client is billed for, showing storage and growth in a QBR,
and answering where a client's backup data is stored. Cove calls customers
partners; an MSP's own account is a partner too, with its end customers
below it in a tree.
All tools in this skill are read tier in Conduit. None is admin-gated.
Anti-triggers
- Which backups failed or went stale: use
cove-backup-health.
- Who has console access to a customer: use
cove-access-review.
Key Concepts
| Concept |
Where it comes from |
| Customer tree |
cove_partners_list (fetch_recursively: true) or cove_partner_tree_get |
| Customer level |
Root, SubRoot, Distributor, SubDistributor, Reseller, EndCustomer, Site |
| Customer state |
InProduction, InTrial, Expired, NotActive, Registered, WaitingForProduction, Rejected; per customer with cove_partner_state_get |
| External code |
A PSA or RMM ID stored on the customer (partner field 18). Use it to match Cove customers to PSA companies. |
| Products |
Products and retention plans assigned to a customer, from cove_products_list |
| Storage |
cove_storages_list and cove_storage_get for the storage a customer uses; cove_storage_statistics_list for usage in MB |
| Location and region |
cove_locations_list and cove_regions_list, for data residency |
Partner fields codes: 0 Name, 1 Level, 3 ChildServiceTypes, 4 ServiceType,
5 State, 8 LocationId, 9 Flags, 10 Company info, 18 ExternalCode and
MailFrom, 20 CreationTime.
Workflows
Customer list with states
cove_auth_context_get for the root PartnerId.
cove_partners_list with parent_partner_id set to it,
fetch_recursively: true and fields: [0, 1, 5, 18, 20].
- Group by state. Customers in
InTrial for a long time, and Expired
customers that still have devices, are the usual follow-ups.
To filter the tree by state, level, name or external code, use
cove_partner_tree_get with states, levels, name_pattern or
external_code_pattern. Do not use cove_partner_children_list to list
customers: it returns a count, and its Children can be null even when
children exist.
Device count per customer (billing reconciliation)
- Pull the customer list as above.
- Call
cove_device_statistics_list on the root customer with
columns: ["I1", "I78", "I14"], paging with start_record_number and
records_count until a page is short.
- Count devices per
PartnerId. Split counts by data source when the
contract bills servers and workstations differently: I78 lists each
device's active data sources.
- Compare against the PSA contract quantity for that client. Match
customers by external code first, by name second. List every mismatch
with both numbers; do not guess which side is right.
Storage used and growth
cove_storage_statistics_list with the customer's partner_id. Sizes are
in MB (UsedStorageInMb, TotalStorageInMb).
- For per-device storage, use column
I14 from
cove_device_statistics_list. It is in bytes, so convert before comparing
with the MB figures.
- For growth, compare against a figure from an earlier report the user
gives you. The tools return current values; Cove's history methods are
not exposed.
Data residency
cove_storages_list for the customer, then cove_storage_get for each
storage.
cove_locations_list and cove_regions_list to name the location and
region.
- Where a client asks which devices sit on which node, use
cove_storage_nodes_by_device_list with up to 100 device IDs. The
storage-node tools are not yet confirmed for a Supporter API user; a 13501
error means the role does not allow them.
Products and retention
cove_products_list with the customer's partner_id. Set
current_partner_only: true to see only products defined on that
customer, not inherited ones.
cove_profiles_list for the backup profiles available to the customer,
and cove_profile_get for one profile's settings.
Customer change history
cove_partner_history_list returns a customer's change history, for example
when it moved from trial to production. For who made a console change, use
the audit log in cove-access-review.
Output
For a QBR or reconciliation, give one row per customer: name, external code,
state, device count, storage used (GB, one decimal), products. Put mismatches
and expired customers with devices in a separate list above the table.
Gotchas
- Two units: statistics column
I14 is bytes, storage statistics are MB.
cove_devices_list covers one customer level only. Use
cove_device_statistics_list on a parent to count devices across a tree.
cove_partner_get_by_name needs the exact name. For partial names, list
the tree and match.
- Cove documents no rate limits. On a large tree, page the statistics query
and avoid one call per customer when one call on the parent will do.
1---2name: cove-customer-and-storage-inventory3description: >4 Building a per-customer inventory from Cove: the customer (partner) tree and5 each customer's state, assigned products and retention, protected device6 counts, storage used and its growth, and the storage locations that hold the7 data. Covers reconciling device counts against billing and preparing the8 backup section of a QBR.9when_to_use: >-10 When someone needs to know what Cove protects for a client, how much storage11 a client uses, which customers are in trial or expired, or where a client's12 backup data is stored. Use when: cove customers, backup inventory, storage13 usage, storage growth, backup billing reconciliation, device count, cove14 trial, data residency, retention plan, or backup QBR.15metadata:16 source: https://skillmd.com/skills/wyre-ai/cove-customer-and-storage-inventory17---1819# Cove Customer and Storage Inventory2021## Overview2223MSPs use this view for three recurring jobs: reconciling what Cove protects24against what the client is billed for, showing storage and growth in a QBR,25and answering where a client's backup data is stored. Cove calls customers26**partners**; an MSP's own account is a partner too, with its end customers27below it in a tree.2829All tools in this skill are read tier in Conduit. None is admin-gated.3031## Anti-triggers3233- **Which backups failed or went stale**: use `cove-backup-health`.34- **Who has console access to a customer**: use `cove-access-review`.3536## Key Concepts3738| Concept | Where it comes from |39|---------|---------------------|40| Customer tree | `cove_partners_list` (`fetch_recursively: true`) or `cove_partner_tree_get` |41| Customer level | `Root`, `SubRoot`, `Distributor`, `SubDistributor`, `Reseller`, `EndCustomer`, `Site` |42| Customer state | `InProduction`, `InTrial`, `Expired`, `NotActive`, `Registered`, `WaitingForProduction`, `Rejected`; per customer with `cove_partner_state_get` |43| External code | A PSA or RMM ID stored on the customer (partner field 18). Use it to match Cove customers to PSA companies. |44| Products | Products and retention plans assigned to a customer, from `cove_products_list` |45| Storage | `cove_storages_list` and `cove_storage_get` for the storage a customer uses; `cove_storage_statistics_list` for usage in MB |46| Location and region | `cove_locations_list` and `cove_regions_list`, for data residency |4748Partner `fields` codes: 0 Name, 1 Level, 3 ChildServiceTypes, 4 ServiceType,495 State, 8 LocationId, 9 Flags, 10 Company info, 18 ExternalCode and50MailFrom, 20 CreationTime.5152## Workflows5354### Customer list with states55561. `cove_auth_context_get` for the root `PartnerId`.572. `cove_partners_list` with `parent_partner_id` set to it,58 `fetch_recursively: true` and `fields: [0, 1, 5, 18, 20]`.593. Group by state. Customers in `InTrial` for a long time, and `Expired`60 customers that still have devices, are the usual follow-ups.6162To filter the tree by state, level, name or external code, use63`cove_partner_tree_get` with `states`, `levels`, `name_pattern` or64`external_code_pattern`. Do not use `cove_partner_children_list` to list65customers: it returns a count, and its `Children` can be null even when66children exist.6768### Device count per customer (billing reconciliation)69701. Pull the customer list as above.712. Call `cove_device_statistics_list` on the root customer with72 `columns: ["I1", "I78", "I14"]`, paging with `start_record_number` and73 `records_count` until a page is short.743. Count devices per `PartnerId`. Split counts by data source when the75 contract bills servers and workstations differently: `I78` lists each76 device's active data sources.774. Compare against the PSA contract quantity for that client. Match78 customers by external code first, by name second. List every mismatch79 with both numbers; do not guess which side is right.8081### Storage used and growth82831. `cove_storage_statistics_list` with the customer's `partner_id`. Sizes are84 in MB (`UsedStorageInMb`, `TotalStorageInMb`).852. For per-device storage, use column `I14` from86 `cove_device_statistics_list`. It is in bytes, so convert before comparing87 with the MB figures.883. For growth, compare against a figure from an earlier report the user89 gives you. The tools return current values; Cove's history methods are90 not exposed.9192### Data residency93941. `cove_storages_list` for the customer, then `cove_storage_get` for each95 storage.962. `cove_locations_list` and `cove_regions_list` to name the location and97 region.983. Where a client asks which devices sit on which node, use99 `cove_storage_nodes_by_device_list` with up to 100 device IDs. The100 storage-node tools are not yet confirmed for a Supporter API user; a 13501101 error means the role does not allow them.102103### Products and retention1041051. `cove_products_list` with the customer's `partner_id`. Set106 `current_partner_only: true` to see only products defined on that107 customer, not inherited ones.1082. `cove_profiles_list` for the backup profiles available to the customer,109 and `cove_profile_get` for one profile's settings.110111### Customer change history112113`cove_partner_history_list` returns a customer's change history, for example114when it moved from trial to production. For who made a console change, use115the audit log in `cove-access-review`.116117## Output118119For a QBR or reconciliation, give one row per customer: name, external code,120state, device count, storage used (GB, one decimal), products. Put mismatches121and expired customers with devices in a separate list above the table.122123## Gotchas124125- Two units: statistics column `I14` is bytes, storage statistics are MB.126- `cove_devices_list` covers one customer level only. Use127 `cove_device_statistics_list` on a parent to count devices across a tree.128- `cove_partner_get_by_name` needs the exact name. For partial names, list129 the tree and match.130- Cove documents no rate limits. On a large tree, page the statistics query131 and avoid one call per customer when one call on the parent will do.