Home | Trees | Indices | Help |
|
---|
|
This class represents a NetworkInterface. It is used for both physical and logical interfaces.
Instance Methods | |||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
bool
|
|
||
|
|||
bool
|
|
||
InterfaceStatistics |
|
||
InterfaceProperty |
|
||
InterfaceStatus |
|
||
InterfaceConfiguration |
|
||
dictionary
|
|
||
NetworkInterface |
|
||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
list
|
|
||
list
|
|
||
NetworkInterface @return NetworkInterface class |
|
||
int
|
|
||
|
|||
int
|
|
||
|
|||
int
|
|
||
|
|||
Inherited from |
Class Methods | |||
|
|||
NetworkInterface |
|
Class Variables | |
Enum |
InterfaceTypes = enum('ONEP_IF_TYPE_UNSUPPORTED', 'ONEP_IF_TYP Enumeration of the logical interface types supported. |
IANAType = {'ONEP_IF_IANA_TYPE_ANY': 0, 'ONEP_IF_IANA_TYPE_OTH IANAType... |
|
interfaceTypeMap = {InterfaceTypes.ONEP_IF_TYPE_NULL: IANAType
|
|
ONEP_IF_ALL_HANDLES = -1
|
|
cdp_client = None
|
|
doc_vlan =
|
|
vlan = property(get_vlan, set_vlan, remove_vlan, doc_vlan)
|
Properties | |
Inherited from |
Method Details |
|
|
|
|
Constructor of NetworkInterface class.
|
The str() method returns the string representation of the NetworkInterface instance.
|
Two interface Objects are equal if they have the same network interface unique id and have the same NetworkElement parent Object.
|
Checks if two NetworkInterface Objects are equal or not. Two interface Objects are equal if they have the same network interface unique id and have the same NetworkElement parent Object.
|
Returns the NetworkInterface Statistics after querying the router.
|
Gets the hardware property of the NetworkInterface. The property is only retrieved once from the NetworkElement. It is hard property of the interface which do not change during life of the session.
|
Gets the snapshot status of the NetworkInterface. The status is a snapshot of the current condition of the NetworkInterface attributes. The status is retrieved on demand on every invocation.
|
Gets the configuration of the NetworkInterface. The software property comes from the configuration of the NetworkInterface, which might be changed during its session of life via configuration. The configuration is refreshed on every invocation.
|
Gets all the sub-interfaces attached to this network interface if any. For instance eth0:1 will be a sub-interface to eth0. If no subinterfaces under the interface, the interface itself is returned.
|
Gets the parent NetworkInterface of this interface if this is a sub-interface, or None if it is a physical (non virtual) interface or has no parent.
|
Creates dummy interface that matches any interface to be used in Interface filter. This is equivalent of empty interface object.
|
Sets MTU for an interface.
|
Sets the interface description.
|
Sets the interface Bandwidth.
|
Sets the interface encapsulation
|
Sets interface admin state to down or up. This method is equivalent of configuration command to shutdown an interface. Applications can set the shutdown value to TRUE to administratively shutdown the interface. Applications can set the shutdown value to FALSE to administratively bring the interface up.
|
Clears statistics for the given Interface.
Deprecated: Deprecated with SDK release 1.2.1 |
Gets a Location object associated with the network interface. The Location object can be used to access all types of location information.
|
Sets location information for the network interface. Sets location information for the network interface with the information in the input Location parameter.
|
Sets or Unset IP address on the interface. This API can be used to set either an IPv4 or IPv6 address on the Interface. The API also allows one to specify the scope of the address being configured. Following operations can be done with the API.
|
Enable UDP forwarding to specified address Throws on error OnepIllegalArgumentException - Invalid IP address Keyword arguments ipaddress -- string - IP address of host for forwarding operation vrf -- Vrf class - Virtual Route Forwarding set -- boolean - True = set forwarding, False = stop forwarding |
Turn on/off ARP proxy Keyword argument set -- boolean - True = turn on ARP proxy, False = turn off ARP proxy |
Turn on/off IP unreachable Keyword argument set -- boolean - True = turn on IP unreachable, False = turn off IP unreachable |
Turn on/off IP redirect Keyword argument set -- boolean - True = turn on IP redirect, False = turn off IP redirect |
Turn on/off IP Unicast Reverse Path Keyword arguments set -- boolean - True = turn on IP reverse path, False = turn off IP reverse path access_list -- string - name of access list for reverse path |
Gets a list of IP addresses (IPv4 or IPv6) associated with this
|
Gets a list of IP prefixes (IPv4 or IPv6 address and its mask) associated with this Interface. The Interfaces IP prefixes are returned as list of NetworkPrefix objects. The NetworkPrefix object contains the InetAddress object representing the IPv4 or IPv6 address and an integer for the prefix length.
|
Return a NetworkInterface class representing the sub-interface object matching the ID
|
Adds a Interface up/down state listener to NetworkElement Object.
|
Remove Interface up/down state listener from NetworkElement Object.
|
Subscribes to Interface statistics change events.
|
Remove Interface statistics change events listeners.
|
Subscribes to CDP events.
|
Remove CDP events listeners.
|
Class Variable Details |
InterfaceTypesEnumeration of the logical interface types supported. ONEP_IF_TYPE_UNSUPPORTED: Reserved ONEP_IF_TYPE_ANY: all types ONEP_IF_TYPE_NULL: Null interface ONEP_IF_TYPE_LOOPBACK: Loopback interface ONEP_IF_TYPE_ETHERNET: Ethernet interface ONEP_IF_TYPE_ETHER_CHANNEL: Ethernet channel interface. ONEP_IF_TYPE_GIGABIT_ETHERNET: Gigabit ethernet interface. Deprecated. Use ONEP_IF_TYPE_ETHERNET instead. ONEP_IF_TYPE_SERIAL: Serial interface. ONEP_IF_TYPE_TUNNEL: Tunnel interface. ONEP_IF_TYPE_P2P: Point to point interface ONEP_IF_TYPE_MULTI_LINK: Multi-link interface ONEP_IF_TYPE_TE: Traffic Engineering interface ONEP_IF_TYPE_PSEUDOWIRE: Psuedowire interface ONEP_IF_TYPE_WIRELESS: Wireless interface ONEP_IF_TYPE_ATM: ATM interface ONEP_IF_TYPE_FRAME_RELAY: Frame relay interface ONEP_IF_TYPE_VLAN: VLAN interface ONEP_IF_TYPE_PPP: PPP interface ONEP_IF_TYPE_MLP_BUNDLE: MLP bundle interface ONEP_IF_TYPE_POS: POS interface ONEP_IF_TYPE_POS_CHANNEL: POS channel interface ONEP_IF_TYPE_NATIVE_VLAN: Native VLAN interface ONEP_IF_TYPE_HDLC: HDLC interface ONEP_IF_TYPE_EFP: EFP interface ONEP_IF_TYPE_BVI: BVI interface ONEP_IF_TYPE_INTERFLEX_LEFT: InterflexLext interface ONEP_IF_TYPE_INTERFLEX_RIGHT: InterflextRight interface ONEP_IF_TYPE_PSEUDOWIRE_HE: Pseudowire interface ONEP_IF_TYPE_SUB_INTERFACE: Sub interface ONEP_IF_TYPE_MANAGEMENT: Management interface
Deprecated: ONEP_IF_TYPE_GIGABIT_ETHERNET
|
IANATypeIANAType # all types ONEP_IF_IANA_TYPE_ANY:0, # unknown types ONEP_IF_IANA_TYPE_OTHER:1, # Loopback interface ONEP_IF_IANA_TYPE_LOOPBACK:24, # Ethernet interface ONEP_IF_IANA_TYPE_ETHERNET:6, # Ethernet channel interface ONEP_IF_IANA_TYPE_ETHER_CHANNEL:161, # Gigabit ethernet interface ONEP_IF_IANA_TYPE_GIGABIT_ETHERNET:6, # Serial interface ONEP_IF_IANA_TYPE_SERIAL:22, # Tunnel interface ONEP_IF_IANA_TYPE_TUNNEL:132, # Point to point interface ONEP_IF_IANA_TYPE_P2P:23, # Multi-link interface ONEP_IF_IANA_TYPE_MULTI_LINK:121, # Traffic Engineering interface ONEP_IF_IANA_TYPE_TE:200, # Pseudo interface ONEP_IF_IANA_TYPE_PSEUDOWIRE:246, # Wireless interface ONEP_IF_IANA_TYPE_WIRELESS:157, # ATM interface ONEP_IF_IANA_TYPE_ATM:37, # Frame relay interface ONEP_IF_IANA_TYPE_FRAME_RELAY:32, # VLAN interface ONEP_IF_IANA_TYPE_VLAN:136, # PPP interface ONEP_IF_IANA_TYPE_PPP:23, # MLP bundle interface ONEP_IF_IANA_TYPE_MLP_BUNDLE:121, # POS interface ONEP_IF_IANA_TYPE_POS:171, # POS channel interface ONEP_IF_IANA_TYPE_CHANNEL:70, # HDLC interface ONEP_IF_IANA_TYPE_HDLC:118, # EFP interface ONEP_IF_IANA_TYPE_EFP:135, # BVI interface ONEP_IF_IANA_TYPE_BVI:209
|
interfaceTypeMap
|
doc_vlan
|
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0.1 on Mon Aug 18 09:17:30 2014 | http://epydoc.sourceforge.net |