Versions Compared

Old Version 5

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version Current

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

About this Resource

Available_since
Type Available Since
Release2.0.0
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
ConfigIEStateNoYesEnum1Possible values:
  • 0 - esDISABLED
  • 1 - esENABLED
Specifies the Administrative State of the resource.
ifNameYesNostringnone20 - Max LengthIs the name of the port or logical IP interface. This is a read-only attribute.
ifAliasNoNostringnone20 - 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.
ifHwTypeNoNoEnum0Possible values:
  • 0 - IF_HW_TYPE_ETHERNET
  • 1 - IF_HW_TYPE_T1E1
  • 2 - IF_HW_TYPE_RS530
 Specifies the hardware type of the interface.
ifTypeNoNoEnum0Possible values:
  • 0 - IF_TYPE_ETHERNET
  • 1 - IF_TYPE_VLAN
  • 2 - IF_TYPE_QINQ
  • 3 - IF_TYPE_BONDED
  • 4 - IF_TYPE_BRIDGE
 Specifies the interface type.
ifDescriptionNoNostringnone64 - Max LengthAssigns an operator-friendly description text configured by the operator for future reference. Whitespaces are alowed.
ifNetworkingModeNoNoEnum0Possible values:
  • 0 - IF_NETWORK_MODE_SWITCH
  • 1 - IF_NETWORK_MODE_ROUTE
 Specifies if the port is in switched mode or routed mode.
ifFrameTypeNoYesEnum0Possible values:
  • 0 - IF_FRAME_TYPE_ALL
  • 1 - IF_FRAME_TYPE_UNTAGGED
  • 2 - IF_FRAME_TYPE_TAGGED
 Specifies the types of frames allowed when in switched mode.
ifDefaultVidNoYesstringnone8 - Max Length

...

For the SBC 1k/2k this specifies the default

...

VLAN ID of the port it is member

...

of, with the format (portname:default vlanid) (max= (32:4095)). For SWe Lite if set this is the VLAN value of the VLAN sub-interface with the range from 1 to 4094.
ifHybridVlanNoYesstringnone256 - Max LengthSpecifies 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
ipAddressingModeNoNoEnum0Possible values:
  • 0 - IPV4_ADDR_MODE
  • 1 -

...

  • IPV6_ADDR_MODE
  • 2 - IPV4_AND_IPV6
 Specifies the address mode.

...

Can be IPv4, IPv6, or both.
ifIpAddrAssignMethodNoYesEnum0Possible values:
  • 0 - IP_ADDRESS_STATIC
  • 1 - IP_ADDRESS_DYNAMIC
 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.
ifIPv4AddressPrimaryYesYesstringnone16 - Max LengthSpecifies the primary IP address for the interface.
ifIPv4AddressPrimaryMaskYesYesstringnone16 - Max LengthSpecifies the primary netmask for the interface.
ifIPv4NextHopYesYesstringnone16 - Max LengthSpecifies the next hop IPv4 Address for this interface. This is needed to route media on this interface, and is only applicable to the SWe Lite.
ifIPv4ConfigSecondaryEnabledNoYesEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
 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.
ifIPv4AddressSecondaryNoYesstringnone16 - Max LengthSpecifies the secondary IP address for the interface.
ifIPv4AddressSecondaryMaskNoYesstringnone16 - Max LengthSpecifies the secondary netmask for the interface.
ifIPv6AddressPrimaryYesYesstringnone45 - Max LengthSpecifies the primary IPv6 address for the interface.
ifIPv6AddressPrimaryPrefixNoYesint64Possible values:
  • 1 - Minimum
  • 127 - Maximum
Specifies the primary IPv6 network prefix length for the interface.
ifIPv6NextHopYesYesstringnone45 - Max LengthSpecifies the next hop IPv6 Address for this interface. This is needed to route media on this interface, and is applicable only to the SWe Lite.
ifBridgeGroupIdYesYesint1Possible values:
  • 0 - Minimum
  • 5 - Maximum
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.
ifConfiguredSpeedNoYesEnum2Possible values:
  • 0 - IF_SPEED_10
  • 1 - IF_SPEED_100
  • 2 - IF_SPEED_1000
  • 3 - IF_SPEED_AUTO
 Configures autonegotiation or a specific speed for the Ethernet port. The default value should be changed only when absolutely necessary.
  • When AUTO is selected
    - the speed is automatically negotiated by the Ethernet port and the negotiated speed is reported under Negotiated Speed.
  • When AUTO is not selected
    - the Ethernet speed-auto-negotiation is disabled and the operator must configure a specific speed for the Ethernet port.If the configured speed does not match the attached device, the interface will become unreachable. The node may become unreachable on using the same interface for management.
ifConfiguredDuplexityNoYesEnum2Possible values:
  • 0 - IF_DUPLEX_HALF
  • 1 - IF_DUPLEX_FULL
  • 2 - IF_DUPLEX_AUTO
 Configures auto-negotiation or a specific value for the duplexity of the Ethernet port. The default value should be changed only when absolutely necessary.
  • When AUTO is selected
    - the duplexity is automatically negotiated by the Ethernet port. The negotiated duplexity is reported under Negotiated Speed.
  • When AUTO is not selected
    - the Ethernet-duplexity must be explicitly configured. If the configured duplexity does not match the attached device, the interface will become unreachable. The node may become unreachable on using the same interface for management.
ifInterfaceIndexYesNoint0Possible values:
  • 0 - Minimum
  • 2147483647 - Maximum
 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.
