Interface Attributes
The interfaces data type imports data specific to the switch and router interfaces.
Use these attributes with the following table specification in line 1:
table=interfaces
- Fields marked with an asterisk (*) are required.
- Fields marked with an plus sign (+) can be updated during import.
Interface Attributes
| Field Name | Description |
|---|---|
| MapName | Type: TEXT Access: READ-ONLY Attributes: none Description: The name of the map to which the interface belongs. |
| InterfaceID | Type: TEXT Access: READ-ONLY Attributes: INDEX Description: A unique persistent identifier for this interface instance. |
| DeviceID | Type: TEXT Access: READ-ONLY Attributes: none Description: The unique persistent identifier for the adjacent device. |
| NetworkID | Type: TEXT Access: READ-ONLY Attributes: none Description: The unique persistent identifier for the adjacent network. |
| Index | Type: TEXT Access: READ-ONLY Attributes: none Description: The interface index (i.e. ifIndex) of the interface. |
| IntegerIndex | Type: TEXT Access: READ-ONLY Attributes: none Description: The interface index (i.e. ifIndex) of the interface, as an integer. |
| Description | Type: TEXT Access: READ-ONLY Attributes: none Description: The interface description (i.e. ifDescr). |
| Name | Type: TEXT Access: READ-ONLY Attributes: none Description: The interface name (i.e. ifName). |
| Alias | Type: TEXT Access: READ-ONLY Attributes: none Description: The interface alias (i.e. ifAlias). |
| PhysAddress | Type: ADDRESS Access: READ-ONLY Attributes: none Description: The interface's data-link layer address (i.e. ifPhysAddr) . |
| Type | Type: TEXT Access: READ-ONLY Attributes: none Description: The interface type as a human-readable string (i.e. ifType). |
| MTU | Type: INTEGER Access: READ-ONLY Attributes: none Description: The interface MTU (i.e. ifMTU). |
| Address | Type: ADDRESS Access: READ-ONLY Attributes: none Description: The interface's first network-layer address. |
| SubnetMask | Type: ADDRESS Access: READ-ONLY Attributes: none Description: The subnet mask associated with "Address". |
| SubnetList | Type: TEXT Access: READ-ONLY Attributes: none Description: A comma-separated list of addresses/masks on this interface. |
| SubnetPrefixList | Type: TEXT Access: READ-ONLY Attributes: none Description: A comma-separated list of addresses/prefixes on this interface. |
| Speed | Type: INTEGER Access: READ-ONLY Attributes: none Description: The interface's speed in bits per second. (Derived from preferred speed and reported speed.) |
| PreferredSpeed + | Type: INTEGER Access: READ-WRITE Attributes: none Description: The preferred speed of the interface as set by the customer. |
| ReportedSpeed | Type: INTEGER Access: READ-ONLY Attributes: none Description: The speed of the interface as reported by the interface. |
| LastChange | Type: TIMESTAMP Access: READ-ONLY Attributes: none Description: The timestamp when the interface last changed status. |
| Status | Type: TEXT Access: READ-ONLY Attributes: none Description: The status of the interface (e.g. UP, DOWN, or ADMIN-DOWN). |
| Enabled + | Type: TEXT Access: READ-WRITE Attributes: none Description: Flag which indicates whether the interface is enabled or not. |
| MapId | Type: TEXT Access: READ-ONLY Attributes: none Description: The unique persistent identifier for the map to which the interface belongs. |
| IMID | Type: TEXT Access: READ-ONLY Attributes: INDEX Description: Identifier of the interface in the IMID format. |
| TypeInt | Type: INTEGER Access: READ-ONLY Attributes: none Description: The interface type as a number. |
| RecvSpeed + | Type: INTEGER Access: READ-WRITE Attributes: none Description: Unsigned 64-bit integer. 0 means baseband; speed in Speed. |
| StatusInt | Type: INTEGER Access: READ-ONLY Attributes: none Description: The status of the interface as integer. Values correspond to {UP, DOWN, ADMIN-DOWN, DOWN but locally acked}. |
| CustomerNameReference | Type: TEXT Access: READ-ONLY Attributes: none Description: Customer-supplied name, for referencing an external database. |
| DataRetentionPolicy | Type: INTEGER Access: READ-ONLY Attributes: none Description: Database data retention policy. |
| Duplex | Type: TEXT Access: READ-ONLY Attributes: none Description: Interface Duplex status. |
| VLANs | Type: TEXT Access: READ-ONLY Attributes: none Description: Comma-separated list of this interface's VLANs. |
| NatVLAN + | Type: INTEGER Access: READ-WRITE Attributes: none Description: Native VLAN. Signed integer (0-4093). 0 means none. |