version: '1.0'
nodes:
- name: AutonomousSystem
namespace: Routing
description: An Autonomous System (AS) is a set of Internet routable IP prefixes
belonging to a network
label: Autonomous System
icon: mdi:bank-circle-outline
menu_placement: RoutingBGPSession
human_friendly_id:
- asn__value
- name__value
order_by:
- asn__value
- name__value
display_label: 'AS {{ asn__value }}: {{ name__value }}'
attributes:
- name: name
kind: Text
description: Name of the Autonomous System
order_weight: 1000
unique: true
- name: asn
kind: Number
description: Autonomous System Number
order_weight: 1050
unique: true
- name: description
kind: Text
optional: true
description: Description of the Autonomous System
order_weight: 1100
relationships:
- name: organization
peer: OrganizationGeneric
optional: false
cardinality: one
kind: Attribute
- name: location
peer: LocationGeneric
optional: true
cardinality: one
kind: Attribute
- name: devices
peer: DcimDevice
optional: true
cardinality: many
kind: Attribute
- name: BGPPeerGroup
namespace: Routing
description: A BGP Peer Group is used to regroup parameters that are shared across
multiple peers
label: BGP Peer Group
icon: mdi:view-grid-plus-outline
menu_placement: RoutingBGPSession
inherit_from:
- RoutingProtocol
human_friendly_id:
- name__value
- description__value
order_by:
- name__value
display_label: '{{ name__value }} - {{ description__value }}'
attributes:
- name: name
kind: Text
optional: false
unique: true
description: Name of the BGP Group
order_weight: 1000
- name: import_policies
kind: Text
optional: true
order_weight: 1300
- name: export_policies
kind: Text
optional: true
order_weight: 1350
- name: maximum_routes
kind: Number
optional: true
description: Maximum routes for the BGP Group.
order_weight: 1400
regex: ^[0-9]+$
- name: local_pref
kind: Number
optional: true
description: Force Local Pref for this BGP Peer Group.
order_weight: 1450
regex: ^[0-9]+$
- name: send_community
kind: Checkbox
optional: true
description: Whether to send community attributes.
order_weight: 1500
- name: address_family
description: The address family for the routing policy indicating the type of
IP address.
kind: Dropdown
choices:
- name: ipv4
label: IPv4
description: Policy applies to IPv4 addresses.
color: '#E6E6FA'
- name: ipv6
label: IPv6
description: Policy applies to IPv6 addresses.
color: '#E6E6FA'
default_value: ipv4
order_weight: 1150
relationships:
- name: local_as
identifier: bgppeergroup__local_as
peer: RoutingAutonomousSystem
optional: true
cardinality: one
kind: Attribute
- name: remote_as
identifier: bgppeergroup__remote_as
peer: RoutingAutonomousSystem
optional: true
cardinality: one
kind: Attribute
- name: BGPSession
namespace: Routing
description: A BGP Session represent a point to point connection between two routers
label: BGP Session
icon: mdi:router
inherit_from:
- RoutingProtocol
order_by:
- remote_as__asn__value
display_label: description__value
attributes:
- name: import_policies
kind: Text
optional: true
- name: export_policies
kind: Text
optional: true
- name: session_type
kind: Text
enum:
- EXTERNAL
- INTERNAL
description: Type of BGP Session
order_weight: 1200
- name: role
kind: Dropdown
choices:
- name: backbone
label: Backbone
description: Provide main data routes.
color: '#E6E6FA'
- name: upstream
label: Upstream
description: Connect to Internet service provider.
color: '#E6E6FA'
- name: peering
label: Peering
description: Connect with other networks via IX.
color: '#E6E6FA'
description: Role of the BGP Session
order_weight: 1600
- name: local_pref
kind: Number
optional: true
description: Force Local Pref for this BGP Peer Session.
order_weight: 1450
regex: ^[0-9]+$
relationships:
- name: local_as
identifier: bgpsession__local_as
peer: RoutingAutonomousSystem
optional: true
cardinality: one
kind: Attribute
- name: remote_as
identifier: bgpsession__remote_as
peer: RoutingAutonomousSystem
optional: true
cardinality: one
kind: Attribute
- name: local_ip
identifier: bgpsession__local_ip
peer: IpamIPAddress
optional: true
cardinality: one
kind: Attribute
- name: remote_ip
identifier: bgpsession__remote_ip
peer: IpamIPAddress
optional: true
cardinality: one
kind: Attribute
- name: device
peer: DcimDevice
optional: true
cardinality: one
- name: peer_group
peer: RoutingBGPPeerGroup
optional: true
cardinality: one
kind: Attribute
- name: peer_session
peer: RoutingBGPSession
optional: true
cardinality: one
kind: Attribute
extensions:
nodes:
- kind: DcimGenericDevice
relationships:
- name: asn
peer: RoutingAutonomousSystem
optional: true
cardinality: one
kind: Attribute
order_weight: 1600
- kind: OrganizationGeneric
relationships:
- name: asn
label: Autonomous System
cardinality: many
optional: true
peer: RoutingAutonomousSystem
order_weight: 2000