Skip to main content

Tenancy

This schema extension introduces a Tenant node that can own devices, IP prefixes/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:

Nodes

Tenant

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

Relationships

namepeeroptionalcardinalitykind
devicesDcimGenericDeviceTruemanyGeneric
prefixesIpamPrefixTruemanyGeneric
addressesIpamIPAddressTruemanyGeneric
locationsLocationHostingTruemanyGeneric

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

namepeeroptionalcardinalitykind
tenantTenancyTenantTrueoneAttribute

IpamPrefix

Relationships

namepeeroptionalcardinalitykind
tenantTenancyTenantTrueoneAttribute

IpamIPAddress

Relationships

namepeeroptionalcardinalitykind
tenantTenancyTenantTrueoneAttribute

LocationHosting

Relationships

namepeeroptionalcardinalitykind
tenantTenancyTenantTrueoneAttribute

Code

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