Page History
About this Resource
| Excerpt |
|---|
Defines Logical Interface Managed Object |
REST API Methods for this Resource
Resource Schema
Configuration
| Parameter Name | Required | Service Affecting | Data Type | Default Value | Possible Values | Description |
|---|---|---|---|---|---|---|
| ifName | Yes | No | string | none | 20 - Max Length | Is the name of the port or logical IP interface. This is a read-only attribute. |
| ifAlias | No | No | string | none | 20 - Max Length | Assigns an alternative name for the interface; typically configured by the SNMP-based Network Manager. This parameter is unique among all the interfaces known to the SNMP Network Manager. The value cannot have whitespace characters. |
| ifHwType | No | No | Enum | 0 | Possible values:
| Specifies the hardware type of the interface. |
| ifType | No | No | Enum | 0 | Possible values:
| Specifies the interface type. |
| ifDescription | No | No | string | none | 64 - Max Length | Assigns an operator-friendly description text configured by the operator for future reference. Whitespaces are alowed. |
| ifNetworkingMode | No | No | Enum | 0 | Possible values:
| Specifies if the port is in switched mode or routed mode. |
| ifFrameType | No | Yes | Enum | 0 | Possible values:
| Specifies the types of frames allowed when in switched mode. |
| ifDefaultVid | No | Yes | string | none | 8 - Max Length | Specifies the default vlan id of the port is member. of the format (portname:default vlanid) (max= (32:4095)) |
| ifHybridVlan | No | Yes | string | none | 256 - Max Length | Specifies the list of vlans to be associated with a port in hybrid state. of the format "(port row id:vlanid),(port row id:vlanid)....." Range of vlanid is 1-4095 |
| ipAddressingMode | No | No | Enum | 0 | Possible values:
| Specifies the address mode. Currently only IPv4 is supported. |
| ifIpAddrAssignMethod | No | Yes | Enum | 0 | Possible values:
| Specifies whether IP address assignment is static or dynamic (i.e. via DHCP). If dynamic is specified, certain node-level settings (i.e. NTP servers, DNS servers, and Domain Name) will be configured such that they obtain their values through DHCP. This is achieved by setting useDynamicNetSettings to true in the System managed object. In addition to this, any statically configured default routes will be removed from the system. If static is specified, and no other interface is using dynamic, the useDynamicNetSettings will be set to false and the node-level network attributes will be set to use the user configured values. |
| ifIPv4AddressPrimary | Yes | Yes | string | none | 16 - Max Length | Specifies the primary IP address for the interface. |
| ifIPv4AddressPrimaryMask | Yes | Yes | string | none | 16 - Max Length | Specifies the primary netmask for the interface. |
| ifIPv4ConfigSecondaryEnabled | No | Yes | Enum | 0 | Possible values:
| Determines if the port has a secondary IP address configuration. If this field is set to Yes, a secondary IP address and secondary Netmask must be configured. |
| ifIPv4AddressSecondary | No | Yes | string | none | 16 - Max Length | Specifies the secondary IP address for the interface. |
| ifIPv4AddressSecondaryMask | No | Yes | string | none | 16 - Max Length | Specifies the secondary netmask for the interface. |
| ifBridgeGroupId | Yes | Yes | int | 1 | Possible values:
| Configures the bridge group that the Ethernet port will be part of. If it's a logical interface, it must be 0. If it's a hardware interface, the default should be 1. |
| ifConfiguredSpeed | No | Yes | Enum | 2 | Possible values:
| Configures autonegotiation or a specific speed for the Ethernet port. The default value should be changed only when absolutely necessary.
|
| ifConfiguredDuplexity | No | Yes | Enum | 2 | Possible values:
| Configures auto-negotiation or a specific value for the duplexity of the Ethernet port. The default value should be changed only when absolutely necessary.
|
| ifInterfaceIndex | Yes | No | int | 0 | Possible values:
| Is a positive number automatically assigned by the software and is unique among all interfaces and ports in the system. This number is typically used by the SNMP Network Manager. This is a read-only attribute. |
| ifIPv4ConfigPrimaryEnabled | No | No | Enum | 1 | Possible values:
| Specifies whether the primary IP address is enabled or not. |
| OSPFDeadInterval | No | Yes | int | 40 | Possible values:
| Specifies the time interval in seconds during which no hello packets are received and after which a neighbor is declared dead. |
| OSPFHelloInterval | No | Yes | int | 10 | Possible values:
| Specifies the time interval in seconds between hello packets. |
| OSPFPriority | No | Yes | int | 1 | Possible values:
| Specifies the router priority to determine the DR (designated router) for the network |
| OSPFCost | No | Yes | int | 1 | Possible values:
| Specifies the cost of the link-state metric in a router-LSA |
| OSPFRetransmitInterval | No | Yes | int | 5 | Possible values:
| Specifies the time in seconds between link-state advertisement (LSA) retransmissions for adjacencies belonging to the interface |
| OSPFResyncTimeout | No | Yes | int | 40 | Possible values:
| Specifies the time interval in seconds after which adjacency is reset if out-of-band resynchronization has not occured. The interval period starts from the time a restart signal is received from a neighbor. |
| aclInInstanceID | No | Yes | int | 0 | Specifies the ACL instance applied on this interface for the incoming traffic. | |
| aclOutInstanceID | No | Yes | int | 0 | Specifies the ACL instance applied on this interface for the outgoing traffic. | |
| aclForwardInstanceID | No | Yes | int | 0 | Specifies the ACL instance applied on this interface for the forwarding traffic. | |
| ifMstpStatus | No | Yes | Enum | 0 | Possible values:
| Specifies the MSTP status on this interface. |
| DHCPSuppliedParamUsage | No | Yes | Enum | 0 | Possible values:
| Determines how the SBC should use the parameters supplied by the DHCP server, when a logical interface is configured with Dynamic IP addressing.
|
| ConfigureSplitDNS | No | Yes | Enum | 0 | Possible values:
| Determines whether the SBC should create split-DNS settings automatically from the DNS and domain name parameters supplied by the DHCP server on this logical IP interface. This field is valid only if DHCPSuppliedParamUsage is set to the value "USE_IP_DNS_ONLY".
|
| useUniqueMAC | No | No | Enum | 0 | Possible values:
| Enables setting of unique MAC Address on the interface. This attribute is applicable only for default VLAN interfaces. When disabled, the interface will use the system wide MAC Address. |
Overview
Content Tools