Interface (IPv4Intf & IPv6Intf) Objects

This page contains descriptions of the ASIC Daemon (asicd) objects directly related to interfaces as well as their associated data structures in FlexSwitch.

Attention

Attributes without default values listed are required in API calls.

Configuration Objects

IPv4Intf

config/IPv4Intf

Attribute Date Type Description Permitted Values
IntfRef [Key] string Interface name or ifindex of port/lag or vlan on which this IPv4 object is configured.
IpAddr string Interface IP/Net mask in CIDR format to provision on switch interface
Max Length =18
AdminState string Administrative state of this IP interface SELECTION: UP/DOWN
DEFAULT:UP

IPv6Intf

config/IPv6Intf

Attribute Date Type Description Permitted Values
IntfRef [Key] string Interface name or ifindex of port/lag or vlan on which this IPv4 object is configured
IpAddr string Interface Global Scope IP Address/Prefix-Length to provision on switch interface
Max Length = 43 characters
DEFAULT: “”
LinkIp bool Interface Link Scope IP Address auto-configured DEFAULT: true
AdminState string Administrative state of this IP interface SELECTION: UP/DOWN
DEFAULT: UP

LogicalIntf

config/LogicalIntf

Attribute Date Type Description Permitted Values
Name [Key] string Name of logical interface
Type string Type of logical interface (e.x. loopback)
Max Length = 16 characters
SELECTION:Loopback
DEFAULT: Loopback

SubIPv4Intf

config/SubIPv4Intf

Attribute Date Type Description Permitted Values
IntfRef [Key] string Intf name for which ipv4Intf sub interface is to be configured.
Type [Key] string Type of interface, e.g. Secondary SELECTION: Secondary
IpAddr string Ip Address for sub interface.
Max Length = 18 characters
MacAddr string Mac address to be used for the sub interface. If none specified IPv4Intf mac address will be used.
Maximum Length = 17 characters
DEFAULT: “”
Enable bool Enable or Disable this interface. DEFAULT: true

SubIPv6Intf

config/SubIPv6Intf

Attribute Date Type Description Permitted Values
IntfRef [Key] string Intf name for which ipv6Intf sub interface is to be configured.
Type [Key] string Type of interface, e.g. Secondary.
Max Length = 16 characters
SELECTION:Secondary
IpAddr string Ip Address for sub interface.
Maximum Length = 43 characters
MacAddr string Mac address to be used for the sub interface. If none specified IPv6Intf mac address will be used.
Max Length = 17 characters
DEFAULT: “”
LinkIp bool Interface Link Scope IP Address auto-configured DEFAULT: true
Enable bool Enable or disable this interface DEFAULT: true

State Objects

IPv4IntfState

state/IPv4Intf

Attribute Date Type Description Permitted Values
IntfRef [Key] string System assigned interface id of L2 interface (port/lag/vlan) to which this IPv4 object is linked
IfIndex int32 System assigned interface id for this IPv4 interface
IpAddr string Interface IP/Net mask in CIDR format to provision on switch interface
OperState string Operational state of this IP interface
NumUpEvents int32 Number of times the operational state transitioned from DOWN to UP
LastUpEventTime string Timestamp corresponding to the last DOWN to UP operational state change event
NumDownEvents int32 Number of times the operational state transitioned from UP to DOWN
LastDownEventTime string Timestamp corresponding to the last UP to DOWN operational state change event
L2IntfType string Type of L2 interface on which IP has been configured (Port/Lag/Vlan)
L2IntfId int32 Id of the L2 interface. Port number/lag id/vlan id.

IPv6IntfState

state/IPv6Intf

Attribute Date Type Description Permitted Values
IntfRef [Key] string System assigned interface id of L2 interface (port/lag/vlan) to which this IPv4 object is linked
IfIndex int32 System assigned interface id for this IPv4 interface
IpAddr string Interface IP Address/Prefix-Length to provisioned on switch interface
OperState string Operational state of this IP interface
NumUpEvents int32 Number of times the operational state transitioned from DOWN to UP
LastUpEventTime string Timestamp corresponding to the last DOWN to UP operational state change event
NumDownEvents int32 Number of times the operational state transitioned from UP to DOWN
LastDownEventTime string Timestamp corresponding to the last UP to DOWN operational state change event
L2IntfType string Type of L2 interface on which IP has been configured (Port/Lag/Vlan)
L2IntfId int32 Id of the L2 interface. Port number/lag id/vlan id

LogicalIntfState

state/LogicalIntf

Attribute Date Type Description Permitted Values
Name [Key] string Name of logical interface.
IfIndex int32 System assigned interface id for this logical interface.
SrcMac string Source Mac assigned to the interface.
OperState string Operational state of logical interface.
IfInOctets int64 RFC2233 Total number of octets received on this port.
IfInUcastPkts int64 RFC2233 Total number of unicast packets received on this port.
IfInDiscards int64 RFC2233 Total number of inbound packets that were discarded.
IfInErrors int64 RFC2233 Total number of inbound packets that contained an error.
IfInUnknownProtos int64 RFC2233 Total number of inbound packets discarded due to unknown protocol.
IfOutOctets int64 RFC2233 Total number of octets transmitted on this port.
IfOutUcastPkts int64 RFC2233 Total number of unicast packets transmitted on this port.
IfOutDiscards int64 RFC2233 Total number of error free packets discarded and not transmitted.
IfOutErrors int64 RFC2233 Total number of packets discarded and not transmitted due to packet errors.

SubIPv4IntfState

state/SubIPv4Intf

Attribute Date Type Description Permitted Values
IntfRef [Key] string Intf name for which ipv4Intf sub interface is to be configured.
Type [Key] string Type of interface (e.g, Secondary or Virtual)
IfIndex int32 System assigned interface id for this sub IPv4 interface.
IfName string System generated sub interface name.
ParentIfIndex int32 System assigned interface id for interface parent interface.
IpAddr string Ip Address for sub interface.
MacAddr string Mac address to be used for the sub interface. If none specified IPv4Intf mac address will be used.
OperState string Operational state of this SubIPv4 interface.

SubIPv6IntfState

state/SubIPv6Intf

Attribute Date Type Description Permitted Values
IntfRef [Key] string Intf name for which ipv6Intf sub interface is to be configured.
Type [Key] string Type of interface, e.g. Secondary or Virtual
IfINdex int32 System assigned interface id for this sub IPv6 interface
IfName string System generated sub interface name
ParentIfIndex int32 System assigned interface id for interface parent interface
IpAddr string Ip Address for sub interface
MacAddr string Mac address to be used for the sub interface. If none specified IPv6Intf mac address will be used.
OperState string Operational state of this SubIPv6 interface.