External DocumentationTo learn more, visit the Device 42 documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Device IDs | A comma-separated list of device IDs to attach to the created/updated IP address. |
| Devices | A comma-separated list of device names to attach to the created/updated IP address. |
| IP Address | The IP to create or update. Note: If a matching IP address is found, it will update the first matched IP address unless you specify a VRF Group or VRF Group ID, then it matches or adds the IP to that VRF group). |
| Label | The label to attach to the created/updated IP address. Use d42_null to clear up the content of the IP label. |
| Locked | Select yes to lock the IP-to-device mapping for the specified devices or device_ids. Select no to unlock it.Note: If no devices are provided, no action is taken. For new IP-to-device mappings, this value defaults to no (unlocked). |
| MAC Address | The MAC address to attach to the created/updated IP address to. |
| Remove Device IDs | A comma-separated list of device IDs to remove from to the updated IP address. |
| Remove Devices | A comma-separated list of device names to remove from the updated IP address. |
| Subnet | The name of the subnet to attach the created/updated IP address to. Note: Must be unique. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Available | Select whether to mark the IP address as available. |
| Clear All | Select yes to mark the IP address as available. This action will clear all associated fields, including device, MAC address, notes, and label. |
| Notes | Additional notes to add to the created/updated IP address. |
| Tags | A comma-separated list of tags to attach to the updated/created IP address. |
| Type | The type to filter the results by. |
| VRF Group ID | The ID of the VRF group to associate the IP address with. |
| VRF Group Name | The name of the group to associate the IP address with. |
Example Output
{
"msg": [
"ip added or updated'76'192.168.1.1",
true,
false
],
"code": 0
}