Set Interface Name Aliases

As an administrator, you can set aliases for interface component names per device item. An interface alias is a name that the administrator configures and applies to the associated interface component in npc. Users see the interface aliases in their dashboards and views depending on the role rights you assign.
capm250
As an administrator, you can set aliases for interface component names per device item. An interface alias is a name that the administrator configures and applies to the associated interface component in
NetOps Portal
. Users see the interface aliases in their dashboards and views depending on the role rights you assign.
An alias that is set using REST web services takes precedence over the alias that you can set by importing a CSV file.
The following URL shows the syntax:
http://
PC_host
:8181/pc/center/webservice/devices
Follow these steps:
  1. Determine which interfaces you want to set an alias for:
    1. To return a list of all of the interfaces on a device item, enter the following URL in the REST client:
      http://
      PC_host
      :8181/pc/center/webservice/devices/deviceItemId/
      device_id
      /interfaces
      • device_id
        Is the device item identification number for the monitored device that interface components are associated with.
    2. Select
      GET
      for the
      "HTTP" Method
      .
    3. Determine which interfaces you want to set an alias for.
  2. Enter one of the following URLs in the REST client:
    http://
    PC_host
    :8181/pc/center/webservice/devices/deviceItemId/
    device_id
    /setInterfaceNameAlias
    http://
    PC_host
    :8181/pc/center/webservice/devices/domainItemId/
    domain_id
    /
    device_IP
    /setInterfaceNameAlias
    • domain_id
      Is the domain identification number for the domain that interface components are associated with.
  3. Select
    PUT
    for the
    "HTTP" Method
    .
  4. To set the interface name aliases, enter the following information in the Body tab of the HTTP Request pane:
    <interfaces>
         <interface>
              <itemId>interface_item_id</itemId>
              <nameAlias>alias_for_interface</nameAlias>
         </interface>
         ...
    </interfaces>
Example:
To set 'Et0 - alias' and 'Se0 - alias' as the interface name alias for two interfaces, enter the following information in the Body tab of the HTTP Request pane:
<interfaces>
     <interface>
          <itemId>164</itemId>
          <nameAlias>Et0 - alias</nameAlias>
     </interface>
     <interface>
          <itemId>165</itemId>
          <nameAlias>Se0 - alias</nameAlias>
     </interface>
</interfaces>
To set the aliases for interface component names across multiple device items, use the
update_alias_name.sh
script.