Interfaces object model
The object model describing this resource contains the following objects.
ethernetInterface
| Attribute | JSON type | Data type | Description |
| isAdminVirtualServerIpAllowed | Boolean | Boolean | True if the admin virtual server IP address is allowed; false otherwise. |
| isAdvancedIpConfigAllowed | Boolean | Boolean | True if the advanced IP address configuration is allowed; false otherwise. |
| isAggregationAllowed | Boolean | Boolean | True if aggregation is allowed; false otherwise. |
| isClusterNodeIpAllowed | Boolean | Boolean | True if the cluster node address is allowed; false otherwise. |
| isVirtualServerIpAllowed | Boolean | Boolean | True if the virtual server IP address is allowed; false otherwise. |
| name | string | string | Name of the Ethernet interface. |
interface
| Attribute | JSON Type | Data Type | Description |
| port | string | string | Name of a physical port |
| status | string | string |
Status of the port. Possible values are:
|
aggregateInterface
| Attribute | JSON Type | Data Type | Description |
| interfaces | object | array | An array of interface objects, that identify the physical ports that are used by the aggregate interface. |
| lacpEnabled | boolean | boolean | True if LACP is enabled on the aggregate link. |
| loadBalance | string | string |
Load balancing algorithm used for links that include multiple ports. Possible values are:
|
| name | string | string | The name of the aggregate port. The name must start with “ag-“ |
| objectId | string | string | Unique object ID to identify the aggregate. |
vlanInterface
| Attribute | JSON Type | Data Type | Description |
| aggregateInterface | string | string | The aggregate interface that is associated with the VLAN. |
| name | string | string | The name of the VLAN interface. The name is automatically generated from the aggregate interface and vlanId values. The name can be used when assigning IP addresses to ports for virtual servers. |
| objectId | string | string | Unique object ID to identify the VLAN/aggregate combination. |
| vlanId | number | integer | This is the VLAN tag that will be applied to traffic on the VLAN interface. |
hostPort
| Attribute | JSON Type | Data Type | Description |
| isEnabled | boolean | boolean | True if the port is enabled. |
| name | string | string | Name of the port. |
| nodeId | number | integer | Node ID of the device. |
| objectId | string | string | Unique object ID to identify the host port. |
| speed | number | integer | Speed, in Gbps that the port is operating at. A value of 0 indicates the port will auto-negotiate the speed with the far end device. The supported speeds will differ depending on HNAS model. |
| status | string | string |
Status of the port. Possible values are:
Upper case status values indicate that the port has been in this state for a prolonged period of time. |
| type | string | string |
Mode that the port is operating in. Either fabric switch attached (N) or arbitrated loop operation (NL). Possible values are:
|
| wwn | string | string | World wide name – equivalent to the MAC address. |