common/onap-tosca-datatype/src/main/resources/globalTypes/openecomp-inventory/nodes.yml

   1 #
   2 # Licensed under the Apache License, Version 2.0 (the "License");
   3 # you may not use this file except in compliance with the License.
   4 # You may obtain a copy of the License at
   5 #
   6 #      http://www.apache.org/licenses/LICENSE-2.0
   7 #
   8 # Unless required by applicable law or agreed to in writing, software
   9 # distributed under the License is distributed on an "AS IS" BASIS,
  10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11 # See the License for the specific language governing permissions and
  12 # limitations under the License.
  13 #
  14
  15 tosca_definitions_version: tosca_simple_yaml_1_1
  16
  17 metadata:
  18   filename: openecomp-inventory/nodes.yml
  19   version: '1.0'
  20
  21 imports:
  22 - inventory_index:
  23     file: _index.yml
  24
  25 node_types:
  26
  27   org.openecomp.nodes.inventory.LagInterface:
  28     description: Link aggregate interface
  29     attributes:
  30       interface_name:
  31         description: Name that identifies the link aggregate interface
  32         type: string
  33         annotations:
  34           primary_id: true
  35           index:
  36           - inventory
  37       interface_description:
  38         description: Human friendly text regarding this interface.
  39         type: string
  40       resource_version:
  41         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
  42         type: string
  43       speed_value:
  44         description: Captures the numeric part of the speed
  45         type: string
  46       speed_units:
  47         description: Captures the units corresponding to the speed
  48         type: string
  49       interface_id:
  50         description: ID of interface
  51         type: string
  52         annotations:
  53           index:
  54           - inventory
  55       interface_role:
  56         description: Role assigned to this Interface, should use values as defined in OPENECOMP Yang models.
  57         type: string
  58         annotations:
  59           index:
  60           - inventory
  61       prov_status:
  62         description: Trigger for operational monitoring of this resource by Service Assurance systems.
  63         type: string
  64       relationship_list:
  65         type: list
  66         entry_schema:
  67           type: org.openecomp.datatypes.inventory.Relationship
  68       l_interfaces:
  69         type: list
  70         entry_schema:
  71           type: org.openecomp.nodes.inventory.LInterface
  72     capabilities:
  73       l_interface:
  74         type: org.openecomp.capabilities.inventory.Belonging
  75         valid_source_types:
  76         - org.openecomp.nodes.inventory.LInterface
  77     requirements:
  78     - generic_vnf:
  79         capability: org.openecomp.capabilities.inventory.Belonging
  80         node: org.openecomp.nodes.inventory.network.GenericVnf
  81         relationship: org.openecomp.relationships.inventory.BelongsTo
  82         occurrences:
  83         - 0
  84         - 1
  85         annotations:
  86           is_child: true
  87     - lag_link:
  88         capability: tosca.capabilities.network.Linkable
  89         node: org.openecomp.nodes.inventory.network.LagLink
  90         relationship: tosca.relationships.network.LinksTo
  91         occurrences:
  92         - 0
  93         - UNBOUNDED
  94     - p_interface:
  95         capability: org.openecomp.capabilities.inventory.Multiuse
  96         node: org.openecomp.nodes.inventory.PInterface
  97         relationship: org.openecomp.relationships.inventory.Uses
  98         occurrences:
  99         - 0
 100         - UNBOUNDED
 101     - pnf:
 102         capability: tosca.capabilities.network.Bindable
 103         node: org.openecomp.nodes.inventory.network.Pnf
 104         relationship: tosca.relationships.network.BindsTo
 105         occurrences:
 106         - 0
 107         - 1
 108         annotations:
 109           is_child: true
 110     - pserver:
 111         capability: tosca.capabilities.network.Bindable
 112         node: org.openecomp.nodes.inventory.cloud.infrastructure.Pserver
 113         relationship: tosca.relationships.network.BindsTo
 114         occurrences:
 115         - 0
 116         - 1
 117         annotations:
 118           is_child: true
 119     - vpe:
 120         capability: tosca.capabilities.network.Bindable
 121         node: org.openecomp.nodes.inventory.network.Vpe
 122         relationship: tosca.relationships.network.BindsTo
 123         occurrences:
 124         - 0
 125         - 1
 126         annotations:
 127           is_child: true
 128     - vpls_pe:
 129         capability: tosca.capabilities.network.Bindable
 130         node: org.openecomp.nodes.inventory.network.VplsPe
 131         relationship: tosca.relationships.network.BindsTo
 132         occurrences:
 133         - 0
 134         - 1
 135         annotations:
 136           is_child: true
 137
 138   org.openecomp.nodes.inventory.cloud.infrastructure.VirtualDataCenter:
 139     description: Virtual organization of cloud infrastructure elements in a data center context
 140     attributes:
 141       vdc_id:
 142         description: Unique ID of the vdc
 143         type: string
 144         annotations:
 145           primary_id: true
 146           index:
 147           - inventory
 148       vdc_name:
 149         description: Name of the virtual data center
 150         type: string
 151         annotations:
 152           index:
 153           - inventory
 154           summary_property: true
 155       resource_version:
 156         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
 157         type: string
 158       relationship_list:
 159         type: list
 160         entry_schema:
 161           type: org.openecomp.datatypes.inventory.Relationship
 162     capabilities:
 163       connector:
 164         type: org.openecomp.capabilities.inventory.Existable
 165         valid_source_types:
 166         - org.openecomp.nodes.inventory.business.Connector
 167       generic_vnf:
 168         type: org.openecomp.capabilities.inventory.Existable
 169         valid_source_types:
 170         - org.openecomp.nodes.inventory.network.GenericVnf
 171       logical_link:
 172         type: org.openecomp.capabilities.inventory.Existable
 173         valid_source_types:
 174         - org.openecomp.nodes.inventory.network.LogicalLink
 175
 176   org.openecomp.nodes.inventory.network.Pnf:
 177     description: PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an OPENECOMP node or uCPE.
 178     attributes:
 179       pnf_name:
 180         description: unique name of Physical Network Function.
 181         type: string
 182         annotations:
 183           primary_id: true
 184           unique:
 185           - inventory
 186           index:
 187           - inventory
 188           search:
 189           - inventory
 190       pnf_name2:
 191         description: name of Physical Network Function.
 192         type: string
 193       pnf_name2_source:
 194         description: source of name2
 195         type: string
 196       pnf_id:
 197         description: id of pnf
 198         type: string
 199       equip_type:
 200         description: Equipment type.  Source of truth should define valid values.
 201         type: string
 202       equip_vendor:
 203         description: Equipment vendor.  Source of truth should define valid values.
 204         type: string
 205       equip_model:
 206         description: Equipment model.  Source of truth should define valid values.
 207         type: string
 208       management_option:
 209         description: identifier of managed by OPENECOMP or customer
 210         type: string
 211       ipaddress_v4_oam:
 212         description: ipv4-oam-address with new naming convention for IP addresses
 213         type: string
 214       sw_version:
 215         description: sw-version is the version of SW for the hosted application on the PNF.
 216         type: string
 217       in_maint:
 218         description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
 219         type: boolean
 220       frame_id:
 221         description: ID of the physical frame (relay rack) where pnf is installed.
 222         type: string
 223       serial_number:
 224         description: Serial number of the device
 225         type: string
 226       ipaddress_v4_loopback_0:
 227         description: IPV4 Loopback 0 address
 228         type: string
 229       ipaddress_v6_loopback_0:
 230         description: IPV6 Loopback 0 address
 231         type: string
 232       ipaddress_v4_aim:
 233         description: IPV4 AIM address
 234         type: string
 235       ipaddress_v6_aim:
 236         description: IPV6 AIM address
 237         type: string
 238       ipaddress_v6_oam:
 239         description: IPV6 OAM address
 240         type: string
 241       inv_status:
 242         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
 243         type: string
 244         annotations:
 245           index:
 246           - inventory
 247       resource_version:
 248         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
 249         type: string
 250       prov_status:
 251         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
 252         type: string
 253       nf_role:
 254         description: Nf Role is the role performed by this instance in the network.
 255         type: string
 256       relationship_list:
 257         type: list
 258         entry_schema:
 259           type: org.openecomp.datatypes.inventory.Relationship
 260       p_interfaces:
 261         type: list
 262         entry_schema:
 263           type: org.openecomp.nodes.inventory.PInterface
 264       lag_interfaces:
 265         type: list
 266         entry_schema:
 267           type: org.openecomp.nodes.inventory.LagInterface
 268     capabilities:
 269       logical_link:
 270         type: org.openecomp.capabilities.inventory.Bridgeable
 271         valid_source_types:
 272         - org.openecomp.nodes.inventory.network.LogicalLink
 273       lag_interface:
 274         type: org.openecomp.capabilities.inventory.Bindable
 275         valid_source_types:
 276         - org.openecomp.nodes.inventory.LagInterface
 277       p_interface:
 278         type: org.openecomp.capabilities.inventory.Bindable
 279         valid_source_types:
 280         - org.openecomp.nodes.inventory.PInterface
 281       service_instance:
 282         type: org.openecomp.capabilities.inventory.Composeable
 283         valid_source_types:
 284         - org.openecomp.nodes.inventory.ServiceInstance
 285     requirements:
 286     - complex:
 287         capability: org.openecomp.capabilities.inventory.Locates
 288         node: org.openecomp.nodes.inventory.cloud.infrastructure.Complex
 289         relationship: org.openecomp.relationships.inventory.BelongsTo
 290         occurrences:
 291         - 0
 292         - 1
 293     - instance_group:
 294         capability: org.openecomp.capabilities.inventory.Composite
 295         node: org.openecomp.nodes.inventory.network.InstanceGroup
 296         relationship: org.openecomp.relationships.inventory.MemberOf
 297         occurrences:
 298         - 0
 299         - UNBOUNDED
 300     - zone:
 301         capability: org.openecomp.capabilities.inventory.Belonging
 302         node: org.openecomp.nodes.inventory.network.Zone
 303         relationship: org.openecomp.relationships.inventory.BelongsTo
 304         occurrences:
 305         - 0
 306         - 1
 307
 308   org.openecomp.nodes.inventory.network.InstanceGroup:
 309     description: General mechanism for grouping instances
 310     attributes:
 311       id:
 312         description: Instance Group ID, UUID assigned to this instance.
 313         type: string
 314         annotations:
 315           primary_id: true
 316           unique:
 317           - inventory
 318           index:
 319           - inventory
 320       description:
 321         description: Descriptive text to help identify the usage of this instance-group
 322         type: string
 323         annotations:
 324           index:
 325           - inventory
 326           summary_property: true
 327       type:
 328         description: Only valid value today is lower case ha for high availability
 329         type: string
 330         annotations:
 331           index:
 332           - inventory
 333       sub_type:
 334         description: Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
 335         type: string
 336         annotations:
 337           index:
 338           - inventory
 339       resource_version:
 340         description: Concurrency value
 341         type: string
 342       relationship_list:
 343         type: list
 344         entry_schema:
 345           type: org.openecomp.datatypes.inventory.Relationship
 346     capabilities:
 347       allotted_resource:
 348         type: org.openecomp.capabilities.inventory.Composite
 349         valid_source_types:
 350         - org.openecomp.nodes.inventory.AllottedResource
 351       generic_vnf:
 352         type: org.openecomp.capabilities.inventory.Composite
 353         valid_source_types:
 354         - org.openecomp.nodes.inventory.network.GenericVnf
 355       pnf:
 356         type: org.openecomp.capabilities.inventory.Composite
 357         valid_source_types:
 358         - org.openecomp.nodes.inventory.network.Pnf
 359       service_instance:
 360         type: org.openecomp.capabilities.inventory.Composite
 361         valid_source_types:
 362         - org.openecomp.nodes.inventory.ServiceInstance
 363
 364   org.openecomp.nodes.inventory.LInterface:
 365     description: Logical interfaces, e.g., a vnic.
 366     attributes:
 367       interface_name:
 368         description: Name given to the interface
 369         type: string
 370         annotations:
 371           primary_id: true
 372           index:
 373           - inventory
 374       interface_role:
 375         description: E.g., CUSTOMER, UPLINK, etc.
 376         type: string
 377       v6_wan_link_ip:
 378         description: Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
 379         type: string
 380       selflink:
 381         description: URL to endpoint where AAI can get more details
 382         type: string
 383       interface_id:
 384         description: ID of interface
 385         type: string
 386         annotations:
 387           index:
 388           - inventory
 389       macaddr:
 390         description: MAC address for the interface
 391         type: string
 392         annotations:
 393           index:
 394           - inventory
 395       network_name:
 396         description: Name of the network
 397         type: string
 398         annotations:
 399           index:
 400           - inventory
 401       management_option:
 402         description: Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
 403         type: string
 404       interface_description:
 405         description: Human friendly text regarding this interface.
 406         type: string
 407       resource_version:
 408         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
 409         type: string
 410       vlans:
 411         type: list
 412         entry_schema:
 413           type: org.openecomp.nodes.inventory.Vlan
 414       sriov_vfs:
 415         type: list
 416         entry_schema:
 417           type: org.openecomp.nodes.inventory.SriovVf
 418       relationship_list:
 419         type: list
 420         entry_schema:
 421           type: org.openecomp.datatypes.inventory.Relationship
 422       l3_interface_ipv4_address_list:
 423         type: org.openecomp.nodes.inventory.L3InterfaceIpv4AddressList
 424         occurrences:
 425         - 0
 426         - UNBOUNDED
 427       l3_interface_ipv6_address_list:
 428         type: org.openecomp.nodes.inventory.L3InterfaceIpv6AddressList
 429         occurrences:
 430         - 0
 431         - UNBOUNDED
 432     capabilities:
 433       l3_interface_ipv4_address_list:
 434         type: org.openecomp.capabilities.inventory.Belonging
 435         valid_source_types:
 436         - org.openecomp.nodes.inventory.L3InterfaceIpv4AddressList
 437       l3_interface_ipv6_address_list:
 438         type: org.openecomp.capabilities.inventory.Belonging
 439         valid_source_types:
 440         - org.openecomp.nodes.inventory.L3InterfaceIpv6AddressList
 441       sriov_vf:
 442         type: org.openecomp.capabilities.inventory.Belonging
 443         valid_source_types:
 444         - org.openecomp.nodes.inventory.SriovVf
 445     requirements:
 446     - generic_vnf:
 447         capability: tosca.capabilities.network.Bindable
 448         node: org.openecomp.nodes.inventory.network.GenericVnf
 449         relationship: tosca.relationships.network.BindsTo
 450         occurrences:
 451         - 0
 452         - 1
 453         annotations:
 454           is_child: true
 455     - lag_interface:
 456         capability: org.openecomp.capabilities.inventory.Belonging
 457         node: org.openecomp.nodes.inventory.LagInterface
 458         relationship: org.openecomp.relationships.inventory.BelongsTo
 459         occurrences:
 460         - 0
 461         - 1
 462         annotations:
 463           is_child: true
 464     - linking:
 465         capability: tosca.capabilities.network.Linkable
 466         relationship: tosca.relationships.network.LinksTo
 467         occurrences:
 468         - 0
 469         - UNBOUNDED
 470     - newvce:
 471         capability: tosca.capabilities.network.Bindable
 472         node: org.openecomp.nodes.inventory.network.Newvce
 473         relationship: tosca.relationships.network.BindsTo
 474         occurrences:
 475         - 0
 476         - 1
 477         annotations:
 478           is_child: true
 479     - p_interface:
 480         capability: tosca.capabilities.network.Bindable
 481         node: org.openecomp.nodes.inventory.PInterface
 482         relationship: tosca.relationships.network.BindsTo
 483         occurrences:
 484         - 0
 485         - 1
 486         annotations:
 487           is_child: true
 488     - vpe:
 489         capability: tosca.capabilities.network.Bindable
 490         node: org.openecomp.nodes.inventory.network.Vpe
 491         relationship: tosca.relationships.network.BindsTo
 492         occurrences:
 493         - 0
 494         - 1
 495         annotations:
 496           is_child: true
 497     - vserver:
 498         capability: tosca.capabilities.network.Bindable
 499         node: org.openecomp.nodes.inventory.Vserver
 500         relationship: tosca.relationships.network.BindsTo
 501         occurrences:
 502         - 0
 503         - 1
 504         annotations:
 505           is_child: true
 506
 507   org.openecomp.nodes.inventory.Vlan:
 508     description: Definition of vlan
 509     attributes:
 510       vlan_interface:
 511         description: String that identifies the interface
 512         type: string
 513         annotations:
 514           primary_id: true
 515           index:
 516           - inventory
 517       vlan_id_inner:
 518         description: Inner VLAN tag
 519         type: long
 520         annotations:
 521           index:
 522           - inventory
 523       vlan_id_outer:
 524         description: Outer VLAN tag
 525         type: long
 526       resource_version:
 527         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
 528         type: string
 529       speed_value:
 530         description: Captures the numeric part of the speed
 531         type: string
 532       speed_units:
 533         description: Captures the units corresponding to the speed
 534         type: string
 535       vlan_description:
 536         description: Used to describe (the service associated with) the vlan
 537         type: string
 538       backdoor_connection:
 539         description: Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
 540         type: string
 541       vpn_id:
 542         description: This indicates the customers VPN ID associated with this vlan
 543         type: string
 544         annotations:
 545           unique:
 546           - inventory
 547           index:
 548           - inventory
 549       orchestration_status:
 550         description: Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
 551         type: string
 552       relationship_list:
 553         type: list
 554         entry_schema:
 555           type: org.openecomp.datatypes.inventory.Relationship
 556       l3_interface_ipv4_address_list:
 557         type: org.openecomp.nodes.inventory.L3InterfaceIpv4AddressList
 558         occurrences:
 559         - 0
 560         - UNBOUNDED
 561       l3_interface_ipv6_address_list:
 562         type: org.openecomp.nodes.inventory.L3InterfaceIpv6AddressList
 563         occurrences:
 564         - 0
 565         - UNBOUNDED
 566     capabilities:
 567       allotted_resource:
 568         type: org.openecomp.capabilities.inventory.Allot
 569         valid_source_types:
 570         - org.openecomp.nodes.inventory.AllottedResource
 571       l_interface:
 572         type: org.openecomp.capabilities.inventory.Linkable
 573         valid_source_types:
 574         - org.openecomp.nodes.inventory.LInterface
 575       service_instance:
 576         type: org.openecomp.capabilities.inventory.Composeable
 577         valid_source_types:
 578         - org.openecomp.nodes.inventory.ServiceInstance
 579       l3_interface_ipv4_address_list:
 580         type: org.openecomp.capabilities.inventory.Belonging
 581         valid_source_types:
 582         - org.openecomp.nodes.inventory.L3InterfaceIpv4AddressList
 583       l3_interface_ipv6_address_list:
 584         type: org.openecomp.capabilities.inventory.Belonging
 585         valid_source_types:
 586         - org.openecomp.nodes.inventory.L3InterfaceIpv6AddressList
 587     requirements:
 588     - logical_link:
 589         capability: org.openecomp.capabilities.inventory.Multiuse
 590         node: org.openecomp.nodes.inventory.network.LogicalLink
 591         relationship: org.openecomp.relationships.inventory.Uses
 592         occurrences:
 593         - 0
 594         - UNBOUNDED
 595     - multicast_configuration:
 596         capability: org.openecomp.capabilities.inventory.Multiuse
 597         node: org.openecomp.nodes.inventory.network.MulticastConfiguration
 598         relationship: org.openecomp.relationships.inventory.Uses
 599         occurrences:
 600         - 0
 601         - UNBOUNDED
 602
 603   org.openecomp.nodes.inventory.Vserver:
 604     description: Virtual Servers, aka virtual machine or VM.
 605     attributes:
 606       vserver_id:
 607         description: Unique identifier for this vserver relative to its tenant
 608         type: string
 609         annotations:
 610           primary_id: true
 611           index:
 612           - inventory
 613           search:
 614           - inventory
 615       vserver_name:
 616         description: Name of vserver
 617         type: string
 618         annotations:
 619           index:
 620           - inventory
 621           search:
 622           - inventory
 623           summary_property: true
 624       vserver_name2:
 625         description: Alternative name of vserver
 626         type: string
 627         annotations:
 628           index:
 629           - inventory
 630           search:
 631           - inventory
 632       prov_status:
 633         description: Trigger for operational monitoring of this resource by Service Assurance systems.
 634         type: string
 635         annotations:
 636           index:
 637           - inventory
 638       vserver_selflink:
 639         description: URL to endpoint where AAI can get more details
 640         type: string
 641       in_maint:
 642         description: Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
 643         type: boolean
 644         annotations:
 645           index:
 646           - inventory
 647       is_closed_loop_disabled:
 648         description: Used to indicate whether closed loop function is enabled on this node
 649         type: boolean
 650         annotations:
 651           index:
 652           - inventory
 653       resource_version:
 654         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
 655         type: string
 656       volumes:
 657         type: list
 658         entry_schema:
 659           type: org.openecomp.nodes.inventory.Volume
 660       relationship_list:
 661         type: list
 662         entry_schema:
 663           type: org.openecomp.datatypes.inventory.Relationship
 664       l_interfaces:
 665         type: list
 666         entry_schema:
 667           type: org.openecomp.nodes.inventory.LInterface
 668     capabilities:
 669       generic_vnf:
 670         type: org.openecomp.capabilities.inventory.Container
 671         valid_source_types:
 672         - org.openecomp.nodes.inventory.network.GenericVnf
 673       vce:
 674         type: org.openecomp.capabilities.inventory.Container
 675         valid_source_types:
 676         - org.openecomp.nodes.inventory.network.Vce
 677       vf_module:
 678         type: org.openecomp.capabilities.inventory.Multiuse
 679         valid_source_types:
 680         - org.openecomp.nodes.inventory.VfModule
 681       vnfc:
 682         type: org.openecomp.capabilities.inventory.Container
 683         valid_source_types:
 684         - org.openecomp.nodes.inventory.network.Vnfc
 685       vpe:
 686         type: org.openecomp.capabilities.inventory.Container
 687         valid_source_types:
 688         - org.openecomp.nodes.inventory.network.Vpe
 689       l_interface:
 690         type: org.openecomp.capabilities.inventory.Bindable
 691         valid_source_types:
 692         - org.openecomp.nodes.inventory.LInterface
 693     requirements:
 694     - tenant:
 695         capability: org.openecomp.capabilities.inventory.Belonging
 696         node: org.openecomp.nodes.inventory.Tenant
 697         relationship: org.openecomp.relationships.inventory.BelongsTo
 698         occurrences:
 699         - 0
 700         - 1
 701         annotations:
 702           is_child: true
 703     - flavor:
 704         capability: org.openecomp.capabilities.inventory.Multiuse
 705         node: org.openecomp.nodes.inventory.Flavor
 706         relationship: org.openecomp.relationships.inventory.Uses
 707         occurrences:
 708         - 0
 709         - 1
 710     - image:
 711         capability: org.openecomp.capabilities.inventory.Multiuse
 712         node: org.openecomp.nodes.inventory.Image
 713         relationship: org.openecomp.relationships.inventory.Uses
 714         occurrences:
 715         - 0
 716         - 1
 717     - pserver:
 718         capability: tosca.capabilities.Container
 719         node: org.openecomp.nodes.inventory.cloud.infrastructure.Pserver
 720         relationship: tosca.relationships.HostedOn
 721         occurrences:
 722         - 0
 723         - 1
 724     - snapshot:
 725         capability: org.openecomp.capabilities.inventory.Multiuse
 726         node: org.openecomp.nodes.inventory.Snapshot
 727         relationship: org.openecomp.relationships.inventory.Uses
 728         occurrences:
 729         - 0
 730         - 1
 731     - volume:
 732         capability: org.openecomp.capabilities.inventory.Attachment
 733         node: org.openecomp.nodes.inventory.Volume
 734         relationship: tosca.relationships.AttachesTo
 735         occurrences:
 736         - 0
 737         - UNBOUNDED
 738
 739   org.openecomp.nodes.inventory.VolumeGroup:
 740     description: Persistent block-level storage.
 741     attributes:
 742       volume_group_id:
 743         description: Unique ID of volume-group.
 744         type: string
 745         annotations:
 746           primary_id: true
 747           index:
 748           - inventory
 749           search:
 750           - inventory
 751       volume_group_name:
 752         description: Name of the volume group.
 753         type: string
 754         annotations:
 755           index:
 756           - inventory
 757           search:
 758           - inventory
 759       heat_stack_id:
 760         description: Heat stack id corresponding to this volume-group
 761         type: string
 762         annotations:
 763           index:
 764           - inventory
 765       vnf_type:
 766         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as OPENECOMP matures.
 767         type: string
 768         annotations:
 769           index:
 770           - inventory
 771       orchestration_status:
 772         description: Orchestration status of this volume-group
 773         type: string
 774       persona_model_customization_id:
 775         description: captures the id of all the configuration used to customize the resource for the service.
 776         type: string
 777       vf_module_persona_model_customization_id:
 778         description: helps relate the volume group to the vf-module whose components will require the volume group
 779         type: string
 780       resource_version:
 781         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
 782         type: string
 783       relationship_list:
 784         type: list
 785         entry_schema:
 786           type: org.openecomp.datatypes.inventory.Relationship
 787     capabilities:
 788       generic_vnf:
 789         type: org.openecomp.capabilities.inventory.Node
 790         valid_source_types:
 791         - org.openecomp.nodes.inventory.network.GenericVnf
 792       tenant:
 793         type: org.openecomp.capabilities.inventory.Node
 794         valid_source_types:
 795         - org.openecomp.nodes.inventory.Tenant
 796       vf_module:
 797         type: org.openecomp.capabilities.inventory.Multiuse
 798         valid_source_types:
 799         - org.openecomp.nodes.inventory.VfModule
 800     requirements:
 801     - cloud_region:
 802         capability: org.openecomp.capabilities.inventory.Belonging
 803         node: org.openecomp.nodes.inventory.cloud.infrastructure.CloudRegion
 804         relationship: org.openecomp.relationships.inventory.BelongsTo
 805         occurrences:
 806         - 0
 807         - 1
 808         annotations:
 809           is_child: true
 810     - complex:
 811         capability: org.openecomp.capabilities.inventory.Existable
 812         node: org.openecomp.nodes.inventory.cloud.infrastructure.Complex
 813         relationship: org.openecomp.relationships.inventory.BelongsTo
 814         occurrences:
 815         - 0
 816         - UNBOUNDED
 817
 818   org.openecomp.nodes.inventory.network.IpsecConfiguration:
 819     description: IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C
 820     attributes:
 821       ipsec_configuration_id:
 822         description: UUID of this configuration
 823         type: string
 824         annotations:
 825           primary_id: true
 826           unique:
 827           - inventory
 828           index:
 829           - inventory
 830       requested_vig_address_type:
 831         description: Indicate the type of VIG server like AVPN, INTERNET, BOTH
 832         type: string
 833       requested_encryption_strength:
 834         description: Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
 835         type: string
 836       requested_dmz_type:
 837         description: OPENECOMP can offer a shared DMZ or a DMZ specific to a customer
 838         type: string
 839       shared_dmz_network_address:
 840         description: Network address of shared DMZ
 841         type: string
 842       requested_customer_name:
 843         description: If the DMZ is a custom DMZ, this field will indicate the customer information
 844         type: string
 845       ike_version:
 846         description: can be 1 or 2
 847         type: string
 848       ikev1_authentication:
 849         description: Contains values like md5, sha1, sha256, sha384
 850         type: string
 851       ikev1_encryption:
 852         description: Encyption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
 853         type: string
 854       ikev1_dh_group:
 855         description: Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
 856         type: string
 857       ikev1_am_group_id:
 858         description: Group name defined in VIG for clients using aggressive mode
 859         type: string
 860       ikev1_am_password:
 861         description: 'pre-shared key for the above group name '
 862         type: string
 863       ikev1_sa_lifetime:
 864         description: Lifetime for IKEv1 SA
 865         type: string
 866       ipsec_authentication:
 867         description: md5, sha1, sha256, sha384
 868         type: string
 869       ipsec_encryption:
 870         description: 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
 871         type: string
 872       ipsec_sa_lifetime:
 873         description: Life time for IPSec SA
 874         type: string
 875       ipsec_pfs:
 876         description: enable PFS or not
 877         type: string
 878       xauth_userid:
 879         description: user ID for xAuth, sm-user,ucpeHostName,nmteHostName
 880         type: string
 881       xauth_user_password:
 882         description: Encrypted using the Juniper $9$ algorithm
 883         type: string
 884       dpd_interval:
 885         description: The time between DPD probe
 886         type: string
 887       dpd_frequency:
 888         description: Maximum number of DPD before claiming the tunnel is down
 889         type: string
 890       resource_version:
 891         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
 892         type: string
 893       relationship_list:
 894         type: list
 895         entry_schema:
 896           type: org.openecomp.datatypes.inventory.Relationship
 897       vig_servers:
 898         type: list
 899         entry_schema:
 900           type: org.openecomp.nodes.inventory.VigServer
 901     capabilities:
 902       generic_vnf:
 903         type: org.openecomp.capabilities.inventory.Multiuse
 904         valid_source_types:
 905         - org.openecomp.nodes.inventory.network.GenericVnf
 906       vig_server:
 907         type: org.openecomp.capabilities.inventory.Belonging
 908         valid_source_types:
 909         - org.openecomp.nodes.inventory.VigServer
 910
 911   org.openecomp.nodes.inventory.cloud.infrastructure.Pserver:
 912     description: Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
 913     attributes:
 914       hostname:
 915         description: Value from executing hostname on the compute node.
 916         type: string
 917         annotations:
 918           primary_id: true
 919           index:
 920           - inventory
 921           search:
 922           - inventory
 923       ptnii_equip_name:
 924         description: PTNII name
 925         type: string
 926       number_of_cpus:
 927         description: Number of cpus
 928         type: integer
 929       disk_in_gigabytes:
 930         description: Disk size, in GBs
 931         type: integer
 932       ram_in_megabytes:
 933         description: RAM size, in MBs
 934         type: integer
 935       equip_type:
 936         description: Equipment type.  Source of truth should define valid values.
 937         type: string
 938       equip_vendor:
 939         description: Equipment vendor.  Source of truth should define valid values.
 940         type: string
 941       equip_model:
 942         description: Equipment model.  Source of truth should define valid values.
 943         type: string
 944       fqdn:
 945         description: Fully-qualified domain name
 946         type: string
 947       pserver_selflink:
 948         description: URL to endpoint where AAI can get more details
 949         type: string
 950       ipv4_oam_address:
 951         description: Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
 952         type: string
 953         annotations:
 954           search:
 955           - inventory
 956       serial_number:
 957         description: Serial number, may be queried
 958         type: string
 959       ipaddress_v4_loopback_0:
 960         description: IPV4 Loopback 0 address
 961         type: string
 962       ipaddress_v6_loopback_0:
 963         description: IPV6 Loopback 0 address
 964         type: string
 965       ipaddress_v4_aim:
 966         description: IPV4 AIM address
 967         type: string
 968       ipaddress_v6_aim:
 969         description: IPV6 AIM address
 970         type: string
 971       ipaddress_v6_oam:
 972         description: IPV6 OAM address
 973         type: string
 974       inv_status:
 975         description: CANOPI's inventory status.  Only set with values exactly as defined by CANOPI.
 976         type: string
 977         annotations:
 978           index:
 979           - inventory
 980       pserver_id:
 981         description: ID of Pserver
 982         type: string
 983         annotations:
 984           index:
 985           - inventory
 986           search:
 987           - inventory
 988       internet_topology:
 989         description: internet topology of Pserver
 990         type: string
 991       in_maint:
 992         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
 993         type: boolean
 994         annotations:
 995           index:
 996           - inventory
 997       resource_version:
 998         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
 999         type: string
