Managing Assets
The following commands require an active KSDK session
For KSDK login instructions see the Authentication page.
An asset refers to physical devices such as pumps, wells, compressors, etc. that are being monitored and controlled.
Consulting Assets¶
Listing Assets¶
All the available Assets can be consulted with the kelvin asset list command:
kelvin asset list
Success
[kelvin.sdk][2021-07-06 11:51:50][I] Retrieving assets..
[kelvin.sdk][2021-07-06 11:51:52][I]
*************************** Assets ***************************
+---------------------+----------------+-----------------------+------------+----------------------------------+----------------------------------+
| Name | Title | Asset Type | Metadata | Created | Updated |
|---------------------+----------------+-----------------------+------------+----------------------------------+----------------------------------|
| asset-001 | Asset 001 | asset-type-001 | | 2021-04-15 10:12:54.143982+00:00 | 2021-04-15 10:12:54.143982+00:00 |
| asset-002 | Asset 002 | asset-type-002 | | 2021-04-15 10:12:54.143982+00:00 | 2021-04-15 10:12:54.143982+00:00 |
| asset-003 | Asset 003 | asset-type-003 | | 2021-04-15 10:12:54.921831+00:00 | 2021-04-15 10:12:54.921831+00:00 |
| asset-004 | Asset 004 | asset-type-004 | | 2021-04-15 10:12:55.612968+00:00 | 2021-04-15 10:12:55.612968+00:00 |
| asset-005 | Asset 005 | asset-type-005 | | 2021-04-15 10:12:56.303185+00:00 | 2021-04-15 10:12:56.303185+00:00 |
| asset-006 | Asset 006 | asset-type-006 | | 2021-04-15 10:12:57.124169+00:00 | 2021-04-15 10:12:57.124169+00:00 |
+---------------------+----------------+-----------------------+------------+----------------------------------+----------------------------------+
Alternatively, you can manage Assets on <instance>.kelvininc.com directly through the Control Center web interface.
Searching Assets¶
In addition to listing all assets, you can search for specific assets with the kelvin asset search command:
# kelvin asset search <query>
kelvin asset search "asset"
Success
[kelvin.sdk][2021-07-06 12:06:43][I] Searching assets that match "asset-001"
[kelvin.sdk][2021-07-06 12:06:45][I]
*************************** Assets ***************************
+----------------+----------------+---------------------+------------+----------------------------------+----------------------------------+
| Name | Title | Asset Type | Metadata | Created | Updated |
|----------------+----------------+---------------------+------------+----------------------------------+----------------------------------|
| asset-001 | Asset 001 | asset-type-001 | | 2021-04-15 10:12:54.143982+00:00 | 2021-04-15 10:12:54.143982+00:00 |
| asset-002 | Asset 002 | asset-type-001 | | 2021-04-15 10:13:00.000000+00:00 | 2021-04-15 10:13:00.000000+00:00 |
+----------------+----------------+---------------------+------------+----------------------------------+----------------------------------+
Details of an Asset¶
Detailed information of an Asset can be obtained through the kelvin asset show command.
# kelvin asset show <asset name>
kelvin asset show asset-001
Success
[kelvin.sdk][2021-07-06 12:15:24][I] Retrieving asset details for "asset-001"
[kelvin.sdk][2021-07-06 12:15:26][I]
*************************** Asset Info ***************************
asset_type_name: asset-type-001
created: 2021-04-15 10:12:54.143982+00:00
metadata: None
name: asset-001
title: Asset 001
updated: 2021-04-15 10:12:54.143982+00:00
Managing Assets¶
Creating an Asset¶
You can create assets with the kelvin assets create command:
# kelvin asset create <asset_name> --title "Asset title" --type-name <asset_type_name>
ksdk asset create asset-001 --title "Asset 001" --type-name asset-type-001
Success
[kelvin.sdk][2021-07-06 15:00:43][I] Create new Asset "asset-001"
[kelvin.sdk][2021-07-06 15:00:45][R] Asset "asset-001" successfully created
Deleting an Asset¶
An Asset can be deleted from the platform using the kelvin asset delete command.
# kelvin asset delete <asset_name>
kelvin asset delete asset-001
Success
[kelvin.sdk][2021-07-06 14:57:14][I] Deleting Asset(s) "asset-001" from the platform
[kelvin.sdk][2021-07-06 14:57:14][W]
This operation will delete the assets(s) "asset-001" from the platform
Are you sure? [y/N] y
[kelvin.sdk][2021-07-06 15:02:53][R] Asset "asset-001" successfully deleted from the platform
Managing Asset Types¶
Listing asset types¶
All the asset types available on the currently logged platform can be consulted with the kelvin asset type list command:
kelvin asset type list
Success
[kelvin.sdk][2021-07-06 15:17:25][I] Retrieving asset types..
[kelvin.sdk][2021-07-06 15:17:27][I]
*************************** Asset types ***************************
+--------------------+------------------+------------+----------------------------------+----------------------------------+
| Asset Type Name | Title | Metadata | Created | Updated |
|--------------------+------------------+------------+----------------------------------+----------------------------------|
| asset-type-001 | Asset type 001 | | 2021-04-20 13:47:05.352795+00:00 | 2021-04-20 13:47:05.352795+00:00 |
+--------------------+------------------+------------+----------------------------------+----------------------------------+
Alternatively, you can manage Asset Types on <instance>.kelvininc.com directly through the Control Center web interface.
Creating an asset type¶
You can create asset types with the kelvin asset type create command:
# kelvin asset type create <asset_type_name> <asset_type_title>
kelvin asset type create asset-type-001 "Asset Type 001"
Success
[kelvin.sdk][2021-07-06 15:27:13][I] Create new asset type "asset-type-001"
[kelvin.sdk][2021-07-06 15:27:15][R] Asset type "asset-type-001" successfully created
Deleting an asset type¶
An asset type can be deleted from the platform using the kelvin asset type delete command.
# kelvin asset type delete <asset_type_name>
ksdk asset type delete asset-type-001
Success
[kelvin.sdk][2021-07-06 15:29:29][I] Deleting asset type(s) "asset-type-001" from the platform
[kelvin.sdk][2021-07-06 15:29:29][W]
This operation will delete the assets type(s) "asset-type-001" from the platform
Are you sure? [y/N] y
[kelvin.sdk][2021-07-06 15:29:33][R] Asset type "asset-type-001" successfully deleted from the platform