Change a description of device interface with Python SDK/Module

I can't help with python SDK/module specifically myself but I can point out the underlining REST calls. Perhaps the module uses similar names:

• List of devices: /device/devices - https://www.logicmonitor.com/swagger-ui-master/dist/#/Devices/getDeviceList
  • You can use "filter" to get the specific device(s) you want: https://www.logicmonitor.com/support/rest-api-developers-guide/v1/devices/get-devices
• Getting the list of interfaces (well list of any instances) can be a bit tricky. I no longer have access to code where I've done it before, but if I recall correctly you first need to use /device/devices/{deviceId}/devicedatasources/ to get a list of the DataSources applied to that device, find the Interface DataSource(s) (will be different for different device types), then use /device/devices/{deviceId}/devicedatasources/{hdsId}/instances/ to get information about the instances
  • https://www.logicmonitor.com/swagger-ui-master/dist/#/Devices/getDeviceDatasourceList
  • https://www.logicmonitor.com/swagger-ui-master/dist/#/Datasource Instances/getDeviceDatasourceInstanceList
  • https://www.logicmonitor.com/support/rest-api-developers-guide/v1/datasources/get-datasources-associated-with-a-device
  • https://www.logicmonitor.com/support/rest-api-developers-guide/v1/datasource-instances/about-the-datasource-instance-resource
• Update instance desc and lock: /device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{id}
  • https://www.logicmonitor.com/swagger-ui-master/dist/#/Datasource Instances/updateDeviceDatasourceInstanceById
  • https://www.logicmonitor.com/support/rest-api-developers-guide/v1/datasource-instances/about-the-datasource-instance-resource
• Looks like the value you want to change is lockDescription: "Whether or not Active Discovery is enabled, and thus whether or not the instance description is editable"

One neat trick when working with the API, is that the portal itself uses the API (although some calls are undocumented or newer than we have access to). So if you open the web console in your browser (F12) and for example edit a interface description, you can see the actual call and parameters from the browser as a stepping stone.

Oh, and this makes use of my personal SDK helper. 

2 hours ago, Mike Moniz said:

I can't help with python SDK/module specifically myself but I can point out the underlining REST calls. Perhaps the module uses similar names:

• List of devices: /device/devices - https://www.logicmonitor.com/swagger-ui-master/dist/#/Devices/getDeviceList
  • You can use "filter" to get the specific device(s) you want: https://www.logicmonitor.com/support/rest-api-developers-guide/v1/devices/get-devices
• Getting the list of interfaces (well list of any instances) can be a bit tricky. I no longer have access to code where I've done it before, but if I recall correctly you first need to use /device/devices/{deviceId}/devicedatasources/ to get a list of the DataSources applied to that device, find the Interface DataSource(s) (will be different for different device types), then use /device/devices/{deviceId}/devicedatasources/{hdsId}/instances/ to get information about the instances
  • https://www.logicmonitor.com/swagger-ui-master/dist/#/Devices/getDeviceDatasourceList
  • https://www.logicmonitor.com/swagger-ui-master/dist/#/Datasource Instances/getDeviceDatasourceInstanceList
  • https://www.logicmonitor.com/support/rest-api-developers-guide/v1/datasources/get-datasources-associated-with-a-device
  • https://www.logicmonitor.com/support/rest-api-developers-guide/v1/datasource-instances/about-the-datasource-instance-resource
• Update instance desc and lock: /device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{id}
  • https://www.logicmonitor.com/swagger-ui-master/dist/#/Datasource Instances/updateDeviceDatasourceInstanceById
  • https://www.logicmonitor.com/support/rest-api-developers-guide/v1/datasource-instances/about-the-datasource-instance-resource
• Looks like the value you want to change is lockDescription: "Whether or not Active Discovery is enabled, and thus whether or not the instance description is editable"

One neat trick when working with the API, is that the portal itself uses the API (although some calls are undocumented or newer than we have access to). So if you open the web console in your browser (F12) and for example edit a interface description, you can see the actual call and parameters from the browser as a stepping stone.

This is great thank you. That is a great tip about the portal, thanks a lot.

1 hour ago, Stuart Weenig said:

Here's how you would do it in the sdk, you'll need to provide the logic to sort through the data and find the one you want to update. Also, this only accounts for pagination on the device list. If your datasource count per device, or your instance count per datasource per device is higher than 1000, you would need to include pagination on those gets (you can use the same method i used on the get_device_list call). 

from lm import lm
#get the devices, find the id of the one we want

#fetch items with pagination
end_found = False
offset = 0
size = 1000
devices = {}
while not end_found:
    data = lm.get_device_list(size=size, offset=offset)
    devices.update({record.id: record for record in data.items})
    offset += size
    end_found = len(data.items) < size

for k,v in devices.items(): print(k, v.name)
#your logic here to select the desired one from the result
deviceId = 152

#get the datasources on that device, find the id of the one we want
device_dses = lm.get_device_datasource_list(deviceId, size=1000).items
for ds in device_dses:
    print(ds.data_source_display_name, ds.id)
#your logic here to select the desired one from the result
hdsId = 9571

#get the instances for that device, for that ds
instances = lm.get_device_datasource_instance_list(deviceId, hdsId, size=1000).items
for instance in instances:
    print(instance.id, instance.description, instance.display_name, instance.name)
#your logic here to select the desired one from the result
id = 146160818

#get the details for a particular instance
instance_details = lm.get_device_datasource_instance_by_id(deviceId, hdsId, id)

#update the description in the local copy of the instance
instance_details.description = "Set by the python sdk"

#send the update back to lm
response = lm.patch_device_datasource_instance_by_id(deviceId, hdsId, id, instance_details)
print(f"Description now set to {response.description}")

 

 

This is awesome, just what I needed. Thanks so much.