@@ -82,66 +82,66 @@ This list provides an overview of the schemas available in this repository. Each
8282
8383| Name | Description |
8484|------|-------------|
85- | **[DCIM](reference/dcim)** | Basic DCIM schema to capture devices, racks, interfaces, and related information. |
86- | **[IPAM](reference/ipam)** | Basic IPAM schema to capture IP addresses, subnets, and related information. |
87- | **[Locations](reference/location)** | Basic Location schema to capture locations, sites, and related information. |
88- | **[Organization](reference/organization)** | Basic Organization schema to capture organizations, vendors, and related information. |
85+ | **[DCIM](/ reference/dcim)** | Basic DCIM schema to capture devices, racks, interfaces, and related information. |
86+ | **[IPAM](/ reference/ipam)** | Basic IPAM schema to capture IP addresses, subnets, and related information. |
87+ | **[Locations](/ reference/location)** | Basic Location schema to capture locations, sites, and related information. |
88+ | **[Organization](/ reference/organization)** | Basic Organization schema to capture organizations, vendors, and related information. |
8989
9090### extensions
9191
9292| Name | Description |
9393|------|-------------|
94- | **[Cable](reference/cable)** | This schema extension contains a basic Cable model allowing you to connect two endpoints. |
95- | **[Circuit](reference/circuit)** | This schema extension contains Circuits and ways to connect them with your infrastructure! The circuit could be a fiber connecting two sites, you would then have two endpoints, one on each site. |
96- | **[Cluster](reference/cluster)** | This schema extension contains the foundations to capture clusters. With this one in place you can unlock various clusters flavors (hosting cluster able to host VMs, firewall clusters built with specific appliances ...) |
97- | **[Compute](reference/compute)** | With this schema extension in place you will be able to capture all your physical servers. It also gives you the baseline to build virtualization. You might consider HostingCluster extension to go with! |
98- | **[Cross Connect](reference/cross_connect)** | This extension contains schema to capture Cross Connect. You can see it as " a cable operated by a provider" . You will be able to attach it to a location and then connect endpoints to it (e.g. rear interface of a patch panel, circuit endpoint ...) |
99- | **[DWDM](reference/dwdm)** | This schema extension contains models for OADM (Optical Add Drop Multiplexer) supporting various WDM (Wavelength Division Multiplexing) technologies such as DWDM (Dense Wavelength Division Multiplexing) or CWDM (Coarse Wavelength Division Multiplexing). With some vendors, the tunable optics are not configured via the channel number but via the wavelength and/or the frequency. This model provides a unique entry in Infrahub for those. |
100- | **[Firewall Policer](reference/firewall_policer)** | This schema extension contains models for VMs. You might consider Cluster or/and Hypervisor extension to go with! |
101- | **[Hosting Cluster](reference/hosting_cluster)** | A rather generic cluster built with compute units (e.g. servers) and able to host VMs. |
102- | **[Interface Breakout](reference/interface_breakout)** | This schema extension introduces relationships to support breakout interfaces, enabling you to document the breakout of a physical interface into smaller physical interfaces. |
103- | **[Lag](reference/lag)** | This schema extension includes models for Link Aggregation Groups (LAGs), enabling you to link physical interfaces as building blocs of your LAG interface. It can be used in standard networking environments as well as in compute scenarios, such as capturing bond interfaces. |
104- | **[Location Minimal](reference/location_minimal)** | This schema extension is minimal but will provide you with basic items to store location related data. |
105- | **[Modules](reference/modules)** | This schema extension allows you to capture Device Modules related information like the serial number or the status. You can insert the Module into a Dcim Physical Device. NOTE: This extension doesn't contain any Nodes, you can use the extension module_linecards or modules_routing_engine to use it |
106- | **[Patch Panel](reference/patch_panel)** | This schema extension allows you to capture patch panel related information like rear/front interfaces and mapping between them. You can insert the patch panel into a rack and leverage the device type model. Finally you can also capture information about potential modules you would insert into your patch panel. NOTE: This extension is compatible with all sort of connectors, meaning you can plug cable, circuits, cross-connect to front & rear interfaces! |
107- | **[Peering IXP](reference/peering_ixp)** | This schema extension contains all you need to model anything revolving around internet peering (Exchange points ...)! |
108- | **[Physical Disk](reference/physical_disk)** | Simple schema allowing you to capture physical disks information for the sake of inventory and lifecycle management. NOTE: This extension is compatible with all sort of device. You can apply the generic " DeviceWithPhysicalDisks" to particular model to enable disks tracking. You might also link that schema to location for instance to capture spares. |
109- | **[QinQ](reference/qinq)** | This schema extension brings extensions to VLAN model in order to support QinQ. |
110- | **[Routing](reference/routing)** | This schema extension contains generics to create Routing Protocol " Instance" . The idea is to create one Routing Protocol instance per IpamVRF + DcimDevice pair. |
111- | **[Routing Aggregate](reference/routing_aggregate)** | This schema extension contains all you need to model the Aggregate Routing Protocol. |
112- | **[Routing BGP](reference/routing_bgp)** | This schema extension contains all you need to model your BGP platform. |
113- | **[Routing BGP Community](reference/routing_bgp_community)** | This schema extension adds the BGP Communities models. |
114- | **[Routing BGP RR](reference/routing_bgp_rr)** | This schema extension extend the BGP extension to add BGP Route Reflector Clustering. |
115- | **[Routing OSPF](reference/routing_ospf)** | This schema extension contains all you need to model the OSPF Routing Protocol. |
116- | **[Routing PIM](reference/routing_pim)** | This schema extension contains all you need to model the PIM Protocol. |
117- | **[Routing Policies](reference/routing_policies)** | This schema extension contains a generic to create Routing Policies. This Generic can be extend for each Routing Protocols you may want to use. |
118- | **[Routing Policies (PIM)](reference/routing_policies_pim)** | This schema inherits the `RoutingPolicy` schema and removes `import_policies` and `export_policies` attributes. However it adds a number of relationships to `RoutingPIM`. |
119- | **[Routing Policies Aggregate](reference/routing_policies_aggregate)** | This extension is using the Routing Policies extensions and the Routing Aggregate one together. |
120- | **[Routing Policies BGP](reference/routing_policies_bgp)** | This extension is using the Routing Policies extensions and the Routing BGP one together. |
121- | **[Routing Policies OSPF](reference/routing_policies_ospf)** | This extension is using the Routing Policies extensions and the Routing OSPF one together. |
122- | **[SFP](reference/sfp)** | This schema extension gives you all the models you need to document Small Form-factor Pluggable (SFP). You can either plug it into an interface or attach it to a location (e.g. it's a spare SFP stored in a rack). Improvements: - As of now there is no verification with type / form factor / protocol / distance ... - You could plug any SFP into any equipment interface (e.g. a virtual interface ...) - You could link a SFP to an interface AND a location ... |
123- | **[SNMP](reference/snmp)** | This schema extension contains models for SNMP Communities and SNMP Clients. As you can see this extension is not linked to Tenancy or Device, as you could decide to link the Community to different models based on your use case. |
124- | **[Topology](reference/topology)** | This schema extension introduces abstract network pods and services running in the pods, such as MPLS and EVPN. |
125- | **[Users](reference/users)** | This schema extension contains models for account management. |
126- | **[VLAN](reference/vlan)** | This schema extension contains models to support VLANs in you network. |
127- | **[VRF](reference/vrf)** | This schema extension contains models to support VRF in your network. |
128- | **[VRRP](reference/vrrp)** | This schema extension contains models for VRRP. |
94+ | **[Cable](/ reference/cable)** | This schema extension contains a basic Cable model allowing you to connect two endpoints. |
95+ | **[Circuit](/ reference/circuit)** | This schema extension contains Circuits and ways to connect them with your infrastructure! The circuit could be a fiber connecting two sites, you would then have two endpoints, one on each site. |
96+ | **[Cluster](/ reference/cluster)** | This schema extension contains the foundations to capture clusters. With this one in place you can unlock various clusters flavors (hosting cluster able to host VMs, firewall clusters built with specific appliances ...) |
97+ | **[Compute](/ reference/compute)** | With this schema extension in place you will be able to capture all your physical servers. It also gives you the baseline to build virtualization. You might consider HostingCluster extension to go with! |
98+ | **[Cross Connect](/ reference/cross_connect)** | This extension contains schema to capture Cross Connect. You can see it as " a cable operated by a provider" . You will be able to attach it to a location and then connect endpoints to it (e.g. rear interface of a patch panel, circuit endpoint ...) |
99+ | **[DWDM](/ reference/dwdm)** | This schema extension contains models for OADM (Optical Add Drop Multiplexer) supporting various WDM (Wavelength Division Multiplexing) technologies such as DWDM (Dense Wavelength Division Multiplexing) or CWDM (Coarse Wavelength Division Multiplexing). With some vendors, the tunable optics are not configured via the channel number but via the wavelength and/or the frequency. This model provides a unique entry in Infrahub for those. |
100+ | **[Firewall Policer](/ reference/firewall_policer)** | This schema extension contains models for VMs. You might consider Cluster or/and Hypervisor extension to go with! |
101+ | **[Hosting Cluster](/ reference/hosting_cluster)** | A rather generic cluster built with compute units (e.g. servers) and able to host VMs. |
102+ | **[Interface Breakout](/ reference/interface_breakout)** | This schema extension introduces relationships to support breakout interfaces, enabling you to document the breakout of a physical interface into smaller physical interfaces. |
103+ | **[Lag](/ reference/lag)** | This schema extension includes models for Link Aggregation Groups (LAGs), enabling you to link physical interfaces as building blocs of your LAG interface. It can be used in standard networking environments as well as in compute scenarios, such as capturing bond interfaces. |
104+ | **[Location Minimal](/ reference/location_minimal)** | This schema extension is minimal but will provide you with basic items to store location related data. |
105+ | **[Modules](/ reference/modules)** | This schema extension allows you to capture Device Modules related information like the serial number or the status. You can insert the Module into a Dcim Physical Device. NOTE: This extension doesn't contain any Nodes, you can use the extension module_linecards or modules_routing_engine to use it |
106+ | **[Patch Panel](/ reference/patch_panel)** | This schema extension allows you to capture patch panel related information like rear/front interfaces and mapping between them. You can insert the patch panel into a rack and leverage the device type model. Finally you can also capture information about potential modules you would insert into your patch panel. NOTE: This extension is compatible with all sort of connectors, meaning you can plug cable, circuits, cross-connect to front & rear interfaces! |
107+ | **[Peering IXP](/ reference/peering_ixp)** | This schema extension contains all you need to model anything revolving around internet peering (Exchange points ...)! |
108+ | **[Physical Disk](/ reference/physical_disk)** | Simple schema allowing you to capture physical disks information for the sake of inventory and lifecycle management. NOTE: This extension is compatible with all sort of device. You can apply the generic " DeviceWithPhysicalDisks" to particular model to enable disks tracking. You might also link that schema to location for instance to capture spares. |
109+ | **[QinQ](/ reference/qinq)** | This schema extension brings extensions to VLAN model in order to support QinQ. |
110+ | **[Routing](/ reference/routing)** | This schema extension contains generics to create Routing Protocol " Instance" . The idea is to create one Routing Protocol instance per IpamVRF + DcimDevice pair. |
111+ | **[Routing Aggregate](/ reference/routing_aggregate)** | This schema extension contains all you need to model the Aggregate Routing Protocol. |
112+ | **[Routing BGP](/ reference/routing_bgp)** | This schema extension contains all you need to model your BGP platform. |
113+ | **[Routing BGP Community](/ reference/routing_bgp_community)** | This schema extension adds the BGP Communities models. |
114+ | **[Routing BGP RR](/ reference/routing_bgp_rr)** | This schema extension extend the BGP extension to add BGP Route Reflector Clustering. |
115+ | **[Routing OSPF](/ reference/routing_ospf)** | This schema extension contains all you need to model the OSPF Routing Protocol. |
116+ | **[Routing PIM](/ reference/routing_pim)** | This schema extension contains all you need to model the PIM Protocol. |
117+ | **[Routing Policies](/ reference/routing_policies)** | This schema extension contains a generic to create Routing Policies. This Generic can be extend for each Routing Protocols you may want to use. |
118+ | **[Routing Policies (PIM)](/ reference/routing_policies_pim)** | This schema inherits the `RoutingPolicy` schema and removes `import_policies` and `export_policies` attributes. However it adds a number of relationships to `RoutingPIM`. |
119+ | **[Routing Policies Aggregate](/ reference/routing_policies_aggregate)** | This extension is using the Routing Policies extensions and the Routing Aggregate one together. |
120+ | **[Routing Policies BGP](/ reference/routing_policies_bgp)** | This extension is using the Routing Policies extensions and the Routing BGP one together. |
121+ | **[Routing Policies OSPF](/ reference/routing_policies_ospf)** | This extension is using the Routing Policies extensions and the Routing OSPF one together. |
122+ | **[SFP](/ reference/sfp)** | This schema extension gives you all the models you need to document Small Form-factor Pluggable (SFP). You can either plug it into an interface or attach it to a location (e.g. it's a spare SFP stored in a rack). Improvements: - As of now there is no verification with type / form factor / protocol / distance ... - You could plug any SFP into any equipment interface (e.g. a virtual interface ...) - You could link a SFP to an interface AND a location ... |
123+ | **[SNMP](/ reference/snmp)** | This schema extension contains models for SNMP Communities and SNMP Clients. As you can see this extension is not linked to Tenancy or Device, as you could decide to link the Community to different models based on your use case. |
124+ | **[Topology](/ reference/topology)** | This schema extension introduces abstract network pods and services running in the pods, such as MPLS and EVPN. |
125+ | **[Users](/ reference/users)** | This schema extension contains models for account management. |
126+ | **[VLAN](/ reference/vlan)** | This schema extension contains models to support VLANs in you network. |
127+ | **[VRF](/ reference/vrf)** | This schema extension contains models to support VRF in your network. |
128+ | **[VRRP](/ reference/vrrp)** | This schema extension contains models for VRRP. |
129129
130130### experimental
131131
132132| Name | Description |
133133|------|-------------|
134- | **[Azure](reference/azure)** | This schema extension introduces cloud support for Microsoft Azure. |
135- | **[Circuit Service](reference/circuit_service)** | This schema extension contains model coming on top of circuit to capture a single service shared across multiple circuits. For example you have a MPLS network supported by a provider connecting multiple locations: - One single CircuitService would be needed to store MPLS related information (e.g. service id, provider ...) - On each site we would create a circuit connecting on one side our device and the CircuitService on the other side |
136- | **[Infiniband](reference/infiniband)** | This schema extension adds support for InfiniBand switches. |
137- | **[Location Extended](reference/location_extended)** | This schema extension is the most detailed when it comes to location, you'll find all the layers you can think of. |
138- | **[Modules Linecards](reference/modules_linecards)** | This schema extension allows you to capture Linecard related information like the version. You can insert the Linecard into a Dcim Physical Device and leverage the Linecard type model. The Linecard can accept PIC to help configure PORT information like breakout-capabilities and configurations. |
139- | **[Modules Routing Engine](reference/modules_routing_engine)** | This schema extension allows you to capture Routing Engine related information like the version. You can insert the Routing Engine into a Dcim Physical Device and leverage the Routing Engine type model. |
140- | **[QoS](reference/qos)** | This schema extension contains models for Quality of Service (QoS) |
141- | **[Security](reference/security)** | This schema extension contains models for implementing detailed security. |
142- | **[Tenancy](reference/tenancy)** | This schema extension introduces tenancy for some of the schema nodes (circuits...) |
143- | **[Topology](reference/topology)** | A schema for defining and managing network topology, strategies, and services. |
144- | **[VLAN Translation](reference/vlan-translation)** | This schema extension is based on Juniper VLAN MAP, and not yet test out for other vendors. |
134+ | **[Azure](/ reference/azure)** | This schema extension introduces cloud support for Microsoft Azure. |
135+ | **[Circuit Service](/ reference/circuit_service)** | This schema extension contains model coming on top of circuit to capture a single service shared across multiple circuits. For example you have a MPLS network supported by a provider connecting multiple locations: - One single CircuitService would be needed to store MPLS related information (e.g. service id, provider ...) - On each site we would create a circuit connecting on one side our device and the CircuitService on the other side |
136+ | **[Infiniband](/ reference/infiniband)** | This schema extension adds support for InfiniBand switches. |
137+ | **[Location Extended](/ reference/location_extended)** | This schema extension is the most detailed when it comes to location, you'll find all the layers you can think of. |
138+ | **[Modules Linecards](/ reference/modules_linecards)** | This schema extension allows you to capture Linecard related information like the version. You can insert the Linecard into a Dcim Physical Device and leverage the Linecard type model. The Linecard can accept PIC to help configure PORT information like breakout-capabilities and configurations. |
139+ | **[Modules Routing Engine](/ reference/modules_routing_engine)** | This schema extension allows you to capture Routing Engine related information like the version. You can insert the Routing Engine into a Dcim Physical Device and leverage the Routing Engine type model. |
140+ | **[QoS](/ reference/qos)** | This schema extension contains models for Quality of Service (QoS) |
141+ | **[Security](/ reference/security)** | This schema extension contains models for implementing detailed security. |
142+ | **[Tenancy](/ reference/tenancy)** | This schema extension introduces tenancy for some of the schema nodes (circuits...) |
143+ | **[Topology](/ reference/topology)** | A schema for defining and managing network topology, strategies, and services. |
144+ | **[VLAN Translation](/ reference/vlan-translation)** | This schema extension is based on Juniper VLAN MAP, and not yet test out for other vendors. |
145145<!-- vale on -->
146146
147147## Troubleshooting
0 commit comments