MikroTik API icon

MikroTik API

Community Node for MikroTik RouterOS API

Actions67

Interface → Set Comment

AI-generated

Summary

Set the comment on a MikroTik interface identified by its ID or name.

Inputs

  • targetId (required) — ID (*1, *2) or name (e.g., ether1) of the interface to modify.
  • commentText (required) — Comment string to set on the interface.

Output shape

An array with a single item containing json that holds resource, operation, count (always 1 for set), and data – the raw RouterOS response from /interface/set.

On success data is typically an empty array; errors are surfaced via the node's error handling.

Examples

Example 1: Add a description to an ethernet interface

Set Resource = Interface, Operation = Set Comment, Target ID / Name = ether1, Comment = Uplink to switch

Links

Discussion