otupy.profiles.ctxd.data.network_function.NetworkFunction

class NetworkFunction(netfun: object = None, name: str = None, id: str = None, description: str = None, version: str = None, type: NetworkFunctionType = None)

Bases: CTXDObject

Network Function

A network function process network packets for both forwarding and security purposes. It can be hosted on baremetal devices, general purpose computers, containers, and other virtualization mechanisms (e.g., Linux namespaces). In these terms, the same model applies for both legacy network devices and Network Virtual Functions.

Methods

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

Attributes

`description`	Generic description of the node (including its role)
`id`	ID of the node, preferably globally unique
`name`	A name for this node (e.g., network namespace name)
`type`	Type of the network function, including more complex data objects.
`version`	Version/release of this function

__init__(netfun: object = None, name: str = None, id: str = None, description: str = None, version: str = None, type: NetworkFunctionType = None)

description: str = None: Generic description of the node (including its role)

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 node, preferably globally unique

name: str = None: A name for this node (e.g., network namespace name)

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.

type: NetworkFunctionType = None: Type of the network function, including more complex data objects.

version: str = None: Version/release of this function