Skip to content

Class: IPv4 Connectivity (Ipv4Connectivity)

Configuration of an IP port. Please note that the configuration of an IP address is independent of the Ethernet port configuration.

URI: base:Ipv4Connectivity

 classDiagram
    class Ipv4Connectivity
    click Ipv4Connectivity href "../Ipv4Connectivity/"
      ConnectionPoint <|-- Ipv4Connectivity
        click ConnectionPoint href "../ConnectionPoint/"

      Ipv4Connectivity : connection_point_type

      Ipv4Connectivity : id

      Ipv4Connectivity : ipv4_address

      Ipv4Connectivity : name

      Ipv4Connectivity : network_mask

      Ipv4Connectivity : related_connection_points





        Ipv4Connectivity --> "*" RelatedConnectionPoint : related_connection_points
        click RelatedConnectionPoint href "../RelatedConnectionPoint/"



      Ipv4Connectivity : router_ipv4_address

Inheritance

Slots

Name Cardinality and Range Description Inheritance
ipv4_address 1
String
The IP v4 address of a device port direct
router_ipv4_address 0..1 recommended
String
The IPv4 address of the router (AKA gateway) corresponding to a IPv4 address direct
network_mask 0..1
String
The mask that segregates IPs v4 belonging to the same sub-network from the re... direct
related_connection_points *
RelatedConnectionPoint
A connection point might rely on another connection point to work ConnectionPoint
connection_point_type 1
String
Type designator that provides support for polymorphism using connection point... ConnectionPoint
id 0..1
String
The identifier is used to identify the connection point within the asset ConnectionPoint
name 0..1
String
Name of the connection point ConnectionPoint

Identifier and Mapping Information

Schema Source

  • from schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml

Mappings

Mapping Type Mapped Value
self base:Ipv4Connectivity
native base:Ipv4Connectivity

LinkML Source

Direct

name: Ipv4Connectivity
description: Configuration of an IP port. Please note that the configuration of an
  IP address is independent of the Ethernet port configuration.
title: IPv4 Connectivity
in_subset:
- DeviceInteraction
- Connectivity
from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
is_a: ConnectionPoint
slots:
- ipv4_address
- router_ipv4_address
slot_usage:
  connection_point_type:
    name: connection_point_type
    equals_string: Ipv4Connectivity
  ipv4_address:
    name: ipv4_address
    required: true
attributes:
  network_mask:
    name: network_mask
    description: The mask that segregates IPs v4 belonging to the same sub-network
      from the rest.
    title: network mask
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-connection-points.yaml
    rank: 1000
    domain_of:
    - Ipv4Connectivity
    range: string
    pattern: ^(255)\.(0|128|192|224|240|248|252|254|255)\.(0|128|192|224|240|248|252|254|255)\.(0|128|192|224|240|248|252|254|255)$
defining_slots:
- ipv4_address

Induced

name: Ipv4Connectivity
description: Configuration of an IP port. Please note that the configuration of an
  IP address is independent of the Ethernet port configuration.
title: IPv4 Connectivity
in_subset:
- DeviceInteraction
- Connectivity
from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
is_a: ConnectionPoint
slot_usage:
  connection_point_type:
    name: connection_point_type
    equals_string: Ipv4Connectivity
  ipv4_address:
    name: ipv4_address
    required: true
attributes:
  network_mask:
    name: network_mask
    description: The mask that segregates IPs v4 belonging to the same sub-network
      from the rest.
    title: network mask
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-connection-points.yaml
    rank: 1000
    alias: network_mask
    owner: Ipv4Connectivity
    domain_of:
    - Ipv4Connectivity
    range: string
    pattern: ^(255)\.(0|128|192|224|240|248|252|254|255)\.(0|128|192|224|240|248|252|254|255)\.(0|128|192|224|240|248|252|254|255)$
  ipv4_address:
    name: ipv4_address
    description: The IP v4 address of a device port.
    title: IPv4 address
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    alias: ipv4_address
    owner: Ipv4Connectivity
    domain_of:
    - Ipv4Connectivity
    range: string
    required: true
    pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
  router_ipv4_address:
    name: router_ipv4_address
    description: The IPv4 address of the router (AKA gateway) corresponding to a IPv4
      address.
    title: IPv4 router address
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    is_a: ipv4_address
    alias: router_ipv4_address
    owner: Ipv4Connectivity
    domain_of:
    - Ipv4Connectivity
    range: string
    recommended: true
    pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
  related_connection_points:
    name: related_connection_points
    description: 'A connection point might rely on another connection point to work.

      Examples: a TCP/IP connection can only work if there is some kind of connection
      point at physical level (e.g. Ethernet Port, Bluetooth Port), a container might
      be connected over a virtual ethernet to a software bridge, a software bridge
      might be directly connected to an ethernet port.

      This attribute enables modeling these kind of dependencies in a limited way.
      Other modeling mechanisms might be needed to model complex networking setups.'
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    alias: related_connection_points
    owner: Ipv4Connectivity
    domain_of:
    - ConnectionPoint
    range: RelatedConnectionPoint
    multivalued: true
    inlined: false
  connection_point_type:
    name: connection_point_type
    description: Type designator that provides support for polymorphism using connection
      points.
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-read.yaml
    rank: 1000
    designates_type: true
    alias: connection_point_type
    owner: Ipv4Connectivity
    domain_of:
    - ConnectionPoint
    range: string
    required: true
    equals_string: Ipv4Connectivity
  id:
    name: id
    description: The identifier is used to identify the connection point within the
      asset. It shall be generated by the asset link. Setting this identifier is only
      needed if the connection point needs to be referenced by an other connection
      point as RelatedConnectionPoint.
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-connection-points.yaml
    slot_uri: schema:identifier
    alias: id
    owner: Ipv4Connectivity
    domain_of:
    - Asset
    - ConnectionPoint
    range: string
  name:
    name: name
    description: Name of the connection point. The name is provided by the Asset Link
      during the discovery process. Usually, the name is provided by the operating
      system of the asset or may be labeled on the asset itself.
    examples:
    - value: eth0
    from_schema: https://industrial-assets.io/schemas/iah/base-schema/released/v1/iah-base-connection-points.yaml
    alias: name
    owner: Ipv4Connectivity
    domain_of:
    - FunctionalObject
    - Organization
    - ConnectionPoint
    range: string
defining_slots:
- ipv4_address

Any questions left?

Ask the community