model/src/main/yang/neutron-L3.yang

   1 /*
   2  * Copyright (c) 2015 Brocade Communications Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 module neutron-L3 {
   9
  10     yang-version 1;
  11
  12     namespace "urn:opendaylight:neutron-L3";
  13
  14     prefix neutron-L3;
  15
  16     import ietf-yang-types { prefix "yang";}
  17     // It requires rfc6991 (revision 2013-07-15), but odl don't have it, so this patch verify build will fail.
  18     import ietf-inet-types { prefix "inet"; revision-date 2010-09-24; }
  19     import neutron-attrs { prefix "attrs"; }
  20
  21     organization "OpenDaylight Neutron Group";
  22
  23     contact "J. Gregory Hall <ghall@brocade.com>, Kiran Sreenivasa <kkoushik@brocade.com>";
  24
  25     description "This YANG module defines L3 attributes that are used by Openstack
  26         Juno House Neutron modules.";
  27
  28     revision "2014-10-02" {
  29         description
  30                 "Initial version of L3 attributes used by OpenStack Ice House Neutron
  31                 models";
  32     }
  33
  34     grouping L3-attributes {
  35         leaf distributed {
  36             description "whether this router is distributed or not.";
  37             type boolean;
  38             default "false";
  39         }
  40         leaf gateway-port-id {
  41             description "the port uuid holding the router's gateway address.";
  42             type yang:uuid;
  43         }
  44         leaf-list routes {
  45             description "list of routes for this router.";
  46             type string;
  47         }
  48         leaf router-status {
  49             description "Contains the Router status.";
  50             type string;
  51         }
  52     }
  53
  54     grouping L3-floatingip-attributes {
  55         leaf uuid {
  56             type yang:uuid;
  57             description "UUID to index this object.";
  58         }
  59         leaf tenant-id {
  60             type yang:uuid;
  61             description "The Tenant ID of this object.";
  62         }
  63         leaf router-id {
  64             description "Contains the Router ID of this floatingip object.";
  65             type yang:uuid;
  66         }
  67         leaf port-id {
  68             description "Contains the Port ID of the fixed IP address that will be
  69                 associated with this object.";
  70             type yang:uuid;
  71         }
  72         leaf floating-network-id {
  73             description "The ID of the network associated with the floating IP.";
  74             type yang:uuid;
  75         }
  76         leaf floating-ip-address {
  77             description "The floating IP address.";
  78             type inet:ip-address;
  79         }
  80         leaf fixed-ip-address {
  81             description "The fixed IP address associated with the floating IP.
  82                 If you intend to associate the floating IP with a fixed IP at
  83                 creation time, then you must indicate the identifier of the
  84                 internal port(using port-id object). If an internal port has
  85                 multiple associated IP addresses, the service chooses the first
  86                 IP unless you explicitly specify the parameter fixed_ip_address
  87                 to select a specific IP.";
  88             type inet:ip-address;
  89         }
  90         leaf status {
  91             type string;
  92             description "The network status.";
  93         }
  94     }
  95
  96     grouping interface-attributes {
  97         leaf uuid {
  98             type yang:uuid;
  99             description "UUID to index this object.";
 100         }
 101         leaf tenant-id {
 102             type yang:uuid;
 103             description "The Tenant ID of this object.";
 104         }
 105         leaf subnet-id {
 106             description "Contains the Subnet ID of the interface.";
 107             type yang:uuid;
 108         }
 109         leaf port-id {
 110             description "Contains the Port ID of the interface.";
 111             type yang:uuid;
 112         }
 113     }
 114
 115     grouping routers-attributes {
 116         container routers {
 117             list router {
 118
 119                 description "A logical entity for forwarding packets across internal subnets
 120                     and NATting them on external networks through an appropriate external
 121                     gateway.";
 122
 123                 key "uuid";
 124                 uses attrs:base-attributes;
 125                 uses attrs:admin-attributes;
 126                 uses L3-attributes;
 127                 container external_gateway_info {
 128                     leaf external-network-id {
 129                         description "The network_id, for the external gateways. If this is empty, then this
 130                             network does not have external access";
 131                         type yang:uuid;
 132                     }
 133                     leaf enable-snat {
 134                         description "If true, it indicates that the router is performing snat on external access ";
 135                         type boolean;
 136                         default "true";
 137                     }
 138                     list external-fixed-ips {
 139                         description "external fixed IPs for this router ";
 140                         key subnet-id;
 141                         leaf subnet-id {
 142                             type yang:uuid;
 143                         }
 144                         leaf ip-address {
 145                             type inet:ip-address;
 146                         }
 147                     }
 148                 }
 149                 list interfaces {
 150                     description "List of interfaces associated with this router object.";
 151                     key "uuid";
 152                     uses interface-attributes;
 153                 }
 154             }
 155         }
 156     }
 157     grouping floatingips-attributes {
 158         container floatingips {
 159             list floatingip {
 160
 161                 description "An external IP address that is mapped to a port that is
 162                     attached to an internal network.";
 163
 164                 key "uuid";
 165                 uses L3-floatingip-attributes;
 166             }
 167         }
 168     }
 169 }