Package onep :: Package interfaces :: Module NetworkInterface :: Class TunnelInterface
[frames] | no frames]

Class TunnelInterface


Tunnel Interface

Instance Methods
 
__init__(self, element, name=None, type=None, xoshandle=None, tunnel_id=None)
Tunnel Interface class constructor.
InterfaceConfiguration
get_config(self)
Gets the configuration of the NetworkInterface.
 
remove_tunnel_interface(self)
list
get_address_list(self)
Gets a list of IP addresses (IPv4 or IPv6) associated with this

Inherited from NetworkInterface: IANA_type, __eq__, __str__, add_cdp_listener, add_state_listener, add_statistics_listener, clear_statistics, equals, get_location, get_parent, get_prefix_list, get_property, get_statistics, get_status, get_sub_interface_by_id, get_subinterface_list, interface_type, name, network_element, remove_cdp_listener, remove_state_listener, remove_statistics_listener, remove_vlan, set_address, set_bw, set_description, set_encapsulation, set_ip_redirect, set_ip_unicast_reverse_path, set_ip_unreachable, set_iphelper, set_location, set_mtu, set_proxy_arp, set_vlan, set_vrf_forwarding, shut_down, xos_handle

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Class Methods

Inherited from NetworkInterface: get_empty_interface, get_interface_instance_by_type

Class Variables
  IPSEC_MODE_IPV4 = 1
  IPSEC_MODE_IPV6 = 2
  tunnel_source_ip = property(_get_source_ip, _set_source_ip, _d...
  tunnel_source_intf = property(_get_source_intf, _set_source_in...
  tunnel_destination_ip = property(_get_dest_ip, _set_dest_ip, _...
  ipsec_mode = property(_get_ipsec_mode, _set_ipsec_mode, _del_i...
  ipsec_profile = property(_get_ipsec_profile, _set_ipsec_profil...
  ike_profile = property(_get_ike_profile, _set_ike_profile, _de...
  mtu = property(_get_mtu, _set_mtu, _del_mtu, _doc_mtu)
  ip_address = property(_get_ip_address, _set_ip_address, _del_i...
  ip_unnumbered = property(_get_ip_unnumbered, _set_ip_unnumbere...

Inherited from NetworkInterface: IANAType, InterfaceTypes, ONEP_IF_ALL_HANDLES, cdp_client, doc_vlan, interfaceTypeMap, vlan

Properties

Inherited from object: __class__

Method Details

__init__(self, element, name=None, type=None, xoshandle=None, tunnel_id=None)
(Constructor)

 

Tunnel Interface class constructor.

    Keyword arguments:
    element   -- NetworkElement class - must be connected to element
    name      -- string - interface name -              Default: 'Tunnel'
    type      -- NetworkInterface.Interfacetype -       Default: TUNNEL
    xoshandle -- int - ID for managing API calls to IOS Default: None
    tunnel_id -- int - Tunnel interface number          Default: None

Overrides: object.__init__

get_config(self)

 

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.

Returns: InterfaceConfiguration
Raises:
Overrides: NetworkInterface.get_config
(inherited documentation)

get_address_list(self)

 

Gets a list of IP addresses (IPv4 or IPv6) associated with this

Returns: list
A list of ip addresses as strings.
Raises:
Overrides: NetworkInterface.get_address_list

Class Variable Details

tunnel_source_ip

Value:
property(_get_source_ip, _set_source_ip, _del_source_ip, _doc_source_i\
p)

tunnel_source_intf

Value:
property(_get_source_intf, _set_source_intf, _del_source_intf, _doc_so\
urce_intf)

tunnel_destination_ip

Value:
property(_get_dest_ip, _set_dest_ip, _del_dest_ip, _doc_dest_ip)

ipsec_mode

Value:
property(_get_ipsec_mode, _set_ipsec_mode, _del_ipsec_mode, _doc_ipsec\
_mode)

ipsec_profile

Value:
property(_get_ipsec_profile, _set_ipsec_profile, _del_ipsec_profile, _\
doc_ipsec_profile)

ike_profile

Value:
property(_get_ike_profile, _set_ike_profile, _del_ike_profile, _doc_ik\
e_profile)

ip_address

Value:
property(_get_ip_address, _set_ip_address, _del_ip_address, _doc_ip_ad\
dress)

ip_unnumbered

Value:
property(_get_ip_unnumbered, _set_ip_unnumbered, _del_ip_unnumbered, _\
doc_ip_unnumbered)