otupy.profiles.ctxd.data.network_interface.NetworkInterface

class NetworkInterface(interface=None, description=None, id=None, mac=None, iface=None, ips=None)

Bases: Record

Network Interface

This object describes a network interface in general terms

Methods

`fromdict`	Builds instance from dictionary
`todict`	Converts to dictionary

Attributes

`description`	Generic description of the interface (rarely available)
`id`	ID of the interface (use iface index for Execution Environments and other id for cloud systems)
`iface`	Name of the network interface (OS dependent)
`ips`	List of IP addresses/gateways associated to the interface
`mac`	MAC or similar L2 addresses associated to this port (not implemented)

__init__(interface=None, description=None, id=None, mac=None, iface=None, ips=None)

description: str = None: Generic description of the interface (rarely available)

classmethod fromdict(dic, e)

Builds instance from dictionary

It is used during deserialization to create an otupy instance from the text message. It takes an Encoder instance that is used to recursively build instances of the inner objects (the Encoder provides standard methods to create instances of base objects like strings, integers, boolean).

Parameters:

dic – The intermediary dictionary representation from which the object is built.
e – The Encoder that is being used.

Returns:

An instance of this class initialized from the dictionary values.

id: str = None: ID of the interface (use iface index for Execution Environments and other id for cloud systems)

iface: str = None: Name of the network interface (OS dependent)

ips: ArrayOf = None: List of IP addresses/gateways associated to the interface

mac: MACAddr = None: MAC or similar L2 addresses associated to this port (not implemented)

todict(e)

Converts to dictionary

It is used to convert this object to an intermediary representation during serialization. It takes an Encoder argument that is used to recursively serialize inner data and structures (the Encoder provides standard methods for converting base types to dictionaries)..

Parameters:: e – The Encoder that is being used.
Returns:: A dictionary compliants to the Language Specification’s serialization rules.