Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

About this Resource

The Ethernet Port Table resource controls the Sonus SBC 1000/2000 system's ethernet port configuration settings.

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 Length Is 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.
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 Length Assigns 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 Specifies the default vlan id of the port is member. of the format (portname:default vlanid) (max= (32:4095))
ifHybridVlanNoYesstringnone256 - 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
ipAddressingModeNoNoEnum0Possible values:
  • 0 - IPV4_ADDR_MODE
  • 1 - IPv6_ADDR_MODE
  • 2 - IPV4_AND_IPV6
Specifies the address mode. Currently only IPv4 is supported.
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 Length Specifies the primary IP address for the interface.
ifIPv4AddressPrimaryMaskYesYesstringnone16 - Max Length Specifies the primary netmask for the interface.
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 Length Specifies the secondary IP address for the interface.
ifIPv4AddressSecondaryMaskNoYesstringnone16 - Max Length Specifies the secondary netmask for the interface.
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.
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.
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.
ifMstpStatusNoYesEnum0Possible values:
  • 0 - IF_MSTP_DISABLED
  • 1 - IF_MSTP_ENABLED
Specifies the MSTP status on this interface.

Runtime

Parameter Name Description
rt_ifSpeed An estimate of the interface's current bandwidth in bits per second.
rt_ifDuplexity The current duplexity of the interface.
rt_ifLastChange The value of sysUpTime at the time the interface entered its current operational state.
rt_ifHwConnectorType The SFP type for this interface. Currently all interfaces are copper.
rt_ifCableMediaType The cable type for this interface. Currently all interfaces are copper.
rt_ifOperatorStatus The operational status of the interface.
rt_ifMtu The size of the largest packet which can be sent/received on the interface.
rt_ifCounterDiscontinuityTime The value of sysUpTime on the most recent occasion at which any one or more of this interface's counters suffered a discontinuity.
rt_ifName Is the name of the ethernet port or logical interface.
rt_ifIPv4Address The IPv4 address assigned to the interface. Only valid for interfaces with their assign method set to dynamic.
rt_ifIPv4Netmask The IPv4 netmask assigned to the interface. Only valid for interfaces with their assign method set to dynamic.
rt_stpBpduVersionReceived The Spanning Tree Protocol BPDU version received on this port.
rt_stpBpduVersionTransmitted The Spanning Tree Protocol BPDU version transmitted on this port.

Statistics

Parameter Name Description
rt_ifInUcastPktsDisplays the number of received unicast packets on this port.
rt_ifInBroadcastPkts Displays the number of received broadcast packets on this port.
rt_ifInMulticastPktsDisplays the number of received multicast packets on this port.
rt_ifInOctets Displays the number of received octets on this port.
rt_ifInErrorsDisplays the number of errors detected on this port.
rt_ifInDiscardsDisplays the number of discard errors detected on this port.
rt_ifInUnknwnProtoDisplays the number of Unknown Protocol errors detected on this port.
rt_ifInUndersizedPktsDisplays the number of Undersized Packet errors detected on this port.
rt_ifInOverSizedPktsDisplays the number of Oversized Packet errors detected on this port.
rt_ifInFCSErrorsDisplays the number of discard Frame Check Sequence errors detected on this port.
rt_ifInAlignErrorsDisplays the number of Align errors detected on this port.
rt_ifInFragmentedPktsDisplays the number of Fragmented Packet errors detected on this port.
rt_ifOutUcastPktsDisplays the number of transmitted unicast packets on this port.
rt_ifOutOctets Displays the number of transmitted octets on this port.
rt_ifOutBroadcastPktsDisplays the number of transmitted broadcast packets on this port.
rt_ifOutMulticastPkts Displays the number of transmitted multicast packets on this port.
rt_ifOutErrorsDisplays the number of errors detected on this port.
rt_ifOutDiscardsDisplays the number of discard errors detected on this port.
rt_ifOutLateCollissionsDisplays the number of Late Collision errors detected on this port.
rt_ifOutDeferredTransmissionsDisplays the number of Deferred Transmission errors detected on this port.
  • No labels