# How to add a new Device via script with a description?

**URL:** <https://forum.inductiveautomation.com/t/how-to-add-a-new-device-via-script-with-a-description/48519>\
**Category:** Ignition\
**Tags:** ignition81\
**Created:** [July 6, 2021, 10:07am UTC](https://forum.inductiveautomation.com/t/how-to-add-a-new-device-via-script-with-a-description/48519 "2021-07-06T10:07:50Z")\
**Posts on this page:** 11\
**Page:** 1

<div class="post-metadata">

**Author:** ![nminchin](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/nminchin/32/6911_2.png) [@nminchin](https://forum.inductiveautomation.com/u/nminchin)\
**Post date:** [July 6, 2021, 10:07am UTC](https://forum.inductiveautomation.com/t/how-to-add-a-new-device-via-script-with-a-description/48519/1 "2021-07-06T10:07:50Z")

</div>

Using `system.device.addDevice` I can add devices, but in the help there's a note that the description field can't be configured...  
[https://docs.inductiveautomation.com/display/DOC80/system.device.addDevice+-+deviceProps+Listing](https://docs.inductiveautomation.com/display/DOC80/system.device.addDevice+-+deviceProps+Listing)

> Below is a table of properties callable by system.device.addDevice.
> 
> **Note that the Description** and Enabled **properties may not be configured with this function** , although a device connection could be disabled with a call to [system.device.setDeviceEnabled()](https://docs.inductiveautomation.com/display/DOC80/system.device.setDeviceEnabled) after creating the connection.

I use the description field to copy the IP address into so that I can quickly see what all device IP addresses are configured as. Otherwise it's an absolute PITA, especially with \>90 devices.

I need to add 20 new devices and I _really_ don't want to have to set these descriptions up manually ☹

Possible?

---

<div class="post-metadata">

**Author:** ![mazeyrat](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/mazeyrat/32/10955_2.png) [@mazeyrat](https://forum.inductiveautomation.com/u/mazeyrat)\
**Post date:** [July 6, 2021, 11:25am UTC](https://forum.inductiveautomation.com/t/how-to-add-a-new-device-via-script-with-a-description/48519/2 "2021-07-06T11:25:01Z")

</div>

I think that the only workaround for now is to write the description in the internal sqlite DB, table DEVICESETTINGS

---

<div class="post-metadata">

**Author:** ![nminchin](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/nminchin/32/6911_2.png) [@nminchin](https://forum.inductiveautomation.com/u/nminchin)\
**Post date:** [July 6, 2021, 11:30am UTC](https://forum.inductiveautomation.com/t/how-to-add-a-new-device-via-script-with-a-description/48519/3 "2021-07-06T11:30:59Z")

</div>

Yeah 😕

---

<div class="post-metadata">

**Author:** ![paul-griffith](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/paul-griffith/32/37249_2.png) [@paul-griffith](https://forum.inductiveautomation.com/u/paul-griffith)\
**Post date:** [August 4, 2021, 5:53pm UTC](https://forum.inductiveautomation.com/t/how-to-add-a-new-device-via-script-with-a-description/48519/4 "2021-08-04T17:53:54Z")

</div>

This will be possible in 8.1.9:

> [@Nightly 8.1 Changelogs - 2021](https://forum.inductiveautomation.com/t/nightly-8-1-changelogs-2021/42410/130):
>
> Nightly Changelog: 8.1.9-b20210804 Security 1279 8.1: Add option to control how much information is given to clients/designers in error messages Gateway errors sent to the designer or client containing external system details can now be suppressed via an optional system property. 588: Limited license parsing needs to 'fail-open' if restrictions are malformed/invalid Prevented a NumberFormatException from being thrown when parsing invalid license restrictions for limited vision client & repor…

---

<div class="post-metadata">

**Author:** ![Douglas\_Lawrie](https://avatars.discourse-cdn.com/v4/letter/d/a87d85/32.png) [@Douglas\_Lawrie](https://forum.inductiveautomation.com/u/Douglas_Lawrie)\
**Post date:** [September 6, 2024, 5:46am UTC](https://forum.inductiveautomation.com/t/how-to-add-a-new-device-via-script-with-a-description/48519/5 "2024-09-06T05:46:09Z")

</div>

Is this solved? It appears there is still no description property in 8.1.43?

**EDIT**  
Solved. Use a named 'description' parameter in addDevice rather than the props dict.  
[Update query scripting - Ignition - Inductive Automation Forum](https://forum.inductiveautomation.com/t/update-query-scripting/79517/13)

---

<div class="post-metadata">

**Author:** ![nminchin](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/nminchin/32/6911_2.png) [@nminchin](https://forum.inductiveautomation.com/u/nminchin)\
**Post date:** [January 23, 2025, 12:15am UTC](https://forum.inductiveautomation.com/t/how-to-add-a-new-device-via-script-with-a-description/48519/6 "2025-01-23T00:15:09Z")

</div>

I think the 2nd issue here is that the IP address isn't displayed on the overview screen

---

<div class="post-metadata">

**Author:** ![Kevin.Herron](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/kevin.herron/32/7259_2.png) [@Kevin.Herron](https://forum.inductiveautomation.com/u/Kevin.Herron)\
**Post date:** [January 23, 2025, 12:19am UTC](https://forum.inductiveautomation.com/t/how-to-add-a-new-device-via-script-with-a-description/48519/7 "2025-01-23T00:19:01Z")

</div>

Hmm?

---

<div class="post-metadata">

**Author:** ![nminchin](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/nminchin/32/6911_2.png) [@nminchin](https://forum.inductiveautomation.com/u/nminchin)\
**Post date:** [January 23, 2025, 12:24am UTC](https://forum.inductiveautomation.com/t/how-to-add-a-new-device-via-script-with-a-description/48519/8 "2025-01-23T00:24:06Z")

</div>

My actual issue that I was working around was displaying the IP address of the PLCs on the Device Connections overview page by writing the IP address into the device description fields. So the underlying issue for me is that the IP address isn't visible on the device connections overview page

---

<div class="post-metadata">

**Author:** ![Kevin.Herron](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/kevin.herron/32/7259_2.png) [@Kevin.Herron](https://forum.inductiveautomation.com/u/Kevin.Herron)\
**Post date:** [January 23, 2025, 12:26am UTC](https://forum.inductiveautomation.com/t/how-to-add-a-new-device-via-script-with-a-description/48519/9 "2025-01-23T00:26:46Z")

</div>

Ahh... I'm not sure that really changes in 8.3 either. The assumption that every device even has a hostname or IP address config property isn't valid.

---

<div class="post-metadata">

**Author:** ![nminchin](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/nminchin/32/6911_2.png) [@nminchin](https://forum.inductiveautomation.com/u/nminchin)\
**Post date:** [January 23, 2025, 12:29am UTC](https://forum.inductiveautomation.com/t/how-to-add-a-new-device-via-script-with-a-description/48519/10 "2025-01-23T00:29:53Z")

</div>

the assumption that all of _my_ devices have an ip address is valid though 😛 (all 120 of them)

---

<div class="post-metadata">

**Author:** ![Kevin.Herron](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/kevin.herron/32/7259_2.png) [@Kevin.Herron](https://forum.inductiveautomation.com/u/Kevin.Herron)\
**Post date:** [January 23, 2025, 12:30am UTC](https://forum.inductiveautomation.com/t/how-to-add-a-new-device-via-script-with-a-description/48519/11 "2025-01-23T00:30:45Z")

</div>

Good, use the description then 🙂
