otupy.profiles.ctxd.data.network.Network

class Network(network=None, description=None, name=None, id=None, type=None, version=None)

Bases: CTXDObject

Networking service

A Network is a service able to transfer packets. There are different types of networks, subject to different composition patterns (e.g., physical ethernet, 5G networks, VLAN, etc.).

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 network (Ethernet, veth link, VLAN, ...)

version

Version of the network implementation

__init__(network=None, description=None, name=None, id=None, type=None, version=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: NetworkType = None

Type of network (Ethernet, veth link, VLAN, …)

version: str = None

Version of the network implementation