Tenancy

This schema extension introduces a Tenant node that can own devices, IP prefixes and addresses, and hosting locations. See the comment at the bottom of tenancy.yml for an example of how to extend tenancy onto optional extension nodes such as DcimCircuit.

Details

• Dependencies:
  • base

Nodes

Tenant

• Label: Tenant
• Description: A tenant is the owner of the corresponding devices, addressing, and locations.
• Namespace: Organization
• Icon: mdi:domain
• Inherit From: OrganizationGeneric

Relationships

name	peer	optional	cardinality	kind
devices	DcimGenericDevice	True	many	Generic
prefixes	IpamPrefix	True	many	Generic
addresses	IpamIPAddress	True	many	Generic
locations	LocationHosting	True	many	Generic

Extensions

note

In this context "extensions" refer to modifications or additions to the existing schema, such as adding new attributes, relationships, or other schema elements.

DcimGenericDevice

Relationships

name	peer	optional	cardinality	kind
tenant	OrganizationTenant	True	one	Attribute

IpamPrefix

Relationships

name	peer	optional	cardinality	kind
tenant	OrganizationTenant	True	one	Attribute

IpamIPAddress

Relationships

name	peer	optional	cardinality	kind
tenant	OrganizationTenant	True	one	Attribute

LocationHosting

Relationships

name	peer	optional	cardinality	kind
tenant	OrganizationTenant	True	one	Attribute

Code

version: '1.0'
nodes:
- name: Tenant
  namespace: Organization
  description: A tenant is the owner of the corresponding devices, addressing, and
    locations.
  label: Tenant
  icon: mdi:domain
  include_in_menu: true
  menu_placement: OrganizationGeneric
  inherit_from:
  - OrganizationGeneric
  relationships:
  - name: devices
    peer: DcimGenericDevice
    label: Devices
    kind: Generic
    cardinality: many
    optional: true
    identifier: tenant__device
    order_weight: 1300
  - name: prefixes
    peer: IpamPrefix
    label: Prefixes
    kind: Generic
    cardinality: many
    optional: true
    identifier: tenant__prefix
    order_weight: 1350
  - name: addresses
    peer: IpamIPAddress
    label: Addresses
    kind: Generic
    cardinality: many
    optional: true
    identifier: tenant__ip_address
    order_weight: 1400
  - name: locations
    peer: LocationHosting
    label: Locations
    kind: Generic
    cardinality: many
    optional: true
    identifier: tenant__location
    order_weight: 1450
extensions:
  nodes:
  - kind: DcimGenericDevice
    relationships:
    - name: tenant
      peer: OrganizationTenant
      kind: Attribute
      cardinality: one
      optional: true
      identifier: tenant__device
      order_weight: 1850
  - kind: IpamPrefix
    relationships:
    - name: tenant
      peer: OrganizationTenant
      kind: Attribute
      cardinality: one
      optional: true
      identifier: tenant__prefix
      order_weight: 1400
  - kind: IpamIPAddress
    relationships:
    - name: tenant
      peer: OrganizationTenant
      kind: Attribute
      cardinality: one
      optional: true
      identifier: tenant__ip_address
      order_weight: 1350
  - kind: LocationHosting
    relationships:
    - name: tenant
      peer: OrganizationTenant
      kind: Attribute
      cardinality: one
      optional: true
      identifier: tenant__location
      order_weight: 1800