1000       pserver_name2:
1001         description: alternative pserver name
1002         type: string
1003         annotations:
1004           index:
1005           - inventory
1006           search:
1007           - inventory
1008           summary_property: true
1009       purpose:
1010         description: purpose of pserver
1011         type: string
1012       prov_status:
1013         description: Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
1014         type: string
1015       relationship_list:
1016         type: list
1017         entry_schema:
1018           type: org.openecomp.datatypes.inventory.Relationship
1019       p_interfaces:
1020         type: list
1021         entry_schema:
1022           type: org.openecomp.nodes.inventory.PInterface
1023       lag_interfaces:
1024         type: list
1025         entry_schema:
1026           type: org.openecomp.nodes.inventory.LagInterface
1027     capabilities:
1028       generic_vnf:
1029         type: org.openecomp.capabilities.inventory.Container
1030         valid_source_types:
1031         - org.openecomp.nodes.inventory.network.GenericVnf
1032       logical_link:
1033         type: org.openecomp.capabilities.inventory.Bridgeable
1034         valid_source_types:
1035         - org.openecomp.nodes.inventory.network.LogicalLink
1036       lag_interface:
1037         type: org.openecomp.capabilities.inventory.Bindable
1038         valid_source_types:
1039         - org.openecomp.nodes.inventory.LagInterface
1040       p_interface:
1041         type: org.openecomp.capabilities.inventory.Bindable
1042         valid_source_types:
1043         - org.openecomp.nodes.inventory.PInterface
1044       vserver:
1045         type: org.openecomp.capabilities.inventory.Container
1046         valid_source_types:
1047         - org.openecomp.nodes.inventory.Vserver
1048     requirements:
1049     - availability_zone:
1050         capability: org.openecomp.capabilities.inventory.Composite
1051         node: org.openecomp.nodes.inventory.AvailabilityZone
1052         relationship: org.openecomp.relationships.inventory.MemberOf
1053         occurrences:
1054         - 0
1055         - 1
1056     - cloud_region:
1057         capability: org.openecomp.capabilities.inventory.Existable
1058         node: org.openecomp.nodes.inventory.cloud.infrastructure.CloudRegion
1059         relationship: org.openecomp.relationships.inventory.BelongsTo
1060         occurrences:
1061         - 0
1062         - 1
1063     - complex:
1064         capability: org.openecomp.capabilities.inventory.Locates
1065         node: org.openecomp.nodes.inventory.cloud.infrastructure.Complex
1066         relationship: org.openecomp.relationships.inventory.BelongsTo
1067         occurrences:
1068         - 0
1069         - 1
1070     - group_assignment:
1071         capability: org.openecomp.capabilities.inventory.Composite
1072         node: org.openecomp.nodes.inventory.GroupAssignment
1073         relationship: org.openecomp.relationships.inventory.MemberOf
1074         occurrences:
1075         - 0
1076         - 1
1077     - zone:
1078         capability: org.openecomp.capabilities.inventory.Belonging
1079         node: org.openecomp.nodes.inventory.network.Zone
1080         relationship: org.openecomp.relationships.inventory.BelongsTo
1081         occurrences:
1082         - 0
1083         - 1
1084
1085   org.openecomp.nodes.inventory.SriovVf:
1086     description: SR-IOV Virtual Function (not to be confused with virtual network function)
1087     attributes:
1088       pci_id:
1089         description: PCI ID used to identify the sriov-vf
1090         type: string
1091         annotations:
1092           primary_id: true
1093           index:
1094           - inventory
1095       vf_vlan_filter:
1096         description: This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
1097         type: string
1098         annotations:
1099           index:
1100           - inventory
1101       vf_mac_filter:
1102         description: When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
1103         type: string
1104         annotations:
1105           index:
1106           - inventory
1107       vf_vlan_strip:
1108         description: When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
1109         type: boolean
1110         annotations:
1111           index:
1112           - inventory
1113       vf_vlan_anti_spoof_check:
1114         description: This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
1115         type: boolean
1116       vf_mac_anti_spoof_check:
1117         description: This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
1118         type: boolean
1119       vf_mirrors:
1120         description: This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
1121         type: string
1122       vf_broadcast_allow:
1123         description: This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
1124         type: boolean
1125       vf_unknown_multicast_allow:
1126         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
1127         type: boolean
1128       vf_unknown_unicast_allow:
1129         description: This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
1130         type: boolean
1131       vf_insert_stag:
1132         description: This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
1133         type: boolean
1134       vf_link_status:
1135         description: This option is used to set the link status.  Valid values as of 1607 are on, off, and auto.
1136         type: string
1137       resource_version:
1138         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
1139         type: string
1140       neutron_network_id:
1141         description: Neutron network id of the interface
1142         type: string
1143         annotations:
1144           index:
1145           - inventory
1146       relationship_list:
1147         type: list
1148         entry_schema:
1149           type: org.openecomp.datatypes.inventory.Relationship
1150     requirements:
1151     - l_interface:
1152         capability: org.openecomp.capabilities.inventory.Belonging
1153         node: org.openecomp.nodes.inventory.LInterface
1154         relationship: org.openecomp.relationships.inventory.BelongsTo
1155         occurrences:
1156         - 0
1157         - 1
1158         annotations:
1159           is_child: true
1160
1161   org.openecomp.nodes.inventory.AvailabilityZone:
1162     description: Availability zone, a collection of compute hosts/pservers
1163     attributes:
1164       availability_zone_name:
1165         description: Name of the availability zone.  Unique across a cloud region
1166         type: string
1167         annotations:
1168           primary_id: true
1169           index:
1170           - inventory
1171       hypervisor_type:
1172         description: Type of hypervisor.  Source of truth should define valid values.
1173         type: string
1174       operational_state:
1175         description: State that indicates whether the availability zone should be used, etc.  Source of truth should define valid values.
1176         type: string
1177       resource_version:
1178         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
1179         type: string
1180       relationship_list:
1181         type: list
1182         entry_schema:
1183           type: org.openecomp.datatypes.inventory.Relationship
1184     capabilities:
1185       ctag_pool:
1186         type: org.openecomp.capabilities.inventory.Applicable
1187         valid_source_types:
1188         - org.openecomp.nodes.inventory.CtagPool
1189       dvs_switch:
1190         type: org.openecomp.capabilities.inventory.Applicable
1191         valid_source_types:
1192         - org.openecomp.nodes.inventory.DvsSwitch
1193       generic_vnf:
1194         type: org.openecomp.capabilities.inventory.Origin
1195         valid_source_types:
1196         - org.openecomp.nodes.inventory.network.GenericVnf
1197       pserver:
1198         type: org.openecomp.capabilities.inventory.Composite
1199         valid_source_types:
1200         - org.openecomp.nodes.inventory.cloud.infrastructure.Pserver
1201       vce:
1202         type: org.openecomp.capabilities.inventory.Multiuse
1203         valid_source_types:
1204         - org.openecomp.nodes.inventory.network.Vce
1205     requirements:
1206     - complex:
1207         capability: org.openecomp.capabilities.inventory.Existable
1208         node: org.openecomp.nodes.inventory.cloud.infrastructure.Complex
1209         relationship: org.openecomp.relationships.inventory.BelongsTo
1210         occurrences:
1211         - 0
1212         - UNBOUNDED
1213     - cloud_region:
1214         capability: org.openecomp.capabilities.inventory.Belonging
1215         node: org.openecomp.nodes.inventory.cloud.infrastructure.CloudRegion
1216         relationship: org.openecomp.relationships.inventory.BelongsTo
1217         occurrences:
1218         - 0
1219         - 1
1220         annotations:
1221           is_child: true
1222
1223   org.openecomp.nodes.inventory.ServiceInstance:
1224     description: Instance of a service
1225     attributes:
1226       service_instance_id:
1227         description: Uniquely identifies this instance of a service
1228         type: string
1229         annotations:
1230           primary_id: true
1231           unique:
1232           - inventory
1233           index:
1234           - inventory
1235           search:
1236           - inventory
1237       service_instance_name:
1238         description: This field will store a name assigned to the service-instance.
1239         type: string
1240         annotations:
1241           index:
1242           - inventory
1243           search:
1244           - inventory
1245           summary_property: true
1246       persona_model_id:
1247         description: the ASDC model id for this resource or service model.
1248         type: string
1249         annotations:
1250           index:
1251           - inventory
1252       persona_model_version:
1253         description: the ASDC model version for this resource or service model.
1254         type: string
1255         annotations:
1256           index:
1257           - inventory
1258       widget_model_id:
1259         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
1260         type: string
1261         annotations:
1262           index:
1263           - inventory
1264       widget_model_version:
1265         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
1266         type: string
1267         annotations:
1268           index:
1269           - inventory
1270       bandwidth_total:
1271         description: Indicates the total bandwidth to be used for this service.
1272         type: string
1273       bandwidth_up_wan1:
1274         description: indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
1275         type: string
1276       bandwidth_down_wan1:
1277         description: indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
1278         type: string
1279       bandwidth_up_wan2:
1280         description: indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
1281         type: string
1282       bandwidth_down_wan2:
1283         description: indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
1284         type: string
1285       vhn_portal_url:
1286         description: URL customers will use to access the vHN Portal.
1287         type: string
1288       operational_status:
1289         description: Operational status of the service-instance.
1290         type: string
1291       service_instance_location_id:
1292         description: An identifier that customers assign to the location where this service is being used.
1293         type: string
1294         annotations:
1295           index:
1296           - inventory
1297       resource_version:
1298         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
1299         type: string
1300       selflink:
1301         description: Path to the controller object.
1302         type: string
1303       orchestration_status:
1304         description: Orchestration status of this service.
1305         type: string
1306         annotations:
1307           index:
1308           - inventory
1309       relationship_list:
1310         type: list
1311         entry_schema:
1312           type: org.openecomp.datatypes.inventory.Relationship
1313       metadata:
1314         type: list
1315         entry_schema:
1316           type: org.openecomp.nodes.inventory.Metadatum
1317       allotted_resources:
1318         type: list
1319         entry_schema:
1320           type: org.openecomp.nodes.inventory.AllottedResource
1321     capabilities:
1322       allotted_resource:
1323         type: org.openecomp.capabilities.inventory.Belonging
1324         valid_source_types:
1325         - org.openecomp.nodes.inventory.AllottedResource
1326       metadatum:
1327         type: org.openecomp.capabilities.inventory.Belonging
1328         valid_source_types:
1329         - org.openecomp.nodes.inventory.Metadatum
1330       service_instance:
1331         type: org.openecomp.capabilities.inventory.Composeable
1332         valid_source_types:
1333         - org.openecomp.nodes.inventory.ServiceInstance
1334     requirements:
1335     - connector:
1336         capability: org.openecomp.capabilities.inventory.Multiuse
1337         node: org.openecomp.nodes.inventory.business.Connector
1338         relationship: org.openecomp.relationships.inventory.Uses
1339         occurrences:
1340         - 0
1341         - UNBOUNDED
1342     - ctag_assignment:
1343         capability: org.openecomp.capabilities.inventory.Multiuse
1344         node: org.openecomp.nodes.inventory.CtagAssignment
1345         relationship: org.openecomp.relationships.inventory.Uses
1346         occurrences:
1347         - 0
1348         - UNBOUNDED
1349     - cvlan_tag:
1350         capability: org.openecomp.capabilities.inventory.Composeable
1351         node: org.openecomp.nodes.inventory.CvlanTagEntry
1352         relationship: org.openecomp.relationships.inventory.ComposedOf
1353         occurrences:
1354         - 0
1355         - UNBOUNDED
1356     - generic_vnf:
1357         capability: org.openecomp.capabilities.inventory.Composeable
1358         node: org.openecomp.nodes.inventory.network.GenericVnf
1359         relationship: org.openecomp.relationships.inventory.ComposedOf
1360         occurrences:
1361         - 0
1362         - UNBOUNDED
1363     - instance_group:
1364         capability: org.openecomp.capabilities.inventory.Composite
1365         node: org.openecomp.nodes.inventory.network.InstanceGroup
1366         relationship: org.openecomp.relationships.inventory.MemberOf
1367         occurrences:
1368         - 0
1369         - UNBOUNDED
1370     - l3_network:
1371         capability: org.openecomp.capabilities.inventory.Composeable
1372         node: org.openecomp.nodes.inventory.network.L3Network
1373         relationship: org.openecomp.relationships.inventory.ComposedOf
1374         occurrences:
1375         - 0
1376         - UNBOUNDED
1377     - logical_link:
1378         capability: org.openecomp.capabilities.inventory.Multiuse
1379         node: org.openecomp.nodes.inventory.network.LogicalLink
1380         relationship: org.openecomp.relationships.inventory.Uses
1381         occurrences:
1382         - 0
1383         - UNBOUNDED
1384     - pnf:
1385         capability: org.openecomp.capabilities.inventory.Composeable
1386         node: org.openecomp.nodes.inventory.network.Pnf
1387         relationship: org.openecomp.relationships.inventory.ComposedOf
1388         occurrences:
1389         - 0
1390         - UNBOUNDED
1391     - service_instance:
1392         capability: org.openecomp.capabilities.inventory.Composeable
1393         node: org.openecomp.nodes.inventory.ServiceInstance
1394         relationship: org.openecomp.relationships.inventory.ComposedOf
1395         occurrences:
1396         - 0
1397         - UNBOUNDED
1398     - vce:
1399         capability: org.openecomp.capabilities.inventory.Composeable
1400         node: org.openecomp.nodes.inventory.network.Vce
1401         relationship: org.openecomp.relationships.inventory.ComposedOf
1402         occurrences:
1403         - 0
1404         - UNBOUNDED
1405     - vlan:
1406         capability: org.openecomp.capabilities.inventory.Composeable
1407         node: org.openecomp.nodes.inventory.Vlan
1408         relationship: org.openecomp.relationships.inventory.ComposedOf
1409         occurrences:
1410         - 0
1411         - UNBOUNDED
1412     - service_subscription:
1413         capability: org.openecomp.capabilities.inventory.Belonging
1414         node: org.openecomp.nodes.inventory.ServiceSubscription
1415         relationship: org.openecomp.relationships.inventory.BelongsTo
1416         occurrences:
1417         - 0
1418         - 1
1419         annotations:
1420           is_child: true
1421
1422   org.openecomp.nodes.inventory.network.Newvce:
1423     description: This object fills in the gaps from vce that were incorporated into generic-vnf.  This object will be retired with vce.
1424     attributes:
1425       vnf_id2:
1426         description: Unique id of VNF, can't use same attribute name right now until we promote this new object
1427         type: string
1428         annotations:
1429           primary_id: true
1430           unique:
1431           - inventory
1432           index:
1433           - inventory
1434           search:
1435           - inventory
1436       vnf_name:
1437         description: Name of VNF.
1438         type: string
1439         annotations:
1440           index:
1441           - inventory
1442           search:
1443           - inventory
1444           summary_property: true
1445       vnf_name2:
1446         description: Alternate name of VNF.
1447         type: string
1448         annotations:
1449           index:
1450           - inventory
1451           search:
1452           - inventory
1453       vnf_type:
1454         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as OPENECOMP matures.
1455         type: string
1456         annotations:
1457           index:
1458           - inventory
1459       prov_status:
1460         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
1461         type: string
1462         annotations:
1463           index:
1464           - inventory
1465       operational_state:
1466         description: Indicator for whether the resource is considered operational
1467         type: string
1468       license_key:
1469         description: OBSOLETE -  do not use
1470         type: string
1471       ipv4_oam_address:
1472         description: Address tail-f uses to configure vpe, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
1473         type: string
1474       equipment_role:
1475         description: Client should send valid enumerated value, e.g., VPE.
1476         type: string
1477       resource_version:
1478         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
1479         type: string
1480       ipv4_loopback0_address:
1481         description: v4 Loopback0 address
1482         type: string
1483       orchestration_status:
1484         description: Orchestration status of this VNF, mastered by MSO.
1485         type: string
1486       heat_stack_id:
1487         description: Heat stack id corresponding to this instance, managed by MSO
1488         type: string
1489         annotations:
1490           index:
1491           - inventory
1492       mso_catalog_key:
1493         description: Corresponds to the SDN-C catalog id used to configure this VCE
1494         type: string
1495       relationship_list:
1496         type: list
1497         entry_schema:
1498           type: org.openecomp.datatypes.inventory.Relationship
1499       l_interfaces:
1500         type: list
1501         entry_schema:
1502           type: org.openecomp.nodes.inventory.LInterface
1503     capabilities:
1504       l_interface:
1505         type: org.openecomp.capabilities.inventory.Bindable
1506         valid_source_types:
1507         - org.openecomp.nodes.inventory.LInterface
1508
1509   org.openecomp.nodes.inventory.Flavor:
1510     description: Openstack flavor.
1511     attributes:
1512       flavor_id:
1513         description: Flavor id, expected to be unique across cloud-region.
1514         type: string
1515         annotations:
1516           primary_id: true
1517           index:
1518           - inventory
1519       flavor_name:
1520         description: Flavor name
1521         type: string
1522         annotations:
1523           index:
1524           - inventory
1525           summary_property: true
1526       flavor_vcpus:
1527         description: Number of CPUs
1528         type: integer
1529       flavor_ram:
1530         description: Amount of memory
1531         type: integer
1532       flavor_disk:
1533         description: Disk space
1534         type: integer
1535       flavor_ephemeral:
1536         description: Amount of ephemeral disk space
1537         type: integer
1538       flavor_swap:
1539         description: amount of swap space allocation
1540         type: string
1541       flavor_is_public:
1542         description: whether flavor is available to all users or private to the tenant it was created in.
1543         type: boolean
1544       flavor_selflink:
1545         description: URL to endpoint where AAI can get more details
1546         type: string
1547       flavor_disabled:
1548         description: Boolean as to whether this flavor is no longer enabled
1549         type: boolean
1550       resource_version:
1551         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
1552         type: string
1553       relationship_list:
1554         type: list
1555         entry_schema:
1556           type: org.openecomp.datatypes.inventory.Relationship
1557     capabilities:
1558       vserver:
1559         type: org.openecomp.capabilities.inventory.Multiuse
1560         valid_source_types:
1561         - org.openecomp.nodes.inventory.Vserver
1562     requirements:
1563     - cloud_region:
1564         capability: org.openecomp.capabilities.inventory.Belonging
1565         node: org.openecomp.nodes.inventory.cloud.infrastructure.CloudRegion
1566         relationship: org.openecomp.relationships.inventory.BelongsTo
1567         occurrences:
1568         - 0
1569         - 1
1570         annotations:
1571           is_child: true
1572
1573   org.openecomp.nodes.inventory.DvsSwitch:
1574     description: 'Digital virtual switch metadata, used by SDN-C to configure VCEs.  A&AI
1575       needs to receive this data from the PO deployment team and administer it using
1576       the provisioningTool.sh into A&AI. '
1577     attributes:
1578       switch_name:
1579         description: DVS switch name
1580         type: string
1581         annotations:
1582           primary_id: true
1583           index:
1584           - inventory
1585       vcenter_url:
1586         description: URL used to reach the vcenter
1587         type: string
1588         annotations:
1589           index:
1590           - inventory
1591       resource_version:
1592         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
1593         type: string
1594       relationship_list:
1595         type: list
1596         entry_schema:
1597           type: org.openecomp.datatypes.inventory.Relationship
1598     requirements:
1599     - cloud_region:
1600         capability: org.openecomp.capabilities.inventory.Belonging
1601         node: org.openecomp.nodes.inventory.cloud.infrastructure.CloudRegion
1602         relationship: org.openecomp.relationships.inventory.BelongsTo
1603         occurrences:
1604         - 0
1605         - 1
1606         annotations:
1607           is_child: true
1608     - availability_zone:
1609         capability: org.openecomp.capabilities.inventory.Applicable
1610         node: org.openecomp.nodes.inventory.AvailabilityZone
1611         relationship: org.openecomp.relationships.inventory.AppliesTo
1612         occurrences:
1613         - 0
1614         - UNBOUNDED
1615
1616   org.openecomp.nodes.inventory.Entitlement:
1617     description: Metadata for entitlement group.
1618     attributes:
1619       group_uuid:
1620         description: Unique ID for the entitlement group the resource comes from, should be uuid.
1621         type: string
1622         annotations:
1623           primary_id: true
1624           index:
1625           - inventory
1626       resource_uuid:
1627         description: 'Unique ID of an entitlement resource. '
1628         type: string
1629         annotations:
1630           primary_id: true
1631           index:
1632           - inventory
1633       resource_version:
1634         description: Concurrency value
1635         type: string
1636       relationship_list:
1637         type: list
1638         entry_schema:
1639           type: org.openecomp.datatypes.inventory.Relationship
1640     requirements:
1641     - generic_vnf:
1642         capability: org.openecomp.capabilities.inventory.Belonging
1643         node: org.openecomp.nodes.inventory.network.GenericVnf
1644         relationship: org.openecomp.relationships.inventory.BelongsTo
1645         occurrences:
1646         - 0
1647         - 1
1648         annotations:
1649           is_child: true
1650     - vce:
1651         capability: org.openecomp.capabilities.inventory.Belonging
1652         node: org.openecomp.nodes.inventory.network.Vce
1653         relationship: org.openecomp.relationships.inventory.BelongsTo
1654         occurrences:
1655         - 0
1656         - 1
1657         annotations:
1658           is_child: true
1659     - vpe:
1660         capability: org.openecomp.capabilities.inventory.Belonging
1661         node: org.openecomp.nodes.inventory.network.Vpe
1662         relationship: org.openecomp.relationships.inventory.BelongsTo
1663         occurrences:
1664         - 0
1665         - 1
1666         annotations:
1667           is_child: true
1668
1669   org.openecomp.nodes.inventory.PInterface:
1670     description: Physical interface (e.g., nic)
1671     attributes:
1672       interface_name:
1673         description: Name that identifies the physical interface
1674         type: string
1675         annotations:
1676           primary_id: true
1677           index:
1678           - inventory
1679       speed_value:
1680         description: Captures the numeric part of the speed
1681         type: string
1682       speed_units:
1683         description: Captures the units corresponding to the speed
1684         type: string
1685       port_description:
1686         description: Nature of the services and connectivity on this port.
1687         type: string
1688       equipment_identifier:
1689         description: CLEI or other specification for p-interface hardware.
1690         type: string
1691       interface_role:
1692         description: Role specification for p-interface hardware.
1693         type: string
1694       interface_type:
1695         description: Indicates the physical properties of the interface.
1696         type: string
1697       prov_status:
1698         description: Trigger for operational monitoring of this resource by Service Assurance systems.
1699         type: string
1700         annotations:
1701           index:
1702           - inventory
1703           summary_property: true
1704       resource_version:
1705         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
1706         type: string
1707       relationship_list:
1708         type: list
1709         entry_schema:
1710           type: org.openecomp.datatypes.inventory.Relationship
1711       l_interfaces:
1712         type: list
1713         entry_schema:
1714           type: org.openecomp.nodes.inventory.LInterface
1715     capabilities:
1716       lag_interface:
1717         type: org.openecomp.capabilities.inventory.Multiuse
1718         valid_source_types:
1719         - org.openecomp.nodes.inventory.LagInterface
1720       l_interface:
1721         type: org.openecomp.capabilities.inventory.Bindable
1722         valid_source_types:
1723         - org.openecomp.nodes.inventory.LInterface
1724     requirements:
1725     - logical_link:
1726         capability: tosca.capabilities.network.Linkable
1727         node: org.openecomp.nodes.inventory.network.LogicalLink
1728         relationship: tosca.relationships.network.LinksTo
1729         occurrences:
1730         - 0
1731         - 1
1732     - physical_link:
1733         capability: tosca.capabilities.network.Linkable
1734         node: org.openecomp.nodes.inventory.network.PhysicalLink
1735         relationship: tosca.relationships.network.LinksTo
1736         occurrences:
1737         - 0
1738         - UNBOUNDED
1739     - pnf:
1740         capability: tosca.capabilities.network.Bindable
1741         node: org.openecomp.nodes.inventory.network.Pnf
1742         relationship: tosca.relationships.network.BindsTo
1743         occurrences:
1744         - 0
1745         - 1
1746         annotations:
1747           is_child: true
1748     - pserver:
1749         capability: tosca.capabilities.network.Bindable
1750         node: org.openecomp.nodes.inventory.cloud.infrastructure.Pserver
1751         relationship: tosca.relationships.network.BindsTo
1752         occurrences:
1753         - 0
1754         - 1
1755         annotations:
1756           is_child: true
1757     - vpls_pe:
1758         capability: tosca.capabilities.network.Bindable
1759         node: org.openecomp.nodes.inventory.network.VplsPe
1760         relationship: tosca.relationships.network.BindsTo
1761         occurrences:
1762         - 0
1763         - 1
1764         annotations:
1765           is_child: true
1766
1767   org.openecomp.nodes.inventory.network.LagLink:
1768     description: LAG links can connect lag-interfaces
1769     attributes:
1770       link_name:
1771         description: Alphabetical concatenation of lag-interface names
1772         type: string
1773         annotations:
1774           primary_id: true
1775           index:
1776           - inventory
1777       resource_version:
1778         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
1779         type: string
1780       relationship_list:
1781         type: list
1782         entry_schema:
1783           type: org.openecomp.datatypes.inventory.Relationship
1784     capabilities:
1785       lag_interface:
1786         type: org.openecomp.capabilities.inventory.Linkable
1787         valid_source_types:
1788         - org.openecomp.nodes.inventory.LagInterface
1789       logical_link:
1790         type: org.openecomp.capabilities.inventory.Multiuse
1791         valid_source_types:
1792         - org.openecomp.nodes.inventory.network.LogicalLink
1793
1794   org.openecomp.nodes.inventory.Volume:
1795     description: Ephemeral Block storage volume.
1796     attributes:
1797       volume_id:
1798         description: Unique ID of block storage volume relative to the vserver.
1799         type: string
1800         annotations:
1801           primary_id: true
1802           index:
1803           - inventory
1804       volume_selflink:
1805         description: URL to endpoint where AAI can get more details
1806         type: string
1807       resource_version:
1808         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
1809         type: string
1810       relationship_list:
1811         type: list
1812         entry_schema:
1813           type: org.openecomp.datatypes.inventory.Relationship
1814     capabilities:
1815       vserver:
1816         type: org.openecomp.capabilities.inventory.Attachment
1817         valid_source_types:
1818         - org.openecomp.nodes.inventory.Vserver
1819
1820   org.openecomp.nodes.inventory.network.Zone:
1821     description: A zone is a grouping of assets in a location homing to the same connections into the CBB
1822     attributes:
1823       zone_id:
1824         description: Code assigned by OPENECOMP to the zone
1825         type: string
1826         annotations:
1827           primary_id: true
1828           unique:
1829           - inventory
1830           index:
1831           - inventory
1832       zone_name:
1833         description: English name associated with the zone
1834         type: string
1835         annotations:
1836           summary_property: true
1837       design_type:
1838         description: Design of zone [Medium/Large�]
1839         type: string
1840         annotations:
1841           index:
1842           - inventory
1843       zone_context:
1844         description: Context of zone [production/test]
1845         type: string
1846         annotations:
1847           index:
1848           - inventory
1849       status:
1850         description: Status of a zone.
1851         type: string
1852       resource_version:
1853         description: Concurrency value
1854         type: string
1855       relationship_list:
1856         type: list
1857         entry_schema:
1858           type: org.openecomp.datatypes.inventory.Relationship
1859     capabilities:
1860       cloud_region:
1861         type: org.openecomp.capabilities.inventory.Belonging
1862         valid_source_types:
1863         - org.openecomp.nodes.inventory.cloud.infrastructure.CloudRegion
1864       pnf:
1865         type: org.openecomp.capabilities.inventory.Belonging
1866         valid_source_types:
1867         - org.openecomp.nodes.inventory.network.Pnf
1868       pserver:
1869         type: org.openecomp.capabilities.inventory.Belonging
1870         valid_source_types:
1871         - org.openecomp.nodes.inventory.cloud.infrastructure.Pserver
1872     requirements:
1873     - complex:
1874         capability: org.openecomp.capabilities.inventory.Belonging
1875         node: org.openecomp.nodes.inventory.cloud.infrastructure.Complex
1876         relationship: org.openecomp.relationships.inventory.BelongsTo
1877         occurrences:
1878         - 0
1879         - 1
1880
1881   org.openecomp.nodes.inventory.SegmentationAssignment:
1882     description: Openstack segmentation assignment.
1883     attributes:
1884       segmentation_id:
1885         description: Route Table Reference id, UUID assigned to this instance.
1886         type: string
1887         annotations:
1888           primary_id: true
1889           index:
1890           - inventory
1891       resource_version:
1892         description: Concurrency value
1893         type: string
1894       relationship_list:
1895         type: list
1896         entry_schema:
1897           type: org.openecomp.datatypes.inventory.Relationship
1898     requirements:
1899     - l3_network:
1900         capability: org.openecomp.capabilities.inventory.Belonging
1901         node: org.openecomp.nodes.inventory.network.L3Network
1902         relationship: org.openecomp.relationships.inventory.BelongsTo
1903         occurrences:
1904         - 0
1905         - 1
1906         annotations:
1907           is_child: true
1908
1909   org.openecomp.nodes.inventory.SitePair:
1910     attributes:
1911       site_pair_id:
1912         description: unique identifier of probe
1913         type: string
1914         annotations:
1915           primary_id: true
1916           unique:
1917           - inventory
1918           index:
1919           - inventory
1920       source_ip:
1921         description: Prefix address
1922         type: string
1923       destination_ip:
1924         description: Prefix address
1925         type: string
1926       ip_version:
1927         description: ip version, v4, v6
1928         type: string
1929       destination_hostname:
1930         description: Hostname of the destination equipment to which SLAs are measured against.
1931         type: string
1932       destination_equip_type:
1933         description: The type of destinatination equipment. Could be Router, UCPE, etc.
1934         type: string
1935       resource_version:
1936         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
1937         type: string
1938       classes_of_service:
1939         type: list
1940         entry_schema:
1941           type: org.openecomp.nodes.inventory.ClassOfService
1942       relationship_list:
1943         type: list
1944         entry_schema:
1945           type: org.openecomp.datatypes.inventory.Relationship
1946     capabilities:
1947       class_of_service:
1948         type: org.openecomp.capabilities.inventory.Belonging
1949         valid_source_types:
1950         - org.openecomp.nodes.inventory.ClassOfService
1951     requirements:
1952     - routing_instance:
1953         capability: org.openecomp.capabilities.inventory.Belonging
1954         node: org.openecomp.nodes.inventory.RoutingInstance
1955         relationship: org.openecomp.relationships.inventory.BelongsTo
1956         occurrences:
1957         - 0
1958         - 1
1959         annotations:
1960           is_child: true
1961
1962   org.openecomp.nodes.inventory.network.VplsPe:
1963     description: VPLS Provider Edge routers.
1964     attributes:
1965       equipment_name:
1966         type: string
1967         annotations:
1968           primary_id: true
1969           index:
1970           - inventory
1971       prov_status:
1972         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
1973         type: string
1974         annotations:
1975           index:
1976           - inventory
1977       ipv4_oam_address:
1978         description: Address tail-f uses to configure vpe, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
1979         type: string
1980       equipment_role:
1981         description: Client should send valid enumerated value, e.g., VPLS-PE.
1982         type: string
1983       vlan_id_outer:
1984         description: Temporary location for stag to get to VCE
1985         type: long
1986       resource_version:
1987         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
1988         type: string
1989       relationship_list:
1990         type: list
1991         entry_schema:
1992           type: org.openecomp.datatypes.inventory.Relationship
1993       p_interfaces:
1994         type: list
1995         entry_schema:
1996           type: org.openecomp.nodes.inventory.PInterface
1997       lag_interfaces:
1998         type: list
1999         entry_schema:
2000           type: org.openecomp.nodes.inventory.LagInterface
2001     capabilities:
2002       lag_interface:
2003         type: org.openecomp.capabilities.inventory.Bindable
2004         valid_source_types:
2005         - org.openecomp.nodes.inventory.LagInterface
2006       p_interface:
2007         type: org.openecomp.capabilities.inventory.Bindable
2008         valid_source_types:
2009         - org.openecomp.nodes.inventory.PInterface
2010     requirements:
2011     - complex:
2012         capability: org.openecomp.capabilities.inventory.Locates
2013         node: org.openecomp.nodes.inventory.cloud.infrastructure.Complex
2014         relationship: org.openecomp.relationships.inventory.BelongsTo
2015         occurrences:
2016         - 0
2017         - UNBOUNDED
2018     - ctag_pool:
2019         capability: org.openecomp.capabilities.inventory.Multiuse
2020         node: org.openecomp.nodes.inventory.CtagPool
2021         relationship: org.openecomp.relationships.inventory.Uses
2022         occurrences:
2023         - 0
2024         - UNBOUNDED
2025
2026   org.openecomp.nodes.inventory.Subnet:
2027     attributes:
2028       subnet_id:
2029         description: Subnet ID, should be UUID.
2030         type: string
2031         annotations:
2032           primary_id: true
2033           unique:
2034           - inventory
2035           index:
2036           - inventory
2037       subnet_name:
2038         description: Name associated with the subnet.
2039         type: string
2040         annotations:
2041           index:
2042           - inventory
2043           summary_property: true
2044       neutron_subnet_id:
2045         description: Neutron id of this subnet
2046         type: string
2047       gateway_address:
2048         description: gateway ip address
2049         type: string
2050       network_start_address:
2051         description: network start address
2052         type: string
2053       cidr_mask:
2054         description: cidr mask
2055         type: string
2056       ip_version:
2057         description: ip version
2058         type: string
2059       orchestration_status:
2060         description: Orchestration status of this VNF, mastered by MSO
2061         type: string
2062       dhcp_enabled:
2063         description: dhcp enabled
2064         type: boolean
2065       dhcp_start:
2066         description: the start address reserved for use by dhcp
2067         type: string
2068       dhcp_end:
2069         description: the last address reserved for use by dhcp
2070         type: string
2071       resource_version:
2072         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
2073         type: string
2074       relationship_list:
2075         type: list
2076         entry_schema:
2077           type: org.openecomp.datatypes.inventory.Relationship
2078     capabilities:
2079       l3_interface_ipv4_address_list:
2080         type: org.openecomp.capabilities.inventory.Composite
2081         valid_source_types:
2082         - org.openecomp.nodes.inventory.L3InterfaceIpv4AddressList
2083       l3_interface_ipv6_address_list:
2084         type: org.openecomp.capabilities.inventory.Composite
2085         valid_source_types:
2086         - org.openecomp.nodes.inventory.L3InterfaceIpv6AddressList
2087     requirements:
2088     - l3_network:
2089         capability: org.openecomp.capabilities.inventory.Belonging
2090         node: org.openecomp.nodes.inventory.network.L3Network
2091         relationship: org.openecomp.relationships.inventory.BelongsTo
2092         occurrences:
2093         - 0
2094         - 1
2095         annotations:
2096           is_child: true
2097
2098   org.openecomp.nodes.inventory.service.design.and.creation.VnfImage:
2099     description: Image object that pertain to a VNF that doesn't have associated vservers.  This is a kludge.
2100     attributes:
2101       att_uuid:
2102         description: Unique ID of this asset
2103         type: string
2104         annotations:
2105           primary_id: true
2106           unique:
2107           - inventory
2108           index:
2109           - inventory
2110       application:
2111         description: The application that the image instantiates.
2112         type: string
2113         annotations:
2114           index:
2115           - inventory
2116       application_vendor:
2117         description: The vendor of the application.
2118         type: string
2119         annotations:
2120           index:
2121           - inventory
2122       application_version:
2123         description: The version of the application.
2124         type: string
2125         annotations:
2126           index:
2127           - inventory
2128       selflink:
2129         description: URL to endpoint where AAI can get more details
2130         type: string
2131       resource_version:
2132         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
2133         type: string
2134       relationship_list:
2135         type: list
2136         entry_schema:
2137           type: org.openecomp.datatypes.inventory.Relationship
2138     capabilities:
2139       generic_vnf:
2140         type: org.openecomp.capabilities.inventory.Multiuse
2141         valid_source_types:
2142         - org.openecomp.nodes.inventory.network.GenericVnf
2143
2144   org.openecomp.nodes.inventory.network.RouteTableReference:
2145     description: Openstack route table reference.
2146     attributes:
2147       route_table_reference_id:
2148         description: Route Table Reference id, UUID assigned to this instance.
2149         type: string
2150         annotations:
2151           primary_id: true
2152           unique:
2153           - inventory
2154           index:
2155           - inventory
2156       route_table_reference_fqdn:
2157         description: FQDN entry in the route table.
2158         type: string
2159         annotations:
2160           index:
2161           - inventory
2162           summary_property: true
2163       resource_version:
2164         description: Concurrency value
2165         type: string
2166       relationship_list:
2167         type: list
2168         entry_schema:
2169           type: org.openecomp.datatypes.inventory.Relationship
2170     capabilities:
2171       l3_network:
2172         type: org.openecomp.capabilities.inventory.Multiuse
2173         valid_source_types:
2174         - org.openecomp.nodes.inventory.network.L3Network
2175
2176   org.openecomp.nodes.inventory.License:
2177     description: Metadata for license group.
2178     attributes:
2179       group_uuid:
2180         description: Unique ID for the license group the resource belongs to, should be uuid.
2181         type: string
2182         annotations:
2183           primary_id: true
2184           index:
2185           - inventory
2186       resource_uuid:
2187         description: 'Unique ID of a license resource. '
2188         type: string
2189         annotations:
2190           primary_id: true
2191           index:
2192           - inventory
2193       resource_version:
2194         description: Concurrency value
2195         type: string
2196       relationship_list:
2197         type: list
2198         entry_schema:
2199           type: org.openecomp.datatypes.inventory.Relationship
2200     requirements:
2201     - generic_vnf:
2202         capability: org.openecomp.capabilities.inventory.Belonging
2203         node: org.openecomp.nodes.inventory.network.GenericVnf
2204         relationship: org.openecomp.relationships.inventory.BelongsTo
2205         occurrences:
2206         - 0
2207         - 1
2208         annotations:
2209           is_child: true
2210     - vce:
2211         capability: org.openecomp.capabilities.inventory.Belonging
2212         node: org.openecomp.nodes.inventory.network.Vce
2213         relationship: org.openecomp.relationships.inventory.BelongsTo
2214         occurrences:
2215         - 0
2216         - 1
2217         annotations:
2218           is_child: true
2219     - vpe:
2220         capability: org.openecomp.capabilities.inventory.Belonging
2221         node: org.openecomp.nodes.inventory.network.Vpe
2222         relationship: org.openecomp.relationships.inventory.BelongsTo
2223         occurrences:
2224         - 0
2225         - 1
2226         annotations:
2227           is_child: true
2228
2229   org.openecomp.nodes.inventory.GroupAssignment:
2230     description: Openstack group-assignment used to store exclusivity groups (EG).
2231     attributes:
2232       group_id:
2233         description: Group id, expected to be unique across cloud-region.
2234         type: string
2235         annotations:
2236           primary_id: true
2237           index:
2238           - inventory
2239       group_type:
2240         description: Group type - the type of group this instance refers to
2241         type: string
2242         annotations:
2243           index:
2244           - inventory
2245       group_name:
2246         description: Group name - name assigned to the group
2247         type: string
2248         annotations:
2249           index:
2250           - inventory
2251           summary_property: true
2252       group_description:
2253         description: Group description - description of the group
2254         type: string
2255       resource_version:
2256         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
2257         type: string
2258       relationship_list:
2259         type: list
2260         entry_schema:
2261           type: org.openecomp.datatypes.inventory.Relationship
2262     capabilities:
2263       pserver:
2264         type: org.openecomp.capabilities.inventory.Composite
2265         valid_source_types:
2266         - org.openecomp.nodes.inventory.cloud.infrastructure.Pserver
2267       tenant:
2268         type: org.openecomp.capabilities.inventory.Composite
2269         valid_source_types:
2270         - org.openecomp.nodes.inventory.Tenant
2271     requirements:
2272     - cloud_region:
2273         capability: org.openecomp.capabilities.inventory.Belonging
2274         node: org.openecomp.nodes.inventory.cloud.infrastructure.CloudRegion
2275         relationship: org.openecomp.relationships.inventory.BelongsTo
2276         occurrences:
2277         - 0
2278         - 1
2279         annotations:
2280           is_child: true
2281
2282   org.openecomp.nodes.inventory.VfModule:
2283     description: a deployment unit of VNFCs
2284     attributes:
2285       vf_module_id:
2286         description: Unique ID of vf-module.
2287         type: string
2288         annotations:
2289           primary_id: true
2290           index:
2291           - inventory
2292           search:
2293           - inventory
2294       vf_module_name:
2295         description: Name of vf-module
2296         type: string
2297         annotations:
2298           index:
2299           - inventory
2300           search:
2301           - inventory
2302       heat_stack_id:
2303         description: Heat stack id corresponding to this instance.
2304         type: string
2305         annotations:
2306           index:
2307           - inventory
2308       orchestration_status:
2309         description: orchestration status of this vf-module, mastered by MSO
2310         type: string
2311       is_base_vf_module:
2312         description: used to indicate whether or not this object is base vf module
2313         type: boolean
2314       resource_version:
2315         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
2316         type: string
2317       persona_model_id:
2318         description: the ASDC model id for this resource or service model.
2319         type: string
2320         annotations:
2321           index:
2322           - inventory
2323       persona_model_version:
2324         description: the ASDC model version for this resource or service model.
2325         type: string
2326         annotations:
2327           index:
2328           - inventory
2329       persona_model_customization_id:
2330         description: captures the id of all the configuration used to customize the resource for the service.
2331         type: string
2332       widget_model_id:
2333         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
2334         type: string
2335         annotations:
2336           index:
2337           - inventory
2338       widget_model_version:
2339         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
2340         type: string
2341         annotations:
2342           index:
2343           - inventory
2344       contrail_service_instance_fqdn:
2345         description: the Contrail unique ID for a service-instance
2346         type: string
2347         annotations:
2348           index:
2349           - inventory
2350       module_index:
2351         description: the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit
2352         type: integer
2353       selflink:
2354         description: Path to the controller object.
2355         type: string
2356       relationship_list:
2357         type: list
2358         entry_schema:
2359           type: org.openecomp.datatypes.inventory.Relationship
2360     requirements:
2361     - generic_vnf:
2362         capability: org.openecomp.capabilities.inventory.Belonging
2363         node: org.openecomp.nodes.inventory.network.GenericVnf
2364         relationship: org.openecomp.relationships.inventory.BelongsTo
2365         occurrences:
2366         - 0
2367         - 1
2368         annotations:
2369           is_child: true
2370     - l3_network:
2371         capability: tosca.capabilities.Node
2372         node: org.openecomp.nodes.inventory.network.L3Network
2373         relationship: tosca.relationships.DependsOn
2374         occurrences:
2375         - 0
2376         - UNBOUNDED
2377     - vnfc:
2378         capability: org.openecomp.capabilities.inventory.Multiuse
2379         node: org.openecomp.nodes.inventory.network.Vnfc
2380         relationship: org.openecomp.relationships.inventory.Uses
2381         occurrences:
2382         - 0
2383         - UNBOUNDED
2384     - volume_group:
2385         capability: org.openecomp.capabilities.inventory.Multiuse
2386         node: org.openecomp.nodes.inventory.VolumeGroup
2387         relationship: org.openecomp.relationships.inventory.Uses
2388         occurrences:
2389         - 0
2390         - 1
2391     - vserver:
2392         capability: org.openecomp.capabilities.inventory.Multiuse
2393         node: org.openecomp.nodes.inventory.Vserver
2394         relationship: org.openecomp.relationships.inventory.Uses
2395         occurrences:
2396         - 0
2397         - UNBOUNDED
2398
2399   org.openecomp.nodes.inventory.Metadatum:
2400     description: Key/value pairs
2401     attributes:
2402       metaname:
2403         type: string
2404         annotations:
2405           primary_id: true
2406           index:
2407           - inventory
2408       metaval:
2409         type: string
2410       resource_version:
2411         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
2412         type: string
2413     requirements:
2414     - connector:
2415         capability: org.openecomp.capabilities.inventory.Belonging
2416         node: org.openecomp.nodes.inventory.business.Connector
2417         relationship: org.openecomp.relationships.inventory.BelongsTo
2418         occurrences:
2419         - 0
2420         - 1
2421         annotations:
2422           is_child: true
2423     - image:
2424         capability: org.openecomp.capabilities.inventory.Belonging
2425         node: org.openecomp.nodes.inventory.Image
2426         relationship: org.openecomp.relationships.inventory.BelongsTo
2427         occurrences:
2428         - 0
2429         - 1
2430         annotations:
2431           is_child: true
2432     - service_instance:
2433         capability: org.openecomp.capabilities.inventory.Belonging
2434         node: org.openecomp.nodes.inventory.ServiceInstance
2435         relationship: org.openecomp.relationships.inventory.BelongsTo
2436         occurrences:
2437         - 0
2438         - 1
2439         annotations:
2440           is_child: true
2441
2442   org.openecomp.nodes.inventory.VigServer:
2443     description: vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
2444     attributes:
2445       vig_address_type:
2446         description: indicates whether the VIG is for AVPN or INTERNET
2447         type: string
2448         annotations:
2449           primary_id: true
2450           index:
2451           - inventory
2452       ipaddress_v4_vig:
2453         description: v4 IP of the vig server
2454         type: string
2455         occurrences:
2456         - 0
2457         - UNBOUNDED
2458       ipaddress_v6_vig:
2459         description: v6 IP of the vig server
2460         type: string
2461         occurrences:
2462         - 0
2463         - UNBOUNDED
2464       resource_version:
2465         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
2466         type: string
2467       relationship_list:
2468         type: list
2469         entry_schema:
2470           type: org.openecomp.datatypes.inventory.Relationship
2471     requirements:
2472     - ipsec_configuration:
2473         capability: org.openecomp.capabilities.inventory.Belonging
2474         node: org.openecomp.nodes.inventory.network.IpsecConfiguration
2475         relationship: org.openecomp.relationships.inventory.BelongsTo
2476         occurrences:
2477         - 0
2478         - 1
2479         annotations:
2480           is_child: true
2481
2482   org.openecomp.nodes.inventory.cloud.infrastructure.CloudRegion:
2483     description: cloud-region designates an installation of a cloud cluster or region or instantiation. In AT&Ts OPENECOMP cloud, this could be an LCP or DCP. Cloud regions are uniquely identified by a composite key, cloud-owner + cloud-region-id. The format of the cloud-owner is vendor-cloudname and we will use OPENECOMP.
2484     attributes:
2485       cloud_owner:
2486         description: Identifies the vendor and cloud name, e.g., OPENECOMP. First part of composite key should be formatted as vendor-cloudname
2487         type: string
2488         annotations:
2489           primary_id: true
2490           index:
2491           - inventory
2492       cloud_region_id:
2493         description: Identifier used by the vendor for the region. Second part of composite key
2494         type: string
2495         annotations:
2496           primary_id: true
2497           index:
2498           - inventory
2499       cloud_type:
2500         description: Type of the cloud (e.g., openstack)
2501         type: string
2502         annotations:
2503           index:
2504           - inventory
2505       owner_defined_type:
2506         description: Cloud-owner defined type indicator (e.g., dcp, lcp)
2507         type: string
2508         annotations:
2509           index:
2510           - inventory
2511           summary_property: true
2512       cloud_region_version:
2513         description: Software version employed at the site.  NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
2514         type: string
2515       identity_url:
2516         description: URL of the keystone identity service
2517         type: string
2518       cloud_zone:
2519         description: Zone where the cloud is homed.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
2520         type: string
2521       complex_name:
2522         description: complex name for cloud-region instance.  NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
2523         type: string
2524       resource_version:
2525         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
2526         type: string
2527       volume_groups:
2528         type: list
2529         entry_schema:
2530           type: org.openecomp.nodes.inventory.VolumeGroup
2531       tenants:
2532         type: list
2533         entry_schema:
2534           type: org.openecomp.nodes.inventory.Tenant
2535         annotations:
2536           max_query_depth: 0
2537       flavors:
2538         type: list
2539         entry_schema:
2540           type: org.openecomp.nodes.inventory.Flavor
2541       group_assignments:
2542         type: list
2543         entry_schema:
2544           type: org.openecomp.nodes.inventory.GroupAssignment
2545       snapshots:
2546         type: list
2547         entry_schema:
2548           type: org.openecomp.nodes.inventory.Snapshot
2549       images:
2550         type: list
2551         entry_schema:
2552           type: org.openecomp.nodes.inventory.Image
2553       dvs_switches:
2554         type: list
2555         entry_schema:
2556           type: org.openecomp.nodes.inventory.DvsSwitch
2557       oam_networks:
2558         type: list
2559         entry_schema:
2560           type: org.openecomp.nodes.inventory.OamNetwork
2561       availability_zones:
2562         type: list
2563         entry_schema:
2564           type: org.openecomp.nodes.inventory.AvailabilityZone
2565       relationship_list:
2566         type: list
2567         entry_schema:
2568           type: org.openecomp.datatypes.inventory.Relationship
2569     capabilities:
2570       availability_zone:
2571         type: org.openecomp.capabilities.inventory.Belonging
2572         valid_source_types:
2573         - org.openecomp.nodes.inventory.AvailabilityZone
2574       dvs_switch:
2575         type: org.openecomp.capabilities.inventory.Belonging
2576         valid_source_types:
2577         - org.openecomp.nodes.inventory.DvsSwitch
2578       flavor:
2579         type: org.openecomp.capabilities.inventory.Belonging
2580         valid_source_types:
2581         - org.openecomp.nodes.inventory.Flavor
2582       group_assignment:
2583         type: org.openecomp.capabilities.inventory.Belonging
2584         valid_source_types:
2585         - org.openecomp.nodes.inventory.GroupAssignment
2586       image:
2587         type: org.openecomp.capabilities.inventory.Belonging
2588         valid_source_types:
2589         - org.openecomp.nodes.inventory.Image
2590       oam_network:
2591         type: org.openecomp.capabilities.inventory.Belonging
2592         valid_source_types:
2593         - org.openecomp.nodes.inventory.OamNetwork
2594       snapshot:
2595         type: org.openecomp.capabilities.inventory.Belonging
2596         valid_source_types:
2597         - org.openecomp.nodes.inventory.Snapshot
2598       tenant:
2599         type: org.openecomp.capabilities.inventory.Belonging
2600         valid_source_types:
2601         - org.openecomp.nodes.inventory.Tenant
2602       volume_group:
2603         type: org.openecomp.capabilities.inventory.Belonging
2604         valid_source_types:
2605         - org.openecomp.nodes.inventory.VolumeGroup
2606       logical_link:
2607         type: org.openecomp.capabilities.inventory.Existable
2608         valid_source_types:
2609         - org.openecomp.nodes.inventory.network.LogicalLink
2610       pserver:
2611         type: org.openecomp.capabilities.inventory.Existable
2612         valid_source_types:
2613         - org.openecomp.nodes.inventory.cloud.infrastructure.Pserver
2614     requirements:
2615     - complex:
2616         capability: org.openecomp.capabilities.inventory.Existable
2617         node: org.openecomp.nodes.inventory.cloud.infrastructure.Complex
2618         relationship: org.openecomp.relationships.inventory.BelongsTo
2619         occurrences:
2620         - 0
2621         - 1
2622     - l3_network:
2623         capability: org.openecomp.capabilities.inventory.Multiuse
2624         node: org.openecomp.nodes.inventory.network.L3Network
2625         relationship: org.openecomp.relationships.inventory.Uses
2626         occurrences:
2627         - 0
2628         - UNBOUNDED
2629     - zone:
2630         capability: org.openecomp.capabilities.inventory.Belonging
2631         node: org.openecomp.nodes.inventory.network.Zone
2632         relationship: org.openecomp.relationships.inventory.BelongsTo
2633         occurrences:
2634         - 0
2635         - 1
2636
2637   org.openecomp.nodes.inventory.network.Vpe:
2638     derived_from: org.openecomp.nodes.inventory.Vnf
2639     description: Relationship-list must include related to info for complex.
2640     attributes:
2641       vnf_id:
2642         description: Unique id of VNF.  This is unique across the graph.
2643         type: string
2644         annotations:
2645           primary_id: true
2646           unique:
2647           - inventory
2648           index:
2649           - inventory
2650           search:
2651           - inventory
2652       vnf_name:
2653         description: Name of VNF.
2654         type: string
2655         annotations:
2656           index:
2657           - inventory
2658           search:
2659           - inventory
2660           summary_property: true
2661       vnf_name2:
2662         description: Alternate name of VNF.
2663         type: string
2664         annotations:
2665           index:
2666           - inventory
2667           search:
2668           - inventory
2669       vnf_type:
2670         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as OPENECOMP matures.
2671         type: string
2672         annotations:
2673           index:
2674           - inventory
2675       service_id:
2676         description: Unique identifier of service.  Does not map strictly to ASDC services.  SOON TO BE DEPRECATED
2677         type: string
2678         annotations:
2679           index:
2680           - inventory
2681       regional_resource_zone:
2682         description: Regional way of organizing pservers, source of truth should define values
2683         type: string
2684         annotations:
2685           index:
2686           - inventory
2687       prov_status:
2688         description: Trigger for operational monitoring of this resource by Service Assurance systems.
2689         type: string
2690         annotations:
2691           index:
2692           - inventory
2693       operational_state:
2694         description: Indicator for whether the resource is considered operational
2695         type: string
2696       license_key:
2697         description: OBSOLETE -  do not use.  See child relationships.
2698         type: string
2699       equipment_role:
2700         description: Client should send valid enumerated value
2701         type: string
2702       orchestration_status:
2703         description: Orchestration status of this VNF, mastered by MSO
2704         type: string
2705       heat_stack_id:
2706         description: Heat stack id corresponding to this instance, managed by MSO
2707         type: string
2708         annotations:
2709           index:
2710           - inventory
2711       mso_catalog_key:
2712         description: Corresponds to the SDN-C catalog id used to configure this VCE
2713         type: string
2714       ipv4_oam_address:
2715         description: Address tail-f uses to configure vpe, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
2716         type: string
2717       ipv4_oam_gateway_address_prefix_length:
2718         description: Prefix length for oam-address
2719         type: integer
2720       ipv4_oam_gateway_address:
2721         description: Gateway address
2722         type: string
2723       v4_loopback0_ip_address:
2724         description: Loopback0 address
2725         type: string
2726       vlan_id_outer:
2727         description: Temporary location for stag to get to VCE
2728         type: long
2729       as_number:
2730         description: as-number of the VPE
2731         type: string
2732       resource_version:
2733         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
2734         type: string
2735       summary_status:
2736         description: details regarding the vpe operation, PLEASE DISCONTINUE USE OF THIS FIELD.
2737         type: string
2738       encrypted_access_flag:
2739         description: indicates whether vpe access uses SSH
2740         type: boolean
2741       relationship_list:
2742         type: list
2743         entry_schema:
2744           type: org.openecomp.datatypes.inventory.Relationship
2745       l_interfaces:
2746         type: list
2747         entry_schema:
2748           type: org.openecomp.nodes.inventory.LInterface
2749       lag_interfaces:
2750         type: list
2751         entry_schema:
2752           type: org.openecomp.nodes.inventory.LagInterface
2753       licenses:
2754         type: list
2755         entry_schema:
2756           type: org.openecomp.nodes.inventory.License
2757       entitlements:
2758         type: list
2759         entry_schema:
2760           type: org.openecomp.nodes.inventory.Entitlement
2761     capabilities:
2762       entitlement:
2763         type: org.openecomp.capabilities.inventory.Belonging
2764         valid_source_types:
2765         - org.openecomp.nodes.inventory.Entitlement
2766       lag_interface:
2767         type: org.openecomp.capabilities.inventory.Bindable
2768         valid_source_types:
2769         - org.openecomp.nodes.inventory.LagInterface
2770       license:
2771         type: org.openecomp.capabilities.inventory.Belonging
2772         valid_source_types:
2773         - org.openecomp.nodes.inventory.License
2774       l_interface:
2775         type: org.openecomp.capabilities.inventory.Bindable
2776         valid_source_types:
2777         - org.openecomp.nodes.inventory.LInterface
2778     requirements:
2779     - ctag_pool:
2780         capability: org.openecomp.capabilities.inventory.Multiuse
2781         node: org.openecomp.nodes.inventory.CtagPool
2782         relationship: org.openecomp.relationships.inventory.Uses
2783         occurrences:
2784         - 0
2785         - UNBOUNDED
2786     - vserver:
2787         capability: tosca.capabilities.Container
2788         node: org.openecomp.nodes.inventory.Vserver
2789         relationship: tosca.relationships.HostedOn
2790         occurrences:
2791         - 0
2792         - UNBOUNDED
2793
2794   org.openecomp.nodes.inventory.Image:
2795     description: Openstack image.
2796     attributes:
2797       image_id:
2798         description: Image id, expected to be unique across cloud region
2799         type: string
2800         annotations:
2801           primary_id: true
2802           index:
2803           - inventory
2804       image_name:
2805         description: Image name
2806         type: string
2807         annotations:
2808           index:
2809           - inventory
2810           summary_property: true
2811       image_architecture:
2812         description: Operating system architecture.
2813         type: string
2814       image_os_distro:
2815         description: The common name of the operating system distribution in lowercase
2816         type: string
2817       image_os_version:
2818         description: The operating system version as specified by the distributor.
2819         type: string
2820       application:
2821         description: The application that the image instantiates.
2822         type: string
2823         annotations:
2824           index:
2825           - inventory
2826       application_vendor:
2827         description: The vendor of the application.
2828         type: string
2829         annotations:
2830           index:
2831           - inventory
2832       application_version:
2833         description: The version of the application.
2834         type: string
2835         annotations:
2836           index:
2837           - inventory
2838       image_selflink:
2839         description: URL to endpoint where AAI can get more details
2840         type: string
2841       resource_version:
2842         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
2843         type: string
2844       relationship_list:
2845         type: list
2846         entry_schema:
2847           type: org.openecomp.datatypes.inventory.Relationship
2848       metadata:
2849         type: list
2850         entry_schema:
2851           type: org.openecomp.nodes.inventory.Metadatum
2852     capabilities:
2853       metadatum:
2854         type: org.openecomp.capabilities.inventory.Belonging
2855         valid_source_types:
2856         - org.openecomp.nodes.inventory.Metadatum
2857       vserver:
2858         type: org.openecomp.capabilities.inventory.Multiuse
2859         valid_source_types:
2860         - org.openecomp.nodes.inventory.Vserver
2861     requirements:
2862     - cloud_region:
2863         capability: org.openecomp.capabilities.inventory.Belonging
2864         node: org.openecomp.nodes.inventory.cloud.infrastructure.CloudRegion
2865         relationship: org.openecomp.relationships.inventory.BelongsTo
2866         occurrences:
2867         - 0
2868         - 1
2869         annotations:
2870           is_child: true
2871
2872   org.openecomp.nodes.inventory.network.GenericVnf:
2873     derived_from: org.openecomp.nodes.inventory.Vnf
2874     description: General purpose VNF
2875     attributes:
2876       vnf_id:
2877         description: Unique id of VNF.  This is unique across the graph.
2878         type: string
2879         annotations:
2880           primary_id: true
2881           unique:
2882           - inventory
2883           index:
2884           - inventory
2885           search:
2886           - inventory
2887       vnf_name:
2888         description: Name of VNF.
2889         type: string
2890         annotations:
2891           index:
2892           - inventory
2893           search:
2894           - inventory
2895           summary_property: true
2896       vnf_name2:
2897         description: Alternate name of VNF.
2898         type: string
2899         annotations:
2900           index:
2901           - inventory
2902           search:
2903           - inventory
2904       vnf_type:
2905         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as OPENECOMP matures.
2906         type: string
2907         annotations:
2908           index:
2909           - inventory
2910       service_id:
2911         description: Unique identifier of service, does not necessarily map to ASDC service models.  SOON TO BE DEPRECATED
2912         type: string
2913         annotations:
2914           index:
2915           - inventory
2916       regional_resource_zone:
2917         description: Regional way of organizing pservers, source of truth should define values
2918         type: string
2919         annotations:
2920           index:
2921           - inventory
2922       prov_status:
2923         description: Trigger for operational monitoring of this resource by Service Assurance systems.
2924         type: string
2925         annotations:
2926           index:
2927           - inventory
2928       operational_state:
2929         description: Indicator for whether the resource is considered operational.  Valid values are in-service-path and out-of-service-path.
2930         type: string
2931       license_key:
2932         description: OBSOLETE -  do not use
2933         type: string
2934       equipment_role:
2935         description: Client should send valid enumerated value
2936         type: string
2937       orchestration_status:
2938         description: Orchestration status of this VNF, used by MSO.
2939         type: string
2940       heat_stack_id:
2941         description: Heat stack id corresponding to this instance, managed by MSO
2942         type: string
2943         annotations:
2944           index:
2945           - inventory
2946       mso_catalog_key:
2947         description: Corresponds to the SDN-C catalog id used to configure this VCE
2948         type: string
2949       management_option:
2950         description: identifier of managed by OPENECOMP or customer
2951         type: string
2952       ipv4_oam_address:
2953         description: Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
2954         type: string
2955       ipv4_loopback0_address:
2956         description: v4 Loopback0 address
2957         type: string
2958       nm_lan_v6_address:
2959         description: v6 Loopback address
2960         type: string
2961       management_v6_address:
2962         description: v6 management address
2963         type: string
2964       vcpu:
2965         description: number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
2966         type: long
2967       vcpu_units:
2968         description: units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
2969         type: string
2970       vmemory:
2971         description: number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
2972         type: long
2973       vmemory_units:
2974         description: units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
2975         type: string
2976       vdisk:
2977         description: number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
2978         type: long
2979       vdisk_units:
2980         description: units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
2981         type: string
2982       in_maint:
2983         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
2984         type: boolean
2985         annotations:
2986           index:
2987           - inventory
2988       is_closed_loop_disabled:
2989         description: used to indicate whether closed loop function is enabled on this node
2990         type: boolean
2991         annotations:
2992           index:
2993           - inventory
2994       resource_version:
2995         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
2996         type: string
2997       summary_status:
2998         description: details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
2999         type: string
3000       encrypted_access_flag:
3001         description: indicates whether generic-vnf access uses SSH
3002         type: boolean
3003       entitlement_assignment_group_uuid:
3004         description: UUID of the Entitlement group used for licensing VNFs, OBSOLETE -  See child relationships.
3005         type: string
3006       entitlement_resource_uuid:
3007         description: UUID of the specific entitlement resource.  OBSOLETE -  See child relationships.
3008         type: string
3009       license_assignment_group_uuid:
3010         description: UUID of the license assignment group.  OBSOLETE -  See child relationships.
3011         type: string
3012       license_key_uuid:
3013         description: UUID of the actual license resource.  OBSOLETE -  See child relationships.
3014         type: string
3015       persona_model_id:
3016         description: the ASDC model id for this resource or service model.
3017         type: string
3018         annotations:
3019           index:
3020           - inventory
3021       persona_model_version:
3022         description: the ASDC model version for this resource or service model.
3023         type: string
3024         annotations:
3025           index:
3026           - inventory
3027       persona_model_customization_id:
3028         description: captures the id of all the configuration used to customize the resource for the service.
3029         type: string
3030       widget_model_id:
3031         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
3032         type: string
3033         annotations:
3034           index:
3035           - inventory
3036       widget_model_version:
3037         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
3038         type: string
3039         annotations:
3040           index:
3041           - inventory
3042       as_number:
3043         description: as-number of the VNF
3044         type: string
3045       regional_resource_subzone:
3046         description: represents sub zone of the rr plane
3047         type: string
3048       selflink:
3049         description: Path to the controller object.
3050         type: string
3051       relationship_list:
3052         type: list
3053         entry_schema:
3054           type: org.openecomp.datatypes.inventory.Relationship
3055       l_interfaces:
3056         type: list
3057         entry_schema:
3058           type: org.openecomp.nodes.inventory.LInterface
3059       lag_interfaces:
3060         type: list
3061         entry_schema:
3062           type: org.openecomp.nodes.inventory.LagInterface
3063       vf_modules:
3064         type: list
3065         entry_schema:
3066           type: org.openecomp.nodes.inventory.VfModule
3067       licenses:
3068         type: list
3069         entry_schema:
3070           type: org.openecomp.nodes.inventory.License
3071       entitlements:
3072         type: list
3073         entry_schema:
3074           type: org.openecomp.nodes.inventory.Entitlement
3075     capabilities:
3076       allotted_resource:
3077         type: org.openecomp.capabilities.inventory.Allot
3078         valid_source_types:
3079         - org.openecomp.nodes.inventory.AllottedResource
3080       entitlement:
3081         type: org.openecomp.capabilities.inventory.Belonging
3082         valid_source_types:
3083         - org.openecomp.nodes.inventory.Entitlement
3084       lag_interface:
3085         type: org.openecomp.capabilities.inventory.Belonging
3086         valid_source_types:
3087         - org.openecomp.nodes.inventory.LagInterface
3088       license:
3089         type: org.openecomp.capabilities.inventory.Belonging
3090         valid_source_types:
3091         - org.openecomp.nodes.inventory.License
3092       l_interface:
3093         type: org.openecomp.capabilities.inventory.Bindable
3094         valid_source_types:
3095         - org.openecomp.nodes.inventory.LInterface
3096       vf_module:
3097         type: org.openecomp.capabilities.inventory.Belonging
3098         valid_source_types:
3099         - org.openecomp.nodes.inventory.VfModule
3100       logical_link:
3101         type: org.openecomp.capabilities.inventory.Bridgeable
3102         valid_source_types:
3103         - org.openecomp.nodes.inventory.network.LogicalLink
3104       network_profile:
3105         type: org.openecomp.capabilities.inventory.Applicable
3106         valid_source_types:
3107         - org.openecomp.nodes.inventory.cloud.infrastructure.NetworkProfile
3108       service_instance:
3109         type: org.openecomp.capabilities.inventory.Composeable
3110         valid_source_types:
3111         - org.openecomp.nodes.inventory.ServiceInstance
3112       site_pair_set:
3113         type: org.openecomp.capabilities.inventory.Applicable
3114         valid_source_types:
3115         - org.openecomp.nodes.inventory.network.SitePairSet
3116     requirements:
3117     - availability_zone:
3118         capability: org.openecomp.capabilities.inventory.Origin
3119         node: org.openecomp.nodes.inventory.AvailabilityZone
3120         relationship: org.openecomp.relationships.inventory.Uses
3121         occurrences:
3122         - 0
3123         - UNBOUNDED
3124     - instance_group:
3125         capability: org.openecomp.capabilities.inventory.Composite
3126         node: org.openecomp.nodes.inventory.network.InstanceGroup
3127         relationship: org.openecomp.relationships.inventory.MemberOf
3128         occurrences:
3129         - 0
3130         - UNBOUNDED
3131     - ipsec_configuration:
3132         capability: org.openecomp.capabilities.inventory.Multiuse
3133         node: org.openecomp.nodes.inventory.network.IpsecConfiguration
3134         relationship: org.openecomp.relationships.inventory.Uses
3135         occurrences:
3136         - 0
3137         - 1
3138     - l3_network:
3139         capability: org.openecomp.capabilities.inventory.Multiuse
3140         node: org.openecomp.nodes.inventory.network.L3Network
3141         relationship: org.openecomp.relationships.inventory.Uses
3142         occurrences:
3143         - 0
3144         - UNBOUNDED
3145     - license_key_resource:
3146         capability: org.openecomp.capabilities.inventory.Multiuse
3147         node: org.openecomp.nodes.inventory.license.management.LicenseKeyResource
3148         relationship: org.openecomp.relationships.inventory.Uses
3149         occurrences:
3150         - 0
3151         - UNBOUNDED
3152     - pserver:
3153         capability: tosca.capabilities.Container
3154         node: org.openecomp.nodes.inventory.cloud.infrastructure.Pserver
3155         relationship: tosca.relationships.HostedOn
3156         occurrences:
3157         - 0
3158         - UNBOUNDED
3159     - virtual_data_center:
3160         capability: org.openecomp.capabilities.inventory.Existable
3161         node: org.openecomp.nodes.inventory.cloud.infrastructure.VirtualDataCenter
3162         relationship: org.openecomp.relationships.inventory.BelongsTo
3163         occurrences:
3164         - 0
3165         - UNBOUNDED
3166     - vnfc:
3167         capability: org.openecomp.capabilities.inventory.Multiuse
3168         node: org.openecomp.nodes.inventory.network.Vnfc
3169         relationship: org.openecomp.relationships.inventory.Uses
3170         occurrences:
3171         - 0
3172         - UNBOUNDED
3173     - vnf_image:
3174         capability: org.openecomp.capabilities.inventory.Multiuse
3175         node: org.openecomp.nodes.inventory.service.design.and.creation.VnfImage
3176         relationship: org.openecomp.relationships.inventory.Uses
3177         occurrences:
3178         - 0
3179         - UNBOUNDED
3180     - volume_group:
3181         capability: tosca.capabilities.Node
3182         node: org.openecomp.nodes.inventory.VolumeGroup
3183         relationship: tosca.relationships.DependsOn
3184         occurrences:
3185         - 0
3186         - UNBOUNDED
3187     - vserver:
3188         capability: tosca.capabilities.Container
3189         node: org.openecomp.nodes.inventory.Vserver
3190         relationship: tosca.relationships.HostedOn
3191         occurrences:
3192         - 0
3193         - UNBOUNDED
3194
3195   org.openecomp.nodes.inventory.Snapshot:
3196     description: Openstack snapshot
3197     attributes:
3198       snapshot_id:
3199         description: Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
3200         type: string
3201         annotations:
3202           primary_id: true
3203           unique:
3204           - inventory
3205           index:
3206           - inventory
3207       snapshot_name:
3208         description: Snapshot name
3209         type: string
3210         annotations:
3211           index:
3212           - inventory
3213           summary_property: true
3214       snapshot_architecture:
3215         description: Operating system architecture
3216         type: string
3217       snapshot_os_distro:
3218         description: The common name of the operating system distribution in lowercase
3219         type: string
3220       snapshot_os_version:
3221         description: The operating system version as specified by the distributor.
3222         type: string
3223       application:
3224         description: The application that the image instantiates.
3225         type: string
3226         annotations:
3227           index:
3228           - inventory
3229       application_vendor:
3230         description: The vendor of the application.
3231         type: string
3232         annotations:
3233           index:
3234           - inventory
3235       application_version:
3236         description: The version of the application.
3237         type: string
3238         annotations:
3239           index:
3240           - inventory
3241       snapshot_selflink:
3242         description: URL to endpoint where AAI can get more details
3243         type: string
3244       prev_snapshot_id:
3245         description: This field contains the UUID of the previous snapshot (if any).
3246         type: string
3247         annotations:
3248           index:
3249           - inventory
3250       resource_version:
3251         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
3252         type: string
3253       relationship_list:
3254         type: list
3255         entry_schema:
3256           type: org.openecomp.datatypes.inventory.Relationship
3257     capabilities:
3258       vserver:
3259         type: org.openecomp.capabilities.inventory.Multiuse
3260         valid_source_types:
3261         - org.openecomp.nodes.inventory.Vserver
3262     requirements:
3263     - cloud_region:
3264         capability: org.openecomp.capabilities.inventory.Belonging
3265         node: org.openecomp.nodes.inventory.cloud.infrastructure.CloudRegion
3266         relationship: org.openecomp.relationships.inventory.BelongsTo
3267         occurrences:
3268         - 0
3269         - 1
3270         annotations:
3271           is_child: true
3272
3273   org.openecomp.nodes.inventory.network.LogicalLink:
3274     description: Logical links generally connect l-interfaces but are used to express logical connectivity between two points
3275     attributes:
3276       link_name:
3277         description: e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
3278         type: string
3279         annotations:
3280           primary_id: true
3281           index:
3282           - inventory
3283           search:
3284           - inventory
3285       link_type:
3286         description: Type of logical link, e.g., evc
3287         type: string
3288       speed_value:
3289         description: Captures the numeric part of the speed
3290         type: string
3291       speed_units:
3292         description: Captures the units corresponding to the speed
3293         type: string
3294       ip_version:
3295         description: v4, v6, or ds for dual stack (should be openecomp-ip-version)
3296         type: string
3297       routing_protocol:
3298         description: For example, static or BGP
3299         type: string
3300       resource_version:
3301         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
3302         type: string
3303       persona_model_id:
3304         description: the ASDC model id for this resource or service model.
3305         type: string
3306         annotations:
3307           index:
3308           - inventory
3309       persona_model_version:
3310         description: the ASDC model version for this resource or service model.
3311         type: string
3312         annotations:
3313           index:
3314           - inventory
3315       widget_model_id:
3316         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
3317         type: string
3318         annotations:
3319           index:
3320           - inventory
3321       widget_model_version:
3322         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
3323         type: string
3324         annotations:
3325           index:
3326           - inventory
3327       operational_status:
3328         description: Indication of operational status of the logical link.
3329         type: string
3330       prov_status:
3331         description: Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
3332         type: string
3333         annotations:
3334           index:
3335           - inventory
3336       link_role:
3337         description: Indication of the network use of the logical link.
3338         type: string
3339       link_name2:
3340         description: Alias or alternate name (CLCI or D1 name).
3341         type: string
3342       link_id:
3343         description: UUID of the logical-link, SDNC generates this.
3344         type: string
3345         annotations:
3346           unique:
3347           - inventory
3348           index:
3349           - inventory
3350       circuit_id:
3351         description: Circuit id
3352         type: string
3353         annotations:
3354           index:
3355           - inventory
3356       purpose:
3357         description: Reason for this entity, role it is playing
3358         type: string
3359         annotations:
3360           index:
3361           - inventory
3362       relationship_list:
3363         type: list
3364         entry_schema:
3365           type: org.openecomp.datatypes.inventory.Relationship
3366     capabilities:
3367       l_interface:
3368         type: org.openecomp.capabilities.inventory.Linkable
3369         valid_source_types:
3370         - org.openecomp.nodes.inventory.LInterface
3371       logical_link:
3372         type: org.openecomp.capabilities.inventory.Multiuse
3373         valid_source_types:
3374         - org.openecomp.nodes.inventory.network.LogicalLink
3375       p_interface:
3376         type: org.openecomp.capabilities.inventory.Linkable
3377         valid_source_types:
3378         - org.openecomp.nodes.inventory.PInterface
3379       service_instance:
3380         type: org.openecomp.capabilities.inventory.Multiuse
3381         valid_source_types:
3382         - org.openecomp.nodes.inventory.ServiceInstance
3383       vlan:
3384         type: org.openecomp.capabilities.inventory.Multiuse
3385         valid_source_types:
3386         - org.openecomp.nodes.inventory.Vlan
3387     requirements:
3388     - cloud_region:
3389         capability: org.openecomp.capabilities.inventory.Existable
3390         node: org.openecomp.nodes.inventory.cloud.infrastructure.CloudRegion
3391         relationship: org.openecomp.relationships.inventory.BelongsTo
3392         occurrences:
3393         - 0
3394         - UNBOUNDED
3395     - generic_vnf:
3396         capability: org.openecomp.capabilities.inventory.Bridgeable
3397         node: org.openecomp.nodes.inventory.network.GenericVnf
3398         relationship: org.openecomp.relationships.inventory.BridgedTo
3399         occurrences:
3400         - 0
3401         - UNBOUNDED
3402     - lag_link:
3403         capability: org.openecomp.capabilities.inventory.Multiuse
3404         node: org.openecomp.nodes.inventory.network.LagLink
3405         relationship: org.openecomp.relationships.inventory.Uses
3406         occurrences:
3407         - 0
3408         - UNBOUNDED
3409     - logical_link:
3410         capability: org.openecomp.capabilities.inventory.Multiuse
3411         node: org.openecomp.nodes.inventory.network.LogicalLink
3412         relationship: org.openecomp.relationships.inventory.Uses
3413         occurrences:
3414         - 0
3415         - UNBOUNDED
3416     - pnf:
3417         capability: org.openecomp.capabilities.inventory.Bridgeable
3418         node: org.openecomp.nodes.inventory.network.Pnf
3419         relationship: org.openecomp.relationships.inventory.BridgedTo
3420         occurrences:
3421         - 0
3422         - UNBOUNDED
3423     - pserver:
3424         capability: org.openecomp.capabilities.inventory.Bridgeable
3425         node: org.openecomp.nodes.inventory.cloud.infrastructure.Pserver
3426         relationship: org.openecomp.relationships.inventory.BridgedTo
3427         occurrences:
3428         - 0
3429         - UNBOUNDED
3430     - virtual_data_center:
3431         capability: org.openecomp.capabilities.inventory.Existable
3432         node: org.openecomp.nodes.inventory.cloud.infrastructure.VirtualDataCenter
3433         relationship: org.openecomp.relationships.inventory.BelongsTo
3434         occurrences:
3435         - 0
3436         - UNBOUNDED
3437     - vpn_binding:
3438         capability: org.openecomp.capabilities.inventory.Multiuse
3439         node: org.openecomp.nodes.inventory.network.VpnBinding
3440         relationship: org.openecomp.relationships.inventory.Uses
3441         occurrences:
3442         - 0
3443         - UNBOUNDED
3444
3445   org.openecomp.nodes.inventory.network.NetworkPolicy:
3446     attributes:
3447       network_policy_id:
3448         description: UUID representing unique key to this instance
3449         type: string
3450         annotations:
3451           primary_id: true
3452           unique:
3453           - inventory
3454           index:
3455           - inventory
3456           search:
3457           - inventory
3458       network_policy_fqdn:
3459         description: Contrail FQDN for the policy
3460         type: string
3461         annotations:
3462           index:
3463           - inventory
3464           search:
3465           - inventory
3466           summary_property: true
3467       heat_stack_id:
3468         description: ID for the openStack Heat instance
3469         type: string
3470       resource_version:
3471         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
3472         type: string
3473       relationship_list:
3474         type: list
3475         entry_schema:
3476           type: org.openecomp.datatypes.inventory.Relationship
3477     capabilities:
3478       l3_network:
3479         type: org.openecomp.capabilities.inventory.Multiuse
3480         valid_source_types:
3481         - org.openecomp.nodes.inventory.network.L3Network
3482
3483   org.openecomp.nodes.inventory.TunnelXconnect:
3484     description: Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
3485     attributes:
3486       id:
3487         description: Allotted Resource id UUID assigned to this instance.
3488         type: string
3489         annotations:
3490           primary_id: true
3491           unique:
3492           - inventory
3493           index:
3494           - inventory
3495       bandwidth_up_wan1:
3496         description: The WAN uplink bandwidth for WAN1
3497         type: string
3498       bandwidth_down_wan1:
3499         description: The WAN downlink bandwidth for WAN1
3500         type: string
3501       bandwidth_up_wan2:
3502         description: The WAN uplink bandwidth for WAN2
3503         type: string
3504       bandwidth_down_wan2:
3505         description: The WAN downlink bandwidth for WAN2
3506         type: string
3507       resource_version:
3508         description: Concurrency value
3509         type: string
3510       relationship_list:
3511         type: list
3512         entry_schema:
3513           type: org.openecomp.datatypes.inventory.Relationship
3514     requirements:
3515     - allotted_resource:
3516         capability: org.openecomp.capabilities.inventory.Belonging
3517         node: org.openecomp.nodes.inventory.AllottedResource
3518         relationship: org.openecomp.relationships.inventory.BelongsTo
3519         occurrences:
3520         - 0
3521         - 1
3522         annotations:
3523           is_child: true
3524
3525   org.openecomp.nodes.inventory.OamNetwork:
3526     description: 'OAM network, to be deprecated shortly.  Do not use for new purposes. '
3527     attributes:
3528       network_uuid:
3529         description: UUID of the network. Unique across a cloud-region
3530         type: string
3531         annotations:
3532           primary_id: true
3533           index:
3534           - inventory
3535       network_name:
3536         description: Name of the network.
3537         type: string
3538         annotations:
3539           index:
3540           - inventory
3541           summary_property: true
3542       cvlan_tag:
3543         description: cvlan-id
3544         type: long
3545         annotations:
3546           index:
3547           - inventory
3548       ipv4_oam_gateway_address:
3549         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
3550         type: string
3551       ipv4_oam_gateway_address_prefix_length:
3552         description: Used for VNF firewall rule so customer cannot send customer traffic over this oam network
3553         type: integer
3554       resource_version:
3555         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
3556         type: string
3557       relationship_list:
3558         type: list
3559         entry_schema:
3560           type: org.openecomp.datatypes.inventory.Relationship
3561     requirements:
3562     - cloud_region:
3563         capability: org.openecomp.capabilities.inventory.Belonging
3564         node: org.openecomp.nodes.inventory.cloud.infrastructure.CloudRegion
3565         relationship: org.openecomp.relationships.inventory.BelongsTo
3566         occurrences:
3567         - 0
3568         - 1
3569         annotations:
3570           is_child: true
3571     - complex:
3572         capability: org.openecomp.capabilities.inventory.Applicable
3573         node: org.openecomp.nodes.inventory.cloud.infrastructure.Complex
3574         relationship: org.openecomp.relationships.inventory.AppliesTo
3575         occurrences:
3576         - 0
3577         - UNBOUNDED
3578
3579   org.openecomp.nodes.inventory.network.SitePairSet:
3580     description: Set of instances for probes used to measure service level agreements
3581     attributes:
3582       site_pair_set_id:
3583         description: Unique id of site pair set.
3584         type: string
3585         annotations:
3586           primary_id: true
3587           unique:
3588           - inventory
3589           index:
3590           - inventory
3591       resource_version:
3592         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
3593         type: string
3594       routing_instances:
3595         type: list
3596         entry_schema:
3597           type: org.openecomp.nodes.inventory.RoutingInstance
3598       relationship_list:
3599         type: list
3600         entry_schema:
3601           type: org.openecomp.datatypes.inventory.Relationship
3602     capabilities:
3603       routing_instance:
3604         type: org.openecomp.capabilities.inventory.Belonging
3605         valid_source_types:
3606         - org.openecomp.nodes.inventory.RoutingInstance
3607     requirements:
3608     - generic_vnf:
3609         capability: org.openecomp.capabilities.inventory.Applicable
3610         node: org.openecomp.nodes.inventory.network.GenericVnf
3611         relationship: org.openecomp.relationships.inventory.AppliesTo
3612         occurrences:
3613         - 0
3614         - UNBOUNDED
3615
3616   org.openecomp.nodes.inventory.CvlanTagEntry:
3617     attributes:
3618       cvlan_tag:
3619         description: See mis-na-virtualization-platform.yang
3620         type: long
3621         annotations:
3622           primary_id: true
3623           index:
3624           - inventory
3625       resource_version:
3626         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
3627         type: string
3628       relationship_list:
3629         type: list
3630         entry_schema:
3631           type: org.openecomp.datatypes.inventory.Relationship
3632     capabilities:
3633       service_instance:
3634         type: org.openecomp.capabilities.inventory.Composeable
3635         valid_source_types:
3636         - org.openecomp.nodes.inventory.ServiceInstance
3637     requirements:
3638     - port_group:
3639         capability: org.openecomp.capabilities.inventory.Belonging
3640         node: org.openecomp.nodes.inventory.PortGroup
3641         relationship: org.openecomp.relationships.inventory.BelongsTo
3642         occurrences:
3643         - 0
3644         - 1
3645         annotations:
3646           is_child: true
3647
3648   org.openecomp.nodes.inventory.ClassOfService:
3649     attributes:
3650       cos:
3651         description: unique identifier of probe
3652         type: string
3653         annotations:
3654           primary_id: true
3655           index:
3656           - inventory
3657       probe_id:
3658         description: identifier of probe
3659         type: string
3660       probe_type:
3661         description: type of probe
3662         type: string
3663       resource_version:
3664         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
3665         type: string
3666       relationship_list:
3667         type: list
3668         entry_schema:
3669           type: org.openecomp.datatypes.inventory.Relationship
3670     requirements:
3671     - site_pair:
3672         capability: org.openecomp.capabilities.inventory.Belonging
3673         node: org.openecomp.nodes.inventory.SitePair
3674         relationship: org.openecomp.relationships.inventory.BelongsTo
3675         occurrences:
3676         - 0
3677         - 1
3678         annotations:
3679           is_child: true
3680
3681   org.openecomp.nodes.inventory.CtagPool:
3682     description: A collection of C tags (vlan tags) grouped for a specific purpose.
3683     attributes:
3684       target_pe:
3685         description: The Target provider edge router
3686         type: string
3687         annotations:
3688           primary_id: true
3689       availability_zone_name:
3690         description: Name of the availability zone
3691         type: string
3692         annotations:
3693           primary_id: true
3694           index:
3695           - inventory
3696       ctag_pool_purpose:
3697         description: Describes what the intended purpose of this pool is.
3698         type: string
3699       ctag_values:
3700         description: Comma separated list of ctags
3701         type: string
3702       resource_version:
3703         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
3704         type: string
3705       relationship_list:
3706         type: list
3707         entry_schema:
3708           type: org.openecomp.datatypes.inventory.Relationship
3709     capabilities:
3710       vpe:
3711         type: org.openecomp.capabilities.inventory.Multiuse
3712         valid_source_types:
3713         - org.openecomp.nodes.inventory.network.Vpe
3714       vpls_pe:
3715         type: org.openecomp.capabilities.inventory.Multiuse
3716         valid_source_types:
3717         - org.openecomp.nodes.inventory.network.VplsPe
3718     requirements:
3719     - complex:
3720         capability: org.openecomp.capabilities.inventory.Belonging
3721         node: org.openecomp.nodes.inventory.cloud.infrastructure.Complex
3722         relationship: org.openecomp.relationships.inventory.BelongsTo
3723         occurrences:
3724         - 0
3725         - 1
3726         annotations:
3727           is_child: true
3728     - availability_zone:
3729         capability: org.openecomp.capabilities.inventory.Applicable
3730         node: org.openecomp.nodes.inventory.AvailabilityZone
3731         relationship: org.openecomp.relationships.inventory.AppliesTo
3732         occurrences:
3733         - 0
3734         - UNBOUNDED
3735
3736   org.openecomp.nodes.inventory.network.MulticastConfiguration:
3737     attributes:
3738       multicast_configuration_id:
3739         description: Unique id of multicast configuration.
3740         type: string
3741         annotations:
3742           primary_id: true
3743           unique:
3744           - inventory
3745           index:
3746           - inventory
3747       multicast_protocol:
3748         description: protocol of multicast configuration
3749         type: string
3750       rp_type:
3751         description: rp type of multicast configuration
3752         type: string
3753       resource_version:
3754         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
3755         type: string
3756       relationship_list:
3757         type: list
3758         entry_schema:
3759           type: org.openecomp.datatypes.inventory.Relationship
3760     capabilities:
3761       vlan:
3762         type: org.openecomp.capabilities.inventory.Multiuse
3763         valid_source_types:
3764         - org.openecomp.nodes.inventory.Vlan
3765
3766   org.openecomp.nodes.inventory.L3InterfaceIpv4AddressList:
3767     description: IPv4 Address Range
3768     attributes:
3769       l3_interface_ipv4_address:
3770         description: IP address
3771         type: string
3772         annotations:
3773           primary_id: true
3774           index:
3775           - inventory
3776       l3_interface_ipv4_prefix_length:
3777         description: Prefix length, 32 for single address
3778         type: long
3779       vlan_id_inner:
3780         description: Inner VLAN tag
3781         type: long
3782         annotations:
3783           index:
3784           - inventory
3785       vlan_id_outer:
3786         description: Outer VLAN tag
3787         type: long
3788       is_floating:
3789         description: Indicator of fixed or floating address
3790         type: boolean
3791       resource_version:
3792         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
3793         type: string
3794       neutron_network_id:
3795         description: Neutron network id of the interface that address belongs to
3796         type: string
3797         annotations:
3798           index:
3799           - inventory
3800       neutron_subnet_id:
3801         description: Neutron id of subnet that address belongs to
3802         type: string
3803         annotations:
3804           index:
3805           - inventory
3806       relationship_list:
3807         type: list
3808         entry_schema:
3809           type: org.openecomp.datatypes.inventory.Relationship
3810     requirements:
3811     - l3_network:
3812         capability: org.openecomp.capabilities.inventory.Composite
3813         node: org.openecomp.nodes.inventory.network.L3Network
3814         relationship: org.openecomp.relationships.inventory.MemberOf.network
3815         occurrences:
3816         - 0
3817         - UNBOUNDED
3818     - subnet:
3819         capability: org.openecomp.capabilities.inventory.Composite
3820         node: org.openecomp.nodes.inventory.Subnet
3821         relationship: org.openecomp.relationships.inventory.MemberOf.network
3822         occurrences:
3823         - 0
3824         - UNBOUNDED
3825     - l_interface:
3826         capability: org.openecomp.capabilities.inventory.Belonging
3827         node: org.openecomp.nodes.inventory.LInterface
3828         relationship: org.openecomp.relationships.inventory.BelongsTo
3829         occurrences:
3830         - 0
3831         - 1
3832         annotations:
3833           is_child: true
3834     - vlan:
3835         capability: org.openecomp.capabilities.inventory.Belonging
3836         node: org.openecomp.nodes.inventory.Vlan
3837         relationship: org.openecomp.relationships.inventory.BelongsTo
3838         occurrences:
3839         - 0
3840         - 1
3841         annotations:
3842           is_child: true
3843
3844   org.openecomp.nodes.inventory.network.VpnBinding:
3845     description: VPN binding
3846     attributes:
3847       vpn_id:
3848         description: VPN ID, globally unique within A&AI
3849         type: string
3850         annotations:
3851           primary_id: true
3852           unique:
3853           - inventory
3854           index:
3855           - inventory
3856           search:
3857           - inventory
3858       vpn_name:
3859         description: VPN Name
3860         type: string
3861         annotations:
3862           index:
3863           - inventory
3864           search:
3865           - inventory
3866           summary_property: true
3867       global_route_target:
3868         description: Number used to identify a VPN, globally unique in the network
3869         type: string
3870         annotations:
3871           index:
3872           - inventory
3873       vpn_platform:
3874         description: the platform associated with the VPN example AVPN, Mobility
3875         type: string
3876       vpn_type:
3877         description: Type of the vpn, should be taken from enumerated/valid values
3878         type: string
3879         annotations:
3880           index:
3881           - inventory
3882           summary_property: true
3883       route_distinguisher:
3884         description: Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
3885         type: string
3886       route_target_role:
3887         description: Role assigned to this route target
3888         type: string
3889       resource_version:
3890         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
3891         type: string
3892       relationship_list:
3893         description: l3-networks relate to vpn-bindings
3894         type: list
3895         entry_schema:
3896           type: org.openecomp.datatypes.inventory.Relationship
3897     capabilities:
3898       l3_network:
3899         type: org.openecomp.capabilities.inventory.Multiuse
3900         valid_source_types:
3901         - org.openecomp.nodes.inventory.network.L3Network
3902       logical_link:
3903         type: org.openecomp.capabilities.inventory.Multiuse
3904         valid_source_types:
3905         - org.openecomp.nodes.inventory.network.LogicalLink
3906
3907   org.openecomp.nodes.inventory.Vnf:
3908     description: Abstract vnf class
3909     attributes:
3910       vnf_id:
3911         description: Unique id of VNF.  This is unique across the graph.
3912         type: string
3913         annotations:
3914           primary_id: true
3915           unique:
3916           - inventory
3917           index:
3918           - inventory
3919
3920   org.openecomp.nodes.inventory.Tenant:
3921     description: Openstack tenant
3922     attributes:
3923       tenant_id:
3924         description: Unique id relative to the cloud-region.
3925         type: string
3926         annotations:
3927           primary_id: true
3928           index:
3929           - inventory
3930           search:
3931           - inventory
3932       tenant_name:
3933         description: Readable name of tenant
3934         type: string
3935         annotations:
3936           index:
3937           - inventory
3938           search:
3939           - inventory
3940           summary_property: true
3941       resource_version:
3942         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
3943         type: string
3944       vservers:
3945         type: list
3946         entry_schema:
3947           type: org.openecomp.nodes.inventory.Vserver
3948       relationship_list:
3949         type: list
3950         entry_schema:
3951           type: org.openecomp.datatypes.inventory.Relationship
3952     capabilities:
3953       service_subscription:
3954         type: org.openecomp.capabilities.inventory.Multiuse
3955         valid_source_types:
3956         - org.openecomp.nodes.inventory.ServiceSubscription
3957       vserver:
3958         type: org.openecomp.capabilities.inventory.Belonging
3959         valid_source_types:
3960         - org.openecomp.nodes.inventory.Vserver
3961     requirements:
3962     - cloud_region:
3963         capability: org.openecomp.capabilities.inventory.Belonging
3964         node: org.openecomp.nodes.inventory.cloud.infrastructure.CloudRegion
3965         relationship: org.openecomp.relationships.inventory.BelongsTo
3966         occurrences:
3967         - 0
3968         - 1
3969         annotations:
3970           is_child: true
3971     - group_assignment:
3972         capability: org.openecomp.capabilities.inventory.Composite
3973         node: org.openecomp.nodes.inventory.GroupAssignment
3974         relationship: org.openecomp.relationships.inventory.MemberOf
3975         occurrences:
3976         - 0
3977         - UNBOUNDED
3978     - l3_network:
3979         capability: org.openecomp.capabilities.inventory.Multiuse
3980         node: org.openecomp.nodes.inventory.network.L3Network
3981         relationship: org.openecomp.relationships.inventory.Uses
3982         occurrences:
3983         - 0
3984         - UNBOUNDED
3985     - volume_group:
3986         capability: tosca.capabilities.Node
3987         node: org.openecomp.nodes.inventory.VolumeGroup
3988         relationship: tosca.relationships.DependsOn
3989         occurrences:
3990         - 0
3991         - UNBOUNDED
3992
3993   org.openecomp.nodes.inventory.business.Customer:
3994     description: customer identifiers to provide linkage back to BSS information.
3995     attributes:
3996       global_customer_id:
3997         description: Global customer id used across OPENECOMP to uniquely identify customer.
3998         type: string
3999         annotations:
4000           primary_id: true
4001           unique:
4002           - inventory
4003           index:
4004           - inventory
4005           search:
4006           - inventory
4007       subscriber_name:
4008         description: Subscriber name, an alternate way to retrieve a customer.
4009         type: string
4010         annotations:
4011           index:
4012           - inventory
4013           search:
4014           - inventory
4015           summary_property: true
4016       subscriber_type:
4017         description: Subscriber type, a way to provide VID with only the INFRA customers.
4018         type: string
4019         annotations:
4020           index:
4021           - inventory
4022       resource_version:
4023         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
4024         type: string
4025       service_subscriptions:
4026         type: list
4027         entry_schema:
4028           type: org.openecomp.nodes.inventory.ServiceSubscription
4029       relationship_list:
4030         type: list
4031         entry_schema:
4032           type: org.openecomp.datatypes.inventory.Relationship
4033     capabilities:
4034       service_subscription:
4035         type: org.openecomp.capabilities.inventory.Belonging
4036         valid_source_types:
4037         - org.openecomp.nodes.inventory.ServiceSubscription
4038
4039   org.openecomp.nodes.inventory.AllottedResource:
4040     description: Represents a slice or partial piece of a resource that gets separately allotted
4041     attributes:
4042       id:
4043         description: Allotted Resource id UUID assigned to this instance.
4044         type: string
4045         annotations:
4046           primary_id: true
4047           unique:
4048           - inventory
4049           index:
4050           - inventory
4051       description:
4052         description: The descriptive information assigned to this allotted resource instance
4053         type: string
4054         annotations:
4055           summary_property: true
4056       selflink:
4057         description: Link back to more information in the controller
4058         type: string
4059       persona_model_id:
4060         description: the ASDC model id for this resource or service model.
4061         type: string
4062         annotations:
4063           index:
4064           - inventory
4065       persona_model_version:
4066         description: the ASDC model version for this resource or service model.
4067         type: string
4068         annotations:
4069           index:
4070           - inventory
4071       resource_version:
4072         description: Concurrency value
4073         type: string
4074       tunnel_xconnects:
4075         type: list
4076         entry_schema:
4077           type: org.openecomp.nodes.inventory.TunnelXconnect
4078       relationship_list:
4079         type: list
4080         entry_schema:
4081           type: org.openecomp.datatypes.inventory.Relationship
4082     capabilities:
4083       tunnel_xconnect:
4084         type: org.openecomp.capabilities.inventory.Belonging
4085         valid_source_types:
4086         - org.openecomp.nodes.inventory.TunnelXconnect
4087     requirements:
4088     - generic_vnf:
4089         capability: org.openecomp.capabilities.inventory.Allot
4090         node: org.openecomp.nodes.inventory.network.GenericVnf
4091         relationship: org.openecomp.relationships.inventory.PartOf
4092         occurrences:
4093         - 0
4094         - UNBOUNDED
4095     - instance_group:
4096         capability: org.openecomp.capabilities.inventory.Composite
4097         node: org.openecomp.nodes.inventory.network.InstanceGroup
4098         relationship: org.openecomp.relationships.inventory.MemberOf
4099         occurrences:
4100         - 0
4101         - UNBOUNDED
4102     - l3_network:
4103         capability: org.openecomp.capabilities.inventory.Allot
4104         node: org.openecomp.nodes.inventory.network.L3Network
4105         relationship: org.openecomp.relationships.inventory.PartOf
4106         occurrences:
4107         - 0
4108         - UNBOUNDED
4109     - vlan:
4110         capability: org.openecomp.capabilities.inventory.Allot
4111         node: org.openecomp.nodes.inventory.Vlan
4112         relationship: org.openecomp.relationships.inventory.PartOf
4113         occurrences:
4114         - 0
4115         - UNBOUNDED
4116     - service_instance:
4117         capability: org.openecomp.capabilities.inventory.Belonging
4118         node: org.openecomp.nodes.inventory.ServiceInstance
4119         relationship: org.openecomp.relationships.inventory.BelongsTo
4120         occurrences:
4121         - 0
4122         - 1
4123         annotations:
4124           is_child: true
4125
4126   org.openecomp.nodes.inventory.cloud.infrastructure.Complex:
4127     description: Collection of physical locations that can house cloud-regions.
4128     attributes:
4129       physical_location_id:
4130         description: Unique identifier for physical location, e.g., CLLI
4131         type: string
4132         annotations:
4133           primary_id: true
4134           unique:
4135           - inventory
4136           index:
4137           - inventory
4138           search:
4139           - inventory
4140       data_center_code:
4141         description: Data center code which can be an alternate way to identify a complex
4142         type: string
4143         annotations:
4144           index:
4145           - inventory
4146           search:
4147           - inventory
4148       complex_name:
4149         description: Gamma complex name for LCP instance.
4150         type: string
4151         annotations:
4152           index:
4153           - inventory
4154           search:
4155           - inventory
4156       identity_url:
4157         description: URL of the keystone identity service
4158         type: string
4159         annotations:
4160           index:
4161           - inventory
4162       resource_version:
4163         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
4164         type: string
4165       physical_location_type:
4166         description: Type, e.g., central office, data center.
4167         type: string
4168       street1:
4169         type: string
4170         annotations:
4171           search:
4172           - inventory
4173       street2:
4174         type: string
4175         annotations:
4176           search:
4177           - inventory
4178       city:
4179         type: string
4180       state:
4181         type: string
4182       postal_code:
4183         type: string
4184         annotations:
4185           search:
4186           - inventory
4187       country:
4188         type: string
4189       region:
4190         type: string
4191       latitude:
4192         type: string
4193       longitude:
4194         type: string
4195       elevation:
4196         type: string
4197       lata:
4198         type: string
4199       ctag_pools:
4200         type: list
4201         entry_schema:
4202           type: org.openecomp.nodes.inventory.CtagPool
4203       relationship_list:
4204         type: list
4205         entry_schema:
4206           type: org.openecomp.datatypes.inventory.Relationship
4207     capabilities:
4208       availability_zone:
4209         type: org.openecomp.capabilities.inventory.Existable
4210         valid_source_types:
4211         - org.openecomp.nodes.inventory.AvailabilityZone
4212       cloud_region:
4213         type: org.openecomp.capabilities.inventory.Existable
4214         valid_source_types:
4215         - org.openecomp.nodes.inventory.cloud.infrastructure.CloudRegion
4216       ctag_pool:
4217         type: org.openecomp.capabilities.inventory.Belonging
4218         valid_source_types:
4219         - org.openecomp.nodes.inventory.CtagPool
4220       oam_network:
4221         type: org.openecomp.capabilities.inventory.Applicable
4222         valid_source_types:
4223         - org.openecomp.nodes.inventory.OamNetwork
4224       pnf:
4225         type: org.openecomp.capabilities.inventory.Locates
4226         valid_source_types:
4227         - org.openecomp.nodes.inventory.network.Pnf
4228       pserver:
4229         type: org.openecomp.capabilities.inventory.Locates
4230         valid_source_types:
4231         - org.openecomp.nodes.inventory.cloud.infrastructure.Pserver
4232       volume_group:
4233         type: org.openecomp.capabilities.inventory.Existable
4234         valid_source_types:
4235         - org.openecomp.nodes.inventory.VolumeGroup
4236       vpls_pe:
4237         type: org.openecomp.capabilities.inventory.Locates
4238         valid_source_types:
4239         - org.openecomp.nodes.inventory.network.VplsPe
4240       zone:
4241         type: org.openecomp.capabilities.inventory.Belonging
4242         valid_source_types:
4243         - org.openecomp.nodes.inventory.network.Zone
4244     requirements:
4245     - l3_network:
4246         capability: org.openecomp.capabilities.inventory.Multiuse
4247         node: org.openecomp.nodes.inventory.network.L3Network
4248         relationship: org.openecomp.relationships.inventory.Uses
4249         occurrences:
4250         - 0
4251         - UNBOUNDED
4252
4253   org.openecomp.nodes.inventory.CtagAssignment:
4254     attributes:
4255       vlan_id_inner:
4256         description: id.
4257         type: long
4258         annotations:
4259           primary_id: true
4260           index:
4261           - inventory
4262       resource_version:
4263         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
4264         type: string
4265       relationship_list:
4266         type: list
4267         entry_schema:
4268           type: org.openecomp.datatypes.inventory.Relationship
4269     capabilities:
4270       service_instance:
4271         type: org.openecomp.capabilities.inventory.Multiuse
4272         valid_source_types:
4273         - org.openecomp.nodes.inventory.ServiceInstance
4274     requirements:
4275     - l3_network:
4276         capability: org.openecomp.capabilities.inventory.Belonging
4277         node: org.openecomp.nodes.inventory.network.L3Network
4278         relationship: org.openecomp.relationships.inventory.BelongsTo
4279         occurrences:
4280         - 0
4281         - 1
4282         annotations:
4283           is_child: true
4284
4285   org.openecomp.nodes.inventory.RoutingInstance:
4286     attributes:
4287       routing_instance_id:
4288         description: Unique id of routing instance
4289         type: string
4290         annotations:
4291           primary_id: true
4292           unique:
4293           - inventory
4294           index:
4295           - inventory
4296       rpm_owner:
4297         description: rpm owner
4298         type: string
4299       resource_version:
4300         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
4301         type: string
4302       site_pairs:
4303         type: list
4304         entry_schema:
4305           type: org.openecomp.nodes.inventory.SitePair
4306       relationship_list:
4307         type: list
4308         entry_schema:
4309           type: org.openecomp.datatypes.inventory.Relationship
4310     capabilities:
4311       site_pair:
4312         type: org.openecomp.capabilities.inventory.Belonging
4313         valid_source_types:
4314         - org.openecomp.nodes.inventory.SitePair
4315     requirements:
4316     - site_pair_set:
4317         capability: org.openecomp.capabilities.inventory.Belonging
4318         node: org.openecomp.nodes.inventory.network.SitePairSet
4319         relationship: org.openecomp.relationships.inventory.BelongsTo
4320         occurrences:
4321         - 0
4322         - 1
4323         annotations:
4324           is_child: true
4325
4326   org.openecomp.nodes.inventory.cloud.infrastructure.NetworkProfile:
4327     description: Network profile populated by SDN-GP for SNMP
4328     attributes:
4329       nm_profile_name:
4330         description: Unique name of network profile.
4331         type: string
4332         annotations:
4333           primary_id: true
4334           index:
4335           - inventory
4336       community_string:
4337         description: Encrypted SNMP community string
4338         type: string
4339       resource_version:
4340         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
4341         type: string
4342       relationship_list:
4343         type: list
4344         entry_schema:
4345           type: org.openecomp.datatypes.inventory.Relationship
4346     requirements:
4347     - generic_vnf:
4348         capability: org.openecomp.capabilities.inventory.Applicable
4349         node: org.openecomp.nodes.inventory.network.GenericVnf
4350         relationship: org.openecomp.relationships.inventory.AppliesTo
4351         occurrences:
4352         - 0
4353         - UNBOUNDED
4354
4355   org.openecomp.nodes.inventory.network.Vnfc:
4356     attributes:
4357       vnfc_name:
4358         description: Unique ID of vnfc.
4359         type: string
4360         annotations:
4361           primary_id: true
4362           index:
4363           - inventory
4364           search:
4365           - inventory
4366       vnfc_function_code:
4367         description: function code
4368         type: string
4369         annotations:
4370           index:
4371           - inventory
4372       vnfc_type:
4373         description: type
4374         type: string
4375         annotations:
4376           index:
4377           - inventory
4378       prov_status:
4379         description: prov status of this vnfc
4380         type: string
4381         annotations:
4382           index:
4383           - inventory
4384       orchestration_status:
4385         description: Orchestration status of this VNF, mastered by APP-C
4386         type: string
4387       ipaddress_v4_oam_vip:
4388         description: Oam V4 vip address of this vnfc
4389         type: string
4390         annotations:
4391           index:
4392           - inventory
4393       in_maint:
4394         description: used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
4395         type: boolean
4396         annotations:
4397           index:
4398           - inventory
4399       is_closed_loop_disabled:
4400         description: used to indicate whether closed loop function is enabled on this node
4401         type: boolean
4402         annotations:
4403           index:
4404           - inventory
4405       group_notation:
4406         description: Group notation of VNFC
4407         type: string
4408         annotations:
4409           index:
4410           - inventory
4411       resource_version:
4412         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
4413         type: string
4414       relationship_list:
4415         type: list
4416         entry_schema:
4417           type: org.openecomp.datatypes.inventory.Relationship
4418     capabilities:
4419       generic_vnf:
4420         type: org.openecomp.capabilities.inventory.Multiuse
4421         valid_source_types:
4422         - org.openecomp.nodes.inventory.network.GenericVnf
4423       vf_module:
4424         type: org.openecomp.capabilities.inventory.Multiuse
4425         valid_source_types:
4426         - org.openecomp.nodes.inventory.VfModule
4427     requirements:
4428     - vserver:
4429         capability: tosca.capabilities.Container
4430         node: org.openecomp.nodes.inventory.Vserver
4431         relationship: tosca.relationships.HostedOn
4432         occurrences:
4433         - 0
4434         - UNBOUNDED
4435
4436   org.openecomp.nodes.inventory.network.Vce:
4437     derived_from: org.openecomp.nodes.inventory.Vnf
4438     description: Virtual Customer Edge Router, used specifically for Gamma.  This object is deprecated.
4439     attributes:
4440       vnf_id:
4441         description: Unique id of VNF.  This is unique across the graph.
4442         type: string
4443         annotations:
4444           primary_id: true
4445           unique:
4446           - inventory
4447           index:
4448           - inventory
4449           search:
4450           - inventory
4451       vnf_name:
4452         description: Name of VNF.
4453         type: string
4454         annotations:
4455           index:
4456           - inventory
4457           search:
4458           - inventory
4459           summary_property: true
4460       vnf_name2:
4461         description: Alternate name of VNF.
4462         type: string
4463         annotations:
4464           index:
4465           - inventory
4466           search:
4467           - inventory
4468       vnf_type:
4469         description: String capturing type of vnf, that was intended to identify the ASDC resource.  This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as OPENECOMP matures.
4470         type: string
4471         annotations:
4472           index:
4473           - inventory
4474       service_id:
4475         description: Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
4476         type: string
4477         annotations:
4478           index:
4479           - inventory
4480       regional_resource_zone:
4481         description: Regional way of organizing pservers, source of truth should define values
4482         type: string
4483         annotations:
4484           index:
4485           - inventory
4486       prov_status:
4487         description: Trigger for operational monitoring of this resource by Service Assurance systems.
4488         type: string
4489         annotations:
4490           index:
4491           - inventory
4492       operational_state:
4493         description: Indicator for whether the resource is considered operational
4494         type: string
4495       license_key:
4496         description: OBSOLETE -  do not use
4497         type: string
4498       equipment_role:
4499         description: Network role being played by this VNF
4500         type: string
4501       orchestration_status:
4502         description: Orchestration status of this VNF, mastered by MSO
4503         type: string
4504       heat_stack_id:
4505         description: Heat stack id corresponding to this instance, managed by MSO
4506         type: string
4507         annotations:
4508           index:
4509           - inventory
4510       mso_catalog_key:
4511         description: Corresponds to the SDN-C catalog id used to configure this VCE
4512         type: string
4513       vpe_id:
4514         description: Unique ID of VPE connected to this VCE.
4515         type: string
4516         annotations:
4517           index:
4518           - inventory
4519       v6_vce_wan_address:
4520         description: Valid v6 IP address for the WAN Link on this router.  Implied length of /64.
4521         type: string
4522       ipv4_oam_address:
4523         description: Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
4524         type: string
4525       resource_version:
4526         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
4527         type: string
4528       ipv4_loopback0_address:
4529         description: Loopback0 address
4530         type: string
4531       entitlement_resource_uuid:
4532         description: OBSOLETE -  see child relationships
4533         type: string
4534       port_groups:
4535         type: list
4536         entry_schema:
4537           type: org.openecomp.nodes.inventory.PortGroup
4538       licenses:
4539         type: list
4540         entry_schema:
4541           type: org.openecomp.nodes.inventory.License
4542       entitlements:
4543         type: list
4544         entry_schema:
4545           type: org.openecomp.nodes.inventory.Entitlement
4546       relationship_list:
4547         type: list
4548         entry_schema:
4549           type: org.openecomp.datatypes.inventory.Relationship
4550     capabilities:
4551       service_instance:
4552         type: org.openecomp.capabilities.inventory.Composeable
4553         valid_source_types:
4554         - org.openecomp.nodes.inventory.ServiceInstance
4555       entitlement:
4556         type: org.openecomp.capabilities.inventory.Belonging
4557         valid_source_types:
4558         - org.openecomp.nodes.inventory.Entitlement
4559       license:
4560         type: org.openecomp.capabilities.inventory.Belonging
4561         valid_source_types:
4562         - org.openecomp.nodes.inventory.License
4563       port_group:
4564         type: org.openecomp.capabilities.inventory.Belonging
4565         valid_source_types:
4566         - org.openecomp.nodes.inventory.PortGroup
4567     requirements:
4568     - availability_zone:
4569         capability: org.openecomp.capabilities.inventory.Multiuse
4570         node: org.openecomp.nodes.inventory.AvailabilityZone
4571         relationship: org.openecomp.relationships.inventory.Uses
4572         occurrences:
4573         - 0
4574         - UNBOUNDED
4575     - vserver:
4576         capability: tosca.capabilities.Container
4577         node: org.openecomp.nodes.inventory.Vserver
4578         relationship: tosca.relationships.HostedOn
4579         occurrences:
4580         - 0
4581         - UNBOUNDED
4582
4583   org.openecomp.nodes.inventory.ServiceSubscription:
4584     description: Object that group service instances.
4585     attributes:
4586       service_type:
4587         description: Value defined by orchestration to identify this service across OPENECOMP.
4588         type: string
4589         annotations:
4590           primary_id: true
4591           index:
4592           - inventory
4593       temp_ub_sub_account_id:
4594         description: This property will be deleted from A&AI in the near future. Only stop gap solution.
4595         type: string
4596       resource_version:
4597         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
4598         type: string
4599       service_instances:
4600         type: list
4601         entry_schema:
4602           type: org.openecomp.nodes.inventory.ServiceInstance
4603       relationship_list:
4604         type: list
4605         entry_schema:
4606           type: org.openecomp.datatypes.inventory.Relationship
4607     capabilities:
4608       service_instance:
4609         type: org.openecomp.capabilities.inventory.Belonging
4610         valid_source_types:
4611         - org.openecomp.nodes.inventory.ServiceInstance
4612     requirements:
4613     - customer:
4614         capability: org.openecomp.capabilities.inventory.Belonging
4615         node: org.openecomp.nodes.inventory.business.Customer
4616         relationship: org.openecomp.relationships.inventory.BelongsTo
4617         occurrences:
4618         - 0
4619         - 1
4620         annotations:
4621           is_child: true
4622     - tenant:
4623         capability: org.openecomp.capabilities.inventory.Multiuse
4624         node: org.openecomp.nodes.inventory.Tenant
4625         relationship: org.openecomp.relationships.inventory.Uses
4626         occurrences:
4627         - 0
4628         - UNBOUNDED
4629
4630   org.openecomp.nodes.inventory.PortGroup:
4631     description: Used to capture the network interfaces of this VCE
4632     attributes:
4633       interface_id:
4634         description: Unique ID of the interface
4635         type: string
4636         annotations:
4637           primary_id: true
4638           index:
4639           - inventory
4640       neutron_network_id:
4641         description: Neutron network id of this Interface
4642         type: string
4643       neutron_network_name:
4644         description: Neutron network name of this Interface
4645         type: string
4646       interface_role:
4647         description: Role assigned to this Interface, should use values as defined in OPENECOMP Yang models.
4648         type: string
4649       resource_version:
4650         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
4651         type: string
4652       port_group_id:
4653         description: Unique ID for port group in vmware
4654         type: string
4655         annotations:
4656           index:
4657           - inventory
4658       port_group_name:
4659         description: Likely to duplicate value of neutron network name
4660         type: string
4661         annotations:
4662           summary_property: true
4663       switch_name:
4664         description: DVS or standard switch name (should be non-null for port groups associated with DVS)
4665         type: string
4666         annotations:
4667           index:
4668           - inventory
4669       orchestration_status:
4670         description: Orchestration status of this VNF, mastered by MSO
4671         type: string
4672       heat_stack_id:
4673         description: Heat stack id corresponding to this instance, managed by MSO
4674         type: string
4675         annotations:
4676           index:
4677           - inventory
4678       mso_catalog_key:
4679         description: Corresponds to the SDN-C catalog id used to configure this VCE
4680         type: string
4681       cvlan_tags:
4682         type: list
4683         entry_schema:
4684           type: org.openecomp.nodes.inventory.CvlanTagEntry
4685       relationship_list:
4686         type: list
4687         entry_schema:
4688           type: org.openecomp.datatypes.inventory.Relationship
4689     capabilities:
4690       cvlan_tag:
4691         type: org.openecomp.capabilities.inventory.Belonging
4692         valid_source_types:
4693         - org.openecomp.nodes.inventory.CvlanTagEntry
4694     requirements:
4695     - vce:
4696         capability: org.openecomp.capabilities.inventory.Belonging
4697         node: org.openecomp.nodes.inventory.network.Vce
4698         relationship: org.openecomp.relationships.inventory.BelongsTo
4699         occurrences:
4700         - 0
4701         - 1
4702         annotations:
4703           is_child: true
4704
4705   org.openecomp.nodes.inventory.business.Connector:
4706     description: Collection of resource instances used to connect a variety of disparate inventory widgets
4707     attributes:
4708       resource_instance_id:
4709         description: Unique id of resource instance.
4710         type: string
4711         annotations:
4712           primary_id: true
4713           index:
4714           - inventory
4715       resource_version:
4716         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
4717         type: string
4718       persona_model_id:
4719         description: the ASDC model id for this resource or service model.
4720         type: string
4721         annotations:
4722           index:
4723           - inventory
4724       persona_model_version:
4725         description: the ASDC model version for this resource or service model.
4726         type: string
4727         annotations:
4728           index:
4729           - inventory
4730       widget_model_id:
4731         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
4732         type: string
4733         annotations:
4734           index:
4735           - inventory
4736       widget_model_version:
4737         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
4738         type: string
4739         annotations:
4740           index:
4741           - inventory
4742       relationship_list:
4743         type: list
4744         entry_schema:
4745           type: org.openecomp.datatypes.inventory.Relationship
4746       metadata:
4747         type: list
4748         entry_schema:
4749           type: org.openecomp.nodes.inventory.Metadatum
4750     capabilities:
4751       metadatum:
4752         type: org.openecomp.capabilities.inventory.Belonging
4753         valid_source_types:
4754         - org.openecomp.nodes.inventory.Metadatum
4755       service_instance:
4756         type: org.openecomp.capabilities.inventory.Multiuse
4757         valid_source_types:
4758         - org.openecomp.nodes.inventory.ServiceInstance
4759     requirements:
4760     - virtual_data_center:
4761         capability: org.openecomp.capabilities.inventory.Existable
4762         node: org.openecomp.nodes.inventory.cloud.infrastructure.VirtualDataCenter
4763         relationship: org.openecomp.relationships.inventory.BelongsTo
4764         occurrences:
4765         - 0
4766         - UNBOUNDED
4767
4768   org.openecomp.nodes.inventory.network.PhysicalLink:
4769     description: Collection of physical connections, typically between p-interfaces
4770     attributes:
4771       link_name:
4772         description: e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
4773         type: string
4774         annotations:
4775           primary_id: true
4776           index:
4777           - inventory
4778           search:
4779           - inventory
4780       speed_value:
4781         description: Captures the numeric part of the speed
4782         type: string
4783       speed_units:
4784         description: Captures the units corresponding to the speed
4785         type: string
4786       circuit_id:
4787         description: Circuit it
4788         type: string
4789         annotations:
4790           index:
4791           - inventory
4792           search:
4793           - inventory
4794       dual_mode:
4795         description: Dual access mode (e.g., primary, secondary
4796         type: string
4797       management_option:
4798         description: To provide information on who manages this circuit. A&AI or 3rd party transport provider
4799         type: string
4800       service_provider_name:
4801         description: Name of the service Provider on this link.
4802         type: string
4803       resource_version:
4804         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
4805         type: string
4806       relationship_list:
4807         type: list
4808         entry_schema:
4809           type: org.openecomp.datatypes.inventory.Relationship
4810     capabilities:
4811       p_interface:
4812         type: org.openecomp.capabilities.inventory.Linkable
4813         valid_source_types:
4814         - org.openecomp.nodes.inventory.PInterface
4815
4816   org.openecomp.nodes.inventory.license.management.LicenseKeyResource:
4817     description: 'OBSOLETE OBJECT:  do not use'
4818     attributes:
4819       att_uuid:
4820         type: string
4821         annotations:
4822           primary_id: true
4823           unique:
4824           - inventory
4825           index:
4826           - inventory
4827       assignment_type:
4828         type: string
4829       assignment_status:
4830         type: string
4831       assignment_group_uuid:
4832         type: string
4833         annotations:
4834           index:
4835           - inventory
4836       assignment_date:
4837         type: string
4838       name:
4839         type: string
4840         annotations:
4841           index:
4842           - inventory
4843           summary_property: true
4844       model_uuid:
4845         type: string
4846       model_version:
4847         type: string
4848       license_key:
4849         type: string
4850       license_key_file_url:
4851         type: string
4852       supplier_release_list:
4853         type: string
4854         occurrences:
4855         - 0
4856         - UNBOUNDED
4857       resource_version:
4858         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
4859         type: string
4860       relationship_list:
4861         type: list
4862         entry_schema:
4863           type: org.openecomp.datatypes.inventory.Relationship
4864     capabilities:
4865       generic_vnf:
4866         type: org.openecomp.capabilities.inventory.Multiuse
4867         valid_source_types:
4868         - org.openecomp.nodes.inventory.network.GenericVnf
4869
4870   org.openecomp.nodes.inventory.L3InterfaceIpv6AddressList:
4871     description: IPv6 Address Range
4872     attributes:
4873       l3_interface_ipv6_address:
4874         description: IP address
4875         type: string
4876         annotations:
4877           primary_id: true
4878           index:
4879           - inventory
4880       l3_interface_ipv6_prefix_length:
4881         description: Prefix length, 128 for single address
4882         type: long
4883       vlan_id_inner:
4884         description: Inner VLAN tag
4885         type: long
4886         annotations:
4887           index:
4888           - inventory
4889       vlan_id_outer:
4890         description: Outer VLAN tag
4891         type: long
4892       is_floating:
4893         description: Indicator of fixed or floating address
4894         type: boolean
4895       resource_version:
4896         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
4897         type: string
4898       neutron_network_id:
4899         description: Neutron network id of the interface that address belongs to
4900         type: string
4901         annotations:
4902           index:
4903           - inventory
4904       neutron_subnet_id:
4905         description: Neutron id of subnet that address belongs to
4906         type: string
4907         annotations:
4908           index:
4909           - inventory
4910       relationship_list:
4911         type: list
4912         entry_schema:
4913           type: org.openecomp.datatypes.inventory.Relationship
4914     requirements:
4915     - l3_network:
4916         capability: org.openecomp.capabilities.inventory.Composite
4917         node: org.openecomp.nodes.inventory.network.L3Network
4918         relationship: org.openecomp.relationships.inventory.MemberOf.network
4919         occurrences:
4920         - 0
4921         - UNBOUNDED
4922     - subnet:
4923         capability: org.openecomp.capabilities.inventory.Composite
4924         node: org.openecomp.nodes.inventory.Subnet
4925         relationship: org.openecomp.relationships.inventory.MemberOf.network
4926         occurrences:
4927         - 0
4928         - UNBOUNDED
4929     - l_interface:
4930         capability: org.openecomp.capabilities.inventory.Belonging
4931         node: org.openecomp.nodes.inventory.LInterface
4932         relationship: org.openecomp.relationships.inventory.BelongsTo
4933         occurrences:
4934         - 0
4935         - 1
4936         annotations:
4937           is_child: true
4938     - vlan:
4939         capability: org.openecomp.capabilities.inventory.Belonging
4940         node: org.openecomp.nodes.inventory.Vlan
4941         relationship: org.openecomp.relationships.inventory.BelongsTo
4942         occurrences:
4943         - 0
4944         - 1
4945         annotations:
4946           is_child: true
4947
4948   org.openecomp.nodes.inventory.network.L3Network:
4949     description: Generic network definition
4950     attributes:
4951       network_id:
4952         description: Network ID, should be uuid. Unique across A&AI.
4953         type: string
4954         annotations:
4955           primary_id: true
4956           unique:
4957           - inventory
4958           index:
4959           - inventory
4960           search:
4961           - inventory
4962       network_name:
4963         description: Name of the network, governed by some naming convention..
4964         type: string
4965         annotations:
4966           index:
4967           - inventory
4968           search:
4969           - inventory
4970           summary_property: true
4971       network_type:
4972         description: Type of the network - who defines these values?
4973         type: string
4974       network_role:
4975         description: Role the network plans - who defines these values?
4976         type: string
4977         annotations:
4978           index:
4979           - inventory
4980       network_technology:
4981         description: Network technology - who defines these values?
4982         type: string
4983       neutron_network_id:
4984         description: Neutron network id of this Interface
4985         type: string
4986       is_bound_to_vpn:
4987         description: Set to true if bound to VPN
4988         type: boolean
4989       service_id:
4990         description: Unique identifier of service from ASDC.  Does not strictly map to ASDC services.  SOON TO BE DEPRECATED
4991         type: string
4992         annotations:
4993           index:
4994           - inventory
4995       network_role_instance:
4996         description: network role instance
4997         type: long
4998       resource_version:
4999         description: Used for optimistic concurrency.  Must be empty on create, valid on update and delete.
5000         type: string
5001       orchestration_status:
5002         description: Orchestration status of this VNF, mastered by MSO
5003         type: string
5004       heat_stack_id:
5005         description: Heat stack id corresponding to this instance, managed by MSO
5006         type: string
5007         annotations:
5008           index:
5009           - inventory
5010       mso_catalog_key:
5011         description: Corresponds to the SDN-C catalog id used to configure this VCE
5012         type: string
5013       contrail_network_fqdn:
5014         description: Contrail FQDN for the network
5015         type: string
5016         annotations:
5017           index:
5018           - inventory
5019       persona_model_id:
5020         description: the ASDC model id for this resource or service model.
5021         type: string
5022         annotations:
5023           index:
5024           - inventory
5025       persona_model_version:
5026         description: the ASDC model version for this resource or service model.
5027         type: string
5028         annotations:
5029           index:
5030           - inventory
5031       persona_model_customization_id:
5032         description: captures the id of all the configuration used to customize the resource for the service.
5033         type: string
5034       widget_model_id:
5035         description: the ASDC data dictionary widget model. This maps directly to the A&AI widget.
5036         type: string
5037         annotations:
5038           index:
5039           - inventory
5040       widget_model_version:
5041         description: the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
5042         type: string
5043         annotations:
5044           index:
5045           - inventory
5046       physical_network_name:
5047         description: Name associated with the physical network.
5048         type: string
5049       is_provider_network:
5050         description: boolean indicatating whether or not network is a provider network.
5051         type: boolean
5052       is_shared_network:
5053         description: boolean indicatating whether or not network is a shared network.
5054         type: boolean
5055       is_external_network:
5056         description: boolean indicatating whether or not network is an external network.
5057         type: boolean
5058       selflink:
5059         description: Path to the controller object.
5060         type: string
5061       subnets:
5062         type: list
5063         entry_schema:
5064           type: org.openecomp.nodes.inventory.Subnet
5065       ctag_assignments:
5066         type: list
5067         entry_schema:
5068           type: org.openecomp.nodes.inventory.CtagAssignment
5069       segmentation_assignments:
5070         type: list
5071         entry_schema:
5072           type: org.openecomp.nodes.inventory.SegmentationAssignment
5073       relationship_list:
5074         description: Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
5075         type: list
5076         entry_schema:
5077           type: org.openecomp.datatypes.inventory.Relationship
5078     capabilities:
5079       allotted_resource:
5080         type: org.openecomp.capabilities.inventory.Allot
5081         valid_source_types:
5082         - org.openecomp.nodes.inventory.AllottedResource
5083       cloud_region:
5084         type: org.openecomp.capabilities.inventory.Multiuse
5085         valid_source_types:
5086         - org.openecomp.nodes.inventory.cloud.infrastructure.CloudRegion
5087       complex:
5088         type: org.openecomp.capabilities.inventory.Multiuse
5089         valid_source_types:
5090         - org.openecomp.nodes.inventory.cloud.infrastructure.Complex
5091       generic_vnf:
5092         type: org.openecomp.capabilities.inventory.Multiuse
5093         valid_source_types:
5094         - org.openecomp.nodes.inventory.network.GenericVnf
5095       l3_interface_ipv4_address_list:
5096         type: org.openecomp.capabilities.inventory.Composite
5097         valid_source_types:
5098         - org.openecomp.nodes.inventory.L3InterfaceIpv4AddressList
5099       l3_interface_ipv6_address_list:
5100         type: org.openecomp.capabilities.inventory.Composite
5101         valid_source_types:
5102         - org.openecomp.nodes.inventory.L3InterfaceIpv6AddressList
5103       ctag_assignment:
5104         type: org.openecomp.capabilities.inventory.Belonging
5105         valid_source_types:
5106         - org.openecomp.nodes.inventory.CtagAssignment
5107       segmentation_assignment:
5108         type: org.openecomp.capabilities.inventory.Belonging
5109         valid_source_types:
5110         - org.openecomp.nodes.inventory.SegmentationAssignment
5111       subnet:
5112         type: org.openecomp.capabilities.inventory.Belonging
5113         valid_source_types:
5114         - org.openecomp.nodes.inventory.Subnet
5115       service_instance:
5116         type: org.openecomp.capabilities.inventory.Composeable
5117         valid_source_types:
5118         - org.openecomp.nodes.inventory.ServiceInstance
5119       tenant:
5120         type: org.openecomp.capabilities.inventory.Multiuse
5121         valid_source_types:
5122         - org.openecomp.nodes.inventory.Tenant
5123       vf_module:
5124         type: org.openecomp.capabilities.inventory.Node
5125         valid_source_types:
5126         - org.openecomp.nodes.inventory.VfModule
5127     requirements:
5128     - network_policy:
5129         capability: org.openecomp.capabilities.inventory.Multiuse
5130         node: org.openecomp.nodes.inventory.network.NetworkPolicy
5131         relationship: org.openecomp.relationships.inventory.Uses
5132         occurrences:
5133         - 0
5134         - UNBOUNDED
5135     - route_table_reference:
5136         capability: org.openecomp.capabilities.inventory.Multiuse
5137         node: org.openecomp.nodes.inventory.network.RouteTableReference
5138         relationship: org.openecomp.relationships.inventory.Uses
5139         occurrences:
5140         - 0
5141         - UNBOUNDED
5142     - vpn_binding:
5143         capability: org.openecomp.capabilities.inventory.Multiuse
5144         node: org.openecomp.nodes.inventory.network.VpnBinding
5145         relationship: org.openecomp.relationships.inventory.Uses
5146         occurrences:
5147         - 0
5148         - UNBOUNDED