InterfaceData
Description
An object specifying InterfaceData and its properties. (Note: The field level constraints listed here might not cover all the constraints on the field. Additional constraints might exist.)
Supported Operations
Model Properties
| Property | Required | Type | Description | |||
|---|---|---|---|---|---|---|
| name | False | string | Interface Operational API | |||
| hardwareName | False | string | A mandatory UTF-8 string for the PhysicalInterfaces and SubInterfaces, which normally specifies the type of Interface along with the Interface number. The string cannot contain HTML tags. | |||
| ipv4Address | False | object | IPv4 Address | |||
| ipv6Address | False | object | IPv6 Address | |||
| macAddress | False | string | An optional String value, to specify a virtual MAC address. The MAC address must be in the format H.H.H where each H is a 16-bit hexadecimal number. For example, 000C.F142.4CDE | |||
| speedType | False | string | An enum value that specifies the Interface Speed Type, where AUTO is the default .Values can be one of the following. AUTO - Enable auto-negotiation for this interface. TEN - Force 10 Mbps. HUNDRED - Force 100 Mbps. THOUSAND - Force 1 Gbps. TEN_THOUSAND - Force 10 Gbps. NO_NEGOTIATE - Do not negotiate speed. IGNORE - Do not configure Interface speed. |
|||
| enabled | False | boolean | A mandatory Boolean value, TRUE or FALSE (the default), specifies the administrative status of the Interface. The TRUE value enables the administrative status on the device. The value FALSE disables the administrative status on the device. | |||
| linkState | False | string | An enum value that specifies whether the Physical Interface link state is UP or DOWN (the default). Link state of an interface is the operational status/running status of the interface. The values can be one of the following. UP - Specifies whether the device is operationally UP. DOWN - Specifies whether the device is operationally DOWN. |
|||
| voltage | False | string | Real time value of voltage supplied by the port in volts | |||
| current | False | string | Real time value of current supplied by the port in milli amps | |||
| id | False | string | A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object. Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist) |
|||
| type | True | string | A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name. | |||