The "complex-fromVnf" query allows a client to provide A&AI a vnf name or ID to retrieve the generic-vnf, pserver, complex, licenses, and entitlements.

InputOutputUsersRelease(s)

vnf name

or

vnf ID

generic-vnf

pserver

complex

licenses

entitlements


Amsterdam


Details

Example payload

{
     "start":["network/generic-vnfs/generic-vnf/{vnfId}"],
     "query":"query/complex-fromVnf"
}

OR

 {
     "start":["network/generic-vnfs?vnf-name={vnfName}"],
     "query":"query/complex-fromVnf"
} 

The Traversal

Only objects at the end of a line will be returned.

generic-vnf
generic-vnf > pserver
generic-vnf > vserver > pserver
    pserver > complex

Example Output

{"results": [
   {"generic-vnf":    {
      "vnf-id": "c1b49390-435a-49bf-81f2-7a37c91452a3",
      "vnf-name": "VNF_NAME_1",
      "vnf-type": "WX",
      "service-id": "d7bb0a21-66f2-4e6d-87d9-9ef3ced63ae4",
      "equipment-role": "UCPE",
      "orchestration-status": "created",
      "management-option": "ONAP",
      "ipv4-oam-address": "",
      "ipv4-loopback0-address": "",
      "nm-lan-v6-address": "::a05",
      "management-v6-address": "",
      "vcpu": 4,
      "vmemory": 8,
      "vmemory-units": "GB",
      "vdisk": 150,
      "vdisk-units": "GB",
      "in-maint": false,
      "is-closed-loop-disabled": false,
      "resource-version": "1494001922009",
      "relationship-list": {"relationship":       [
                  {
            "related-to": "service-instance",
            "related-link": "https://aai.onap:8443/aai/v16/business/customers/customer/EXM/service-subscriptions/service-subscription/uCPE-VMS/service-instances/service-instance/VNF_NAME_2",
            "relationship-data":             [
                              {
                  "relationship-key": "customer.global-customer-id",
                  "relationship-value": "EXAMPLE_CUST1"
               },
                              {
                  "relationship-key": "service-subscription.service-type",
                  "relationship-value": "uCPE-VMS"
               },
                              {
                  "relationship-key": "service-instance.service-instance-id",
                  "relationship-value": "VNF_NAME_2"
               }
            ],
            "related-to-property": [{"property-key": "service-instance.service-instance-name"}]
         },
                  {
            "related-to": "vnf-image",
            "related-link": "https://aai.onap:8443/aai/v16/service-design-and-creation/vnf-images/vnf-image/7781e2bc-3a6a-4279-8cf0-6998a30c9a77",
            "relationship-data": [            {
               "relationship-key": "vnf-image.onap-uuid",
               "relationship-value": "7781e2bc-3a6a-4279-8cf0-6998a30c9a77"
            }]
         },
                  {
            "related-to": "vserver",
            "related-link": "https://aai.onap:8443/aai/v16/cloud-infrastructure/cloud-regions/cloud-region/CloudOwner/Region1/tenants/tenant/VNF_NAME_2%3A%3AuCPE-VMS/vservers/vserver/d5ce8415-bfa9-4852-b829-b64c087d3b49",
            "relationship-data":             [
                              {
                  "relationship-key": "cloud-region.cloud-owner",
                  "relationship-value": "CloudOwner"
               },
                              {
                  "relationship-key": "cloud-region.cloud-region-id",
                  "relationship-value": "Region1"
               },
                              {
                  "relationship-key": "tenant.tenant-id",
                  "relationship-value": "VNF_NAME_2::uCPE-VMS"
               },
                              {
                  "relationship-key": "vserver.vserver-id",
                  "relationship-value": "d5ce8415-bfa9-4852-b829-b64c087d3b49"
               }
            ],
            "related-to-property": [            {
               "property-key": "vserver.vserver-name",
               "property-value": "VNF_NAME_2-VNF_NAME_1"
            }]
         },
                  {
            "related-to": "license-key-resource",
            "related-link": "https://aai.onap:8443/aai/v16/license-management/license-key-resources/license-key-resource/113445755",
            "relationship-data": [            {
               "relationship-key": "license-key-resource.onap-uuid",
               "relationship-value": "113445755"
            }],
            "related-to-property": [            {
               "property-key": "license-key-resource.name",
               "property-value": "113445755"
            }]
         }
      ]}
   }},
   {"pserver":    {
      "hostname": "VNF_NAME_2",
      "equip-type": "JUNIPER UCPE",
      "equip-vendor": "JUNIPER",
      "equip-model": "QFX5100-24Q-AA",
      "ipv4-oam-address": "10.10.11.1",
      "serial-number": "STUWBZ100119",
      "pserver-id": "1C2B8D47-AFWZ-1604-0322-E2C41A07V119",
      "internet-topology": "WAN",
      "in-maint": false,
      "resource-version": "1494001823490",
      "relationship-list": {"relationship":       [
                  {
            "related-to": "vserver",
            "related-link": "https://aai.onap:8443/aai/v16/cloud-infrastructure/cloud-regions/cloud-region/CloudOwner/Region1/tenants/tenant/VNF_NAME_2%3A%3AuCPE-VMS/vservers/vserver/d5ce8415-bfa9-4852-b829-b64c087d3b49",
            "relationship-data":             [
                              {
                  "relationship-key": "cloud-region.cloud-owner",
                  "relationship-value": "CloudOwner"
               },
                              {
                  "relationship-key": "cloud-region.cloud-region-id",
                  "relationship-value": "Region1"
               },
                              {
                  "relationship-key": "tenant.tenant-id",
                  "relationship-value": "VNF_NAME_2::uCPE-VMS"
               },
                              {
                  "relationship-key": "vserver.vserver-id",
                  "relationship-value": "d5ce8415-bfa9-4852-b829-b64c087d3b49"
               }
            ],
            "related-to-property": [            {
               "property-key": "vserver.vserver-name",
               "property-value": "VNF_NAME_2-VNF_NAME_1"
            }]
         },
                  {
            "related-to": "vserver",
            "related-link": "https://aai.onap:8443/aai/v16/cloud-infrastructure/cloud-regions/cloud-region/CloudOwner/Region1/tenants/tenant/VNF_NAME_2%3A%3AuCPE-VMS/vservers/vserver/f5050a25-1b89-4e1b-bbc8-dd1acc70eea7",
            "relationship-data":             [
                              {
                  "relationship-key": "cloud-region.cloud-owner",
                  "relationship-value": "CloudOwner"
               },
                              {
                  "relationship-key": "cloud-region.cloud-region-id",
                  "relationship-value": "Region1"
               },
                              {
                  "relationship-key": "tenant.tenant-id",
                  "relationship-value": "VNF_NAME_2::uCPE-VMS"
               },
                              {
                  "relationship-key": "vserver.vserver-id",
                  "relationship-value": "f5050a25-1b89-4e1b-bbc8-dd1acc70eea7"
               }
            ],
            "related-to-property": [            {
               "property-key": "vserver.vserver-name",
               "property-value": "VNF_NAME_2-USISTUWBZNJ0119UJFW01"
            }]
         },
                  {
            "related-to": "generic-vnf",
            "related-link": "https://aai.onap:8443/aai/v16/network/generic-vnfs/generic-vnf/e2a13ed7-2760-4b51-bf1e-e0478e9e3e4a",
            "relationship-data": [            {
               "relationship-key": "generic-vnf.vnf-id",
               "relationship-value": "e2a13ed7-2760-4b51-bf1e-e0478e9e3e4a"
            }],
            "related-to-property": [            {
               "property-key": "generic-vnf.vnf-name",
               "property-value": "VNF_NAME_2"
            }]
         },
                  {
            "related-to": "vserver",
            "related-link": "https://aai.onap:8443/aai/v16/cloud-infrastructure/cloud-regions/cloud-region/CloudOwner/Region1/tenants/tenant/VNF_NAME_2%3A%3AuCPE-VMS/vservers/vserver/c7278b0e-e72e-4418-81d0-3fd9a1eb545c",
            "relationship-data":             [
                              {
                  "relationship-key": "cloud-region.cloud-owner",
                  "relationship-value": "CloudOwner"
               },
                              {
                  "relationship-key": "cloud-region.cloud-region-id",
                  "relationship-value": "Region1"
               },
                              {
                  "relationship-key": "tenant.tenant-id",
                  "relationship-value": "VNF_NAME_2::uCPE-VMS"
               },
                              {
                  "relationship-key": "vserver.vserver-id",
                  "relationship-value": "c7278b0e-e72e-4418-81d0-3fd9a1eb545c"
               }
            ],
            "related-to-property": [            {
               "property-key": "vserver.vserver-name",
               "property-value": "VNF_NAME_2-vjunos0"
            }]
         },
                  {
            "related-to": "vserver",
            "related-link": "https://aai.onap:8443/aai/v16/cloud-infrastructure/cloud-regions/cloud-region/CloudOwner/Region1/tenants/tenant/VNF_NAME_2%3A%3AuCPE-VMS/vservers/vserver/12f3e6e0-bfc2-45dc-a05e-6df069accb55",
            "relationship-data":             [
                              {
                  "relationship-key": "cloud-region.cloud-owner",
                  "relationship-value": "CloudOwner"
               },
                              {
                  "relationship-key": "cloud-region.cloud-region-id",
                  "relationship-value": "Region1"
               },
                              {
                  "relationship-key": "tenant.tenant-id",
                  "relationship-value": "VNF_NAME_2::uCPE-VMS"
               },
                              {
                  "relationship-key": "vserver.vserver-id",
                  "relationship-value": "12f3e6e0-bfc2-45dc-a05e-6df069accb55"
               }
            ],
            "related-to-property": [            {
               "property-key": "vserver.vserver-name",
               "property-value": "VNF_NAME_2-vsrx"
            }]
         },
                  {
            "related-to": "complex",
            "related-link": "https://aai.onap:8443/aai/v16/cloud-infrastructure/complexes/complex/PHYSICAL_LOCATION_ID_1",
            "relationship-data": [            {
               "relationship-key": "complex.physical-location-id",
               "relationship-value": "PHYSICAL_LOCATION_ID_1"
            }]
         }
      ]},
      "p-interfaces": {"p-interface":       [
                  {
            "interface-name": "ge-0/2/0",
            "speed-value": "1000",
            "speed-units": "Mbps",
            "port-description": "AVPN",
            "resource-version": "1494002033870"
         },
                  {
            "interface-name": "ge-0/2/1",
            "speed-value": "1000",
            "speed-units": "Mbps",
            "port-description": "MIS",
            "resource-version": "1494002037810",
            "relationship-list": {"relationship": [            {
               "related-to": "physical-link",
               "related-link": "https://aai.onap:8443/aai/v16/network/physical-links/physical-link/DUMMY.160420.104.ATI",
               "relationship-data": [               {
                  "relationship-key": "physical-link.link-name",
                  "relationship-value": "DUMMY.160420.104.ATI"
               }]
            }]}
         }
      ]}
   }},
   {"complex":    {
      "physical-location-id": "PHYSICAL_LOCATION_ID_1",
      "resource-version": "1494215074346",
      "physical-location-type": "EQUIPMENT LOCATION",
      "street1": "123 Example Street ",
      "city": "Example",
      "state": "CA",
      "postal-code": "90210",
      "country": "USA",
      "region": "US",
      "latitude": "30.39596",
      "longitude": "-94.135342",
      "relationship-list": {"relationship":       [
                  {
            "related-to": "pserver",
            "related-link": "https://aai.onap:8443/aai/v16/cloud-infrastructure/pservers/pserver/PSERVER_NAME_1",
            "relationship-data": [            {
               "relationship-key": "pserver.hostname",
               "relationship-value": "PSERVER_NAME_1"
            }],
            "related-to-property": [{"property-key": "pserver.pserver-name2"}]
         },
                  {
            "related-to": "pserver",
            "related-link": "https://aai.onap:8443/aai/v16/cloud-infrastructure/pservers/pserver/PSERVER_NAME_2",
            "relationship-data": [            {
               "relationship-key": "pserver.hostname",
               "relationship-value": "PSERVER_NAME_2"
            }],
            "related-to-property": [{"property-key": "pserver.pserver-name2"}]
         }
      ]}
   }}
]}