ifIPv4ConfigPrimaryEnabledNoNoEnum1Possible values:
  • 0 - IF_PRIMARY_IP_NOT_CONFIGURED
  • 1 - IF_PRIMARY_IP_CONFIGURED
 Specifies whether the primary IP address is enabled or not.
OSPFDeadIntervalNoYesint40Possible values:
  • 10 - Minimum
  • 600 - Maximum
 Specifies the time interval in seconds during which no hello packets are received and after which a neighbor is declared dead.
OSPFHelloIntervalNoYesint10Possible values:
  • 10 - Minimum
  • 600 - Maximum
 Specifies the time interval in seconds between hello packets.
OSPFPriorityNoYesint1Possible values:
  • 0 - Minimum
  • 255 - Maximum
 Specifies the router priority to determine the DR (designated router) for the network
OSPFCostNoYesint1Possible values:
  • 1 - Minimum
  • 600 - Maximum
 Specifies the cost of the link-state metric in a router-LSA
OSPFRetransmitIntervalNoYesint5Possible values:
  • 5 - Minimum
  • 600 - Maximum
 Specifies the time in seconds between link-state advertisement (LSA) retransmissions for adjacencies belonging to the interface
OSPFResyncTimeoutNoYesint40Possible values:
  • 10 - Minimum
  • 600 - Maximum
 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.
aclInInstanceIDNoYesint0 Specifies the ACL instance applied on this interface for the incoming traffic.
aclOutInstanceIDNoYesint0 Specifies the ACL instance applied on this interface for the outgoing traffic.
aclForwardInstanceIDNoYesint0 Specifies the ACL instance applied on this interface for the forwarding traffic.
ipv6AclInInstanceIDNoYesint0 Specifies the IPv6 ACL instance applied on this interface for the incoming traffic.
ipv6AclOutInstanceIDNoYesint0 Specifies the IPv6 ACL instance applied on this interface for the outgoing traffic.
ipv6AclForwardInstanceIDNoYesint0 Specifies the IPv6 ACL instance applied on this interface for the forwarding traffic.
ifMstpStatusNoYesEnum0Possible values:
  • 0 - IF_

...

  • NOT_

...

  • REDUNDANT
  • 1 - IF_MSTP

...

  • 2 - IF_FAILOVER
  • 3 - IF_UNSPECIFIED
 Specifies the MSTP status on this interface. This field is obsolete from release 7.0 onwards and is replaced by 'ifRedundancy'.
ifRedundancyNoYesEnum3Possible values:
  • 0 - IF_NOT_REDUNDANT
  • 1 - IF_MSTP
  • 2 - IF_FAILOVER
  • 3 - IF_UNSPECIFIED
 Specifies whether the interface is redundant, and if so whether it uses MSTP or Failover mode.
gigabitTimingModeNoNoEnum0Possible values:
  • 0 - AUTO
  • 1 - MASTER
  • 2 - SLAVE
 Controls gigabit timing mode on the interface. This should be left to "Auto" unless an interoperability issue requires setting the mode to either Slave or Master. This field is only applicable if the configured port speed is either Auto or 1000 mbps.
DHCPSuppliedParamUsageNoYesEnum0Possible values:
  • 0 - USE_ALL
  • 1 - USE_IP_

...

  • DEFAULT
  • 2 - USE_IP_DNS_ONLY
  • 3 - USE_IP_ONLY
 Determines how the SBC should use the parameters supplied by the DHCP server, when a logical interface is configured with Dynamic IP addressing.
  • USE_ALL - all supported DHCP parameters are used by the SBC. The supplied DNS servers are used as global DNS servers, replacing the ones already configured. Split-DNS settings are not affected.
  • USE_IP_

...

  • DEFAULT - only the IP address,netmask and

...

  • default route are used by the SBC. DNS server and other settings are ignored. Split-DNS settings already in place are not affected.
  • USE_IP_DNS_ONLY - only the IP address, domain-name and DNS server IP addresses are used by the SBC. The supplied domain-name and the DNS server IP addresses are used depending on the value of the ConfigureSplitDNS attribute.
  • USE_IP_ONLY - only the IP address and netmask are used by the SBC. DNS server and other settings are ignored. This option applies to SWe Lite only.
ConfigureSplitDNSNoYesEnum0Possible values:
  • 0 - btFalse
  • 1 - btTrue
 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".
  • TRUE - SBC configures split-DNS settings by adding one row for each combination of the domain-name and the DNS-server, from the lists supplied by the DHCP server. When the DHCP-lease expires, the split-DNS settings also automatically removed.
  • FALSE - SBC configures the IP address and netmask for the logical interface and uses the DNS server/domain-name parameters as global settings. Split-DNS settings are not automatically added when a lease is renewed. If any split-DNS settings had been added, they are removed.

...

NetworkMappedNo

...

YesEnum

...

1Possible values:
  • 0 - btFalse
  • 1 - btTrue

...

Specifies whether this interface is configured on the SWe Lite system.
Note

This attribute is only applicable

...

for the SWe Lite.

ifRedundantPortNoNoEnum0Possible values:
  • 0 - IF_NONE
  • 1 - IF_ETHERNET_1
  • 2 - IF_ETHERNET_2
  • 3 - IF_ETHERNET_3
  • 4 - IF_ETHERNET_4
 Selects which Ethernet port is the redundant port. This can only be configured when 'ifMstpStatus' is set to 'Failover'.