blob: d7023bda36048185c9c18a3f50d79f755a995f33 [file] [log] [blame]
Sapan Bhatia8c95eb42017-05-02 12:17:52 +02001option app_label = "fabric";
Matteo Scandolo9cc4f6f2017-10-02 18:03:58 -07002option name = "fabric";
Sapan Bhatia8c95eb42017-05-02 12:17:52 +02003
Luca Preteb601c382018-04-30 16:10:43 -07004message FabricService(Service) {
Matteo Scandolo9cc4f6f2017-10-02 18:03:58 -07005 option verbose_name = "Fabric Service";
Scott Bakera3b3ff22019-01-23 11:25:18 -08006 option description = "Service that manages and configures fabric switches in ONOS";
Matteo Scandolo9cc4f6f2017-10-02 18:03:58 -07007
Scott Bakera3b3ff22019-01-23 11:25:18 -08008 optional bool autoconfig = 1 [
9 help_text="Automatically apply addresses from AddressManager service to Fabric",
Scott Bakere93ad342019-03-12 15:40:11 -070010 default = True];
Sapan Bhatia8c95eb42017-05-02 12:17:52 +020011}
Luca Preteb601c382018-04-30 16:10:43 -070012
13message Switch(XOSBase) {
14 option verbose_name = "Fabric Switch";
Scott Bakera3b3ff22019-01-23 11:25:18 -080015 option description = "An individual fabric switch managed by ONOS";
vigneshethiraj76d88242019-06-04 18:51:19 +053016 option sync_implemented = "True";
Luca Preteb601c382018-04-30 16:10:43 -070017
Scott Bakera3b3ff22019-01-23 11:25:18 -080018 required string ofId = 1 [
19 help_text = "The unique OpenFlow ID of the fabric switch",
Scott Bakera3b3ff22019-01-23 11:25:18 -080020 max_length = 19];
21 required string name = 2 [
22 help_text = "The unique name of the fabric switch",
Scott Baker81a9be22019-04-09 14:42:26 -070023 max_length = 256];
Scott Bakera3b3ff22019-01-23 11:25:18 -080024 required string driver = 3 [
25 help_text = "The driver used by the SDN controller",
Scott Bakera3b3ff22019-01-23 11:25:18 -080026 default = "ofdpa3",
Scott Baker81a9be22019-04-09 14:42:26 -070027 max_length = 256];
Scott Bakera3b3ff22019-01-23 11:25:18 -080028 required int32 ipv4NodeSid = 4 [
Scott Bakere93ad342019-03-12 15:40:11 -070029 help_text = "The MPLS label used by the switch [17 - 1048576]"];
Scott Bakera3b3ff22019-01-23 11:25:18 -080030 required string ipv4Loopback = 5 [
31 help_text = "Fabric loopback interface",
Scott Bakera3b3ff22019-01-23 11:25:18 -080032 max_length = 17];
33 required string routerMac = 6 [
34 help_text = "MAC address of the fabric switch used for all interfaces",
Scott Bakera3b3ff22019-01-23 11:25:18 -080035 max_length = 17];
36 required bool isEdgeRouter = 7 [
37 help_text="True if the fabric switch is a leaf, False if it is a spine",
Scott Bakere93ad342019-03-12 15:40:11 -070038 default = True];
Scott Bakercabc3de2019-04-03 17:23:08 -070039 optional string managementAddress = 8 [
40 help_text = "Address where this switch can be managed",
41 feedback_state = True,
42 max_length = 1024];
Daniele Morofe693152019-09-20 16:53:40 -070043 optional string pipeconf = 9 [
44 help_text = "Pipeline configuration",
45 max_length = 1024];
Luca Preteb601c382018-04-30 16:10:43 -070046}
47
48message SwitchPort(XOSBase) {
49 option verbose_name = "Fabric Switch Port";
Scott Bakera3b3ff22019-01-23 11:25:18 -080050 option description = "A port on a fabric switch";
vigneshethiraj76d88242019-06-04 18:51:19 +053051 option sync_implemented = "True";
Luca Preteb601c382018-04-30 16:10:43 -070052
Scott Bakera3b3ff22019-01-23 11:25:18 -080053 required manytoone switch->Switch:ports = 1:1001 [
54 help_text = "The fabric switch the port belongs to",
55 db_index = True,
56 tosca_key=True];
57 required int32 portId = 2 [
58 help_text = "The unique port OpenFlow port ID",
Scott Bakera3b3ff22019-01-23 11:25:18 -080059 tosca_key=True];
60 required bool host_learning = 3 [
61 help_text = "whether or not to enable autodiscovery",
Scott Bakere93ad342019-03-12 15:40:11 -070062 default = True];
Scott Baker91bf91b2019-03-15 16:13:51 -070063 optional string admin_state = 4 [
64 help_text = "desired administrative state of port",
65 choices = "(('enabled', 'enabled'), ('disabled', 'disabled'))",
Scott Baker81a9be22019-04-09 14:42:26 -070066 default = "enabled",
67 max_length = 32];
Scott Baker91bf91b2019-03-15 16:13:51 -070068 optional string oper_status = 5 [
69 help_text = "operational status of port",
70 choices = "(('enabled', 'enabled'), ('disabled', 'disabled'))",
Scott Baker81a9be22019-04-09 14:42:26 -070071 feedback_state = True,
72 max_length = 32];
Scott Bakercabc3de2019-04-03 17:23:08 -070073 optional string kind = 6 [
74 help_text = "type of device attached to port",
75 choices = "(('access', 'access'), ('internet', 'internet'))",
76 max_length = 32];
Luca Preteb601c382018-04-30 16:10:43 -070077}
78
79message PortInterface(XOSBase) {
80 option verbose_name = "Fabric Port Interface";
Scott Bakera3b3ff22019-01-23 11:25:18 -080081 option description = "An interface on a port on a fabric switch";
Luca Preteb601c382018-04-30 16:10:43 -070082
Scott Bakera3b3ff22019-01-23 11:25:18 -080083 required manytoone port->SwitchPort:interfaces = 1:1001 [
84 help_text = "The fabric switch port the interface belongs to",
85 db_index = True];
86 required string name = 2 [
87 help_text = "The unique name of the fabric switch port",
Scott Baker81a9be22019-04-09 14:42:26 -070088 max_length = 256];
Scott Bakera3b3ff22019-01-23 11:25:18 -080089 optional int32 vlanUntagged = 3 [
Scott Bakere93ad342019-03-12 15:40:11 -070090 help_text = "The optional untagged VLAN ID for the interface"];
Matteo Scandoloaf3c9942018-06-27 14:03:12 -070091}
92
93message NodeToSwitchPort(XOSBase) {
94 option verbose_name = "Node to switch port";
95 option description = "Compute Node connection to a Fabric switch port";
vigneshethiraj76d88242019-06-04 18:51:19 +053096 option policy_implemented = "True";
Matteo Scandoloaf3c9942018-06-27 14:03:12 -070097
Scott Bakera3b3ff22019-01-23 11:25:18 -080098 required manytoone port->SwitchPort:node_to_switch_ports = 1:1002 [
99 help_text = "The fabric switch port the node is connected to",
100 db_index = True,
101 tosca_key=True];
102 required manytoone node->Node:node_to_switch_ports = 2:1004 [
103 help_text = "The ComputeNode this port is connected to",
104 db_index = True,
105 tosca_key=True];
Luca Prete15377872018-09-11 17:32:55 -0700106}
107
108message FabricIpAddress(XOSBase) {
109 option verbose_name = "IP address";
Scott Bakera3b3ff22019-01-23 11:25:18 -0800110 option description = "An IP address associated with a port on a fabric switch";
Luca Prete15377872018-09-11 17:32:55 -0700111
Scott Bakera3b3ff22019-01-23 11:25:18 -0800112 required manytoone interface->PortInterface:ips = 1:1001 [
113 help_text = "The port interface the IP address belongs to",
114 db_index = True,
115 tosca_key = True];
116 required string ip = 2 [
117 help_text = "The unique IP address (either IPv4 or IPv6 / netmask)",
Scott Bakera3b3ff22019-01-23 11:25:18 -0800118 max_length = 52,
119 tosca_key = True,
120 unique_with = "interface"];
121 optional string description = 3 [
122 help_text = "A short description of the IP address",
Scott Baker81a9be22019-04-09 14:42:26 -0700123 max_length = 256];
Luca Prete15377872018-09-11 17:32:55 -0700124}