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
include_in_menu: true
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
unique: true
optional: false
description: Name of the Autonomous System
order_weight: 1000
- name: asn
kind: Number
unique: true
optional: false
description: Autonomous System Number
order_weight: 1050
- name: description
kind: Text
optional: true
description: Description of the Autonomous System
order_weight: 1100
relationships:
- name: organization
peer: OrganizationGeneric
kind: Attribute
cardinality: one
optional: false
order_weight: 1200
- name: location
peer: LocationGeneric
kind: Attribute
cardinality: one
optional: true
order_weight: 1300
- name: devices
peer: DcimDevice
kind: Attribute
cardinality: many
optional: true
order_weight: 1400
- 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
include_in_menu: true
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
unique: true
optional: false
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
parameters:
min_value: 0
optional: true
description: Maximum routes for the BGP Group.
order_weight: 1400
- name: local_pref
kind: Number
parameters:
min_value: 0
optional: true
description: Force Local Pref for this BGP Peer Group.
order_weight: 1450
- name: send_community
kind: Checkbox
optional: true
description: Whether to send community attributes.
order_weight: 1500
- name: address_family
kind: Dropdown
default_value: ipv4
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'
optional: false
description: The address family for the routing policy indicating the type of
IP address.
order_weight: 1250
relationships:
- name: local_as
peer: RoutingAutonomousSystem
kind: Attribute
cardinality: one
optional: true
identifier: bgppeergroup__local_as
order_weight: 1550
- name: remote_as
peer: RoutingAutonomousSystem
kind: Attribute
cardinality: one
optional: true
identifier: bgppeergroup__remote_as
order_weight: 1600
- name: BGPSession
namespace: Routing
description: A BGP Session represent a point to point connection between two routers
label: BGP Session
icon: mdi:router
include_in_menu: true
inherit_from:
- RoutingProtocol
order_by:
- remote_as__asn__value
display_label: description__value
attributes:
- name: import_policies
kind: Text
optional: true
order_weight: 1700
- name: export_policies
kind: Text
optional: true
order_weight: 1750
- name: session_type
kind: Dropdown
choices:
- name: external
label: External
description: Session established with a router in a different autonomous system.
- name: internal
label: Internal
description: Session established with a router in the same autonomous system.
optional: false
description: Type of BGP Session
order_weight: 1250
- 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'
optional: true
description: Role of the BGP Session
order_weight: 1300
- name: local_pref
kind: Number
parameters:
min_value: 0
optional: true
description: Force Local Pref for this BGP Peer Session.
order_weight: 1650
relationships:
- name: local_as
peer: RoutingAutonomousSystem
kind: Attribute
cardinality: one
optional: true
identifier: bgpsession__local_as
order_weight: 1350
- name: remote_as
peer: RoutingAutonomousSystem
kind: Attribute
cardinality: one
optional: true
identifier: bgpsession__remote_as
order_weight: 1400
- name: local_ip
peer: IpamIPAddress
kind: Attribute
cardinality: one
optional: true
identifier: bgpsession__local_ip
order_weight: 1450
- name: remote_ip
peer: IpamIPAddress
kind: Attribute
cardinality: one
optional: true
identifier: bgpsession__remote_ip
order_weight: 1500
- name: device
peer: DcimDevice
kind: Generic
cardinality: one
optional: true
order_weight: 900
- name: peer_group
peer: RoutingBGPPeerGroup
kind: Attribute
cardinality: one
optional: true
order_weight: 1550
- name: peer_session
peer: RoutingBGPSession
kind: Attribute
cardinality: one
optional: true
order_weight: 1600
extensions:
nodes:
- kind: DcimGenericDevice
relationships:
- name: asn
peer: RoutingAutonomousSystem
kind: Attribute
cardinality: one
optional: true
order_weight: 1800
- kind: OrganizationGeneric
relationships:
- name: asn
peer: RoutingAutonomousSystem
label: Autonomous System
kind: Generic
cardinality: many
optional: true
order_weight: 1700