otupy.profiles.xbom.data.network_node.NetworkNode

class NetworkNode(node: object = None, name: str = None, id: str = None, description: str = None, ifaces: ~otupy.types.base.array_of.ArrayOf.__new__.<locals>.ArrayOf = None)

Bases: XBOMObject

Network node

A NetworkNode is a network slice made of interfaces and IP/MAC addresses. In Linux, such slice is represented by network namespaces. Within a router or switch, there may be other practical implementation of network slides.

A NetworkNode has one or more network interfaces, which one with network identifiers specific to the implemented protocols (e.g., MAC addresses for Ethernet, IP addresses for IP).

The NetworkNode is a subsystem for both ``Host``s and ``ExecutionEnvironment``s. In the first case, it is usually setup by infrastructure managers (e.g., CMS) and typically represents ``physical’’ ports available on the hardware. In the second case, it is the collection of network interfaces available in the network slice.

Methods

as_cyclonedx

Convert NetworkNode to CycloneDX service format.

fromdict

Builds instance from dictionary

todict

Converts to dictionary

Attributes

description

Generic description of the node (including its role)

id

ID of the node, preferably globally unique

ifaces

Network interfaces with addresses

name

A name for this node (e.g., network namespace name)

__init__(node: object = None, name: str = None, id: str = None, description: str = None, ifaces: ~otupy.types.base.array_of.ArrayOf.__new__.<locals>.ArrayOf = None)
as_cyclonedx() Service | list[Property]

Convert NetworkNode to CycloneDX service format.

Returns:

Service: CycloneDX Service.

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

ifaces: ArrayOf = None

Network interfaces with addresses

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.