genericVnfs-fromPserver
- James Forsyth
Owned by James Forsyth
The "genericVnfs-fromPserver" query is a more efficient version of the vnfs-fromPserver query, and allows a client to provide A&AI with a pserver hostname and retrieve the generic-vnfs related to it. This query also supports pre-filtering the vnf results.
Input | Output | Users | Release(s) |
|---|---|---|---|
pserver optional vnfType, nfRole, nfNamingCode, and/or nfFunction | generic-vnfs | Casablanca |
Details
Example payloads
{
"start":["cloud-infrastructure/pservers?fqdn={fqdn}"],
"query":"query/genericVnfs-fromPserver?vnfType={vnf-type}&nfFunction={nf-function}"
}
OR
{
"start":["cloud-infrastructure/pservers?hostname={hostname}"],
"query":"query/genericVnfs-fromPserver?nfNamingCode={nf-naming-code}"
}The Traversal
Only objects at the end of a line will be returned.
pserver > generic-vnf
pserver > vserver > generic-vnfExample Output
{
"results": [
{
"id": "124981392",
"node-type": "generic-vnf",
"url": "/aai/v16/network/generic-vnfs/generic-vnf/71a31568-a2a8-4505-a303-d3a486ff24e5",
"properties": {
"vnf-id": "71a31568-a2a8-4505-a303-d3a486ff24e5",
"vnf-name": "US2929ORLFL0136UJDM06",
"vnf-type": "DM",
"service-id": "d7bb0a21-66f2-4e6d-87d9-9ef3ced63ae4",
"prov-status": "PROV",
"equipment-role": "EXAMPLE_SERVICE_SUBSCRIPTION",
"orchestration-status": "Activated",
"ipv4-oam-address": "12.80.1.17",
"nm-lan-v6-address": "2001:1890:e00e:fffe::dc01",
"vmemory-units": "",
"vdisk-units": "",
"in-maint": false,
"is-closed-loop-disabled": false,
"resource-version": "1518401336774",
"nm-profile-name": "EXAMPLE_PROFILE_NAME"
},
"related-to": [
{
"id": "280850472",
"relationship-label": "org.onap.relationships.inventory.ComposedOf",
"node-type": "service-instance",
"url": "/aai/v16/business/customers/customer/EXAMPLE_CUSTOMER/service-subscriptions/service-subscription/EXAMPLE_SERVICE_SUBSCRIPTION/service-instances/service-instance/12cc7627-cce5-4011-b342-1a3891017aba"
},
{
"id": "25850048",
"relationship-label": "tosca.relationships.HostedOn",
"node-type": "pserver",
"url": "/aai/v16/cloud-infrastructure/pservers/pserver/EXAMPLE_PSERVER"
}
]
},
{
"id": "141865152",
"node-type": "generic-vnf",
"url": "/aai/v16/network/generic-vnfs/generic-vnf/9efb0471-8f30-4f7f-9225-57778a2bcdef",
"properties": {
"vnf-id": "9efb0471-8f30-4f7f-9225-57778a2bcdef",
"vnf-name": "EXAMPLE_VNF_NAME",
"vnf-type": "HN",
"service-id": "ebc3bc3d-62fd-4a3f-a037-f619df4ff034",
"prov-status": "PROV",
"equipment-role": "EXAMPLE_SERVICE_SUBSCRIPTION",
"orchestration-status": "Activated",
"management-option": "OPAP",
"ipv4-oam-address": "10.1.2.3",
"nm-lan-v6-address": "::00",
"vcpu": 2,
"vmemory": 4,
"vmemory-units": "GB",
"vdisk": 8,
"vdisk-units": "GB",
"in-maint": false,
"is-closed-loop-disabled": false,
"resource-version": "1539267371623",
"nm-profile-name": "EXAMPLE_NM_PROFILE"
},
"related-to": [
{
"id": "29900944",
"relationship-label": "org.onap.relationships.inventory.ComposedOf",
"node-type": "service-instance",
"url": "/aai/v16/business/customers/customer/EXAMPLE_CUSTOMER/service-subscriptions/service-subscription/EXAMPLE_SERVICE_SUBSCRIPTION/service-instances/service-instance/9e288bd5-81c2-492a-87a1-1cb924ef3cd7"
},
{
"id": "53162112",
"relationship-label": "org.onap.relationships.inventory.BelongsTo",
"node-type": "entitlement",
"url": "/aai/v16/network/generic-vnfs/generic-vnf/9efb0471-8f30-4f7f-9225-57778a2bcdef/entitlements/entitlement/EXAMPLE_KEY1/EXAMPLE_KEY2"
},
{
"id": "178462760",
"relationship-label": "org.onap.relationships.inventory.BelongsTo",
"node-type": "entitlement",
"url": "/aai/v16/network/generic-vnfs/generic-vnf/9efb0471-8f30-4f7f-9225-57778a2bcdef/entitlements/entitlement/EXAMPLE_KEY3/EXAMPLE_KEY4"
},
{
"id": "83234944",
"relationship-label": "tosca.relationships.HostedOn",
"node-type": "vserver",
"url": "/aai/v16/cloud-infrastructure/cloud-regions/cloud-region/Cloud/Region/tenants/tenant/EXAMPLE_TENANT/vservers/vserver/0357c973-2d7b-4d1b-8282-3a67b9da0ff4"
},
{
"id": "118546544",
"relationship-label": "org.onap.relationships.inventory.Uses",
"node-type": "vnf-image",
"url": "/aai/v16/service-design-and-creation/vnf-images/vnf-image/937a2c2e-2bbd-4fe6-886c-e6b912bd718e"
}
]
},
{
"id": "27107488",
"node-type": "generic-vnf",
"url": "/aai/v16/network/generic-vnfs/generic-vnf/02d053c0-a2a0-4076-9c69-d09aad971e28",
"properties": {
"vnf-id": "02d053c0-a2a0-4076-9c69-d09aad971e28",
"vnf-name": "EXAMPLE_VNF_NAME2",
"vnf-type": "SW",
"service-id": "d7bb0a21-66f2-4e6d-87d9-9ef3ced63ae4",
"prov-status": "PROV",
"equipment-role": "EXAMPLE_SERVICE_SUBSCRIPTION",
"orchestration-status": "Activated",
"ipv4-oam-address": "10.11.12.13",
"nm-lan-v6-address": "::dc04",
"in-maint": false,
"is-closed-loop-disabled": false,
"resource-version": "1516639583782",
"nm-profile-name": "EXAMPLE_PROFILE_NAME"
},
"related-to": [
{
"id": "280850472",
"relationship-label": "org.onap.relationships.inventory.ComposedOf",
"node-type": "service-instance",
"url": "/aai/v16/business/customers/customer/EXAMPLE_CUSTOMER/service-subscriptions/service-subscription/EXAMPLE_SERVICE_SUBSCRIPTION/service-instances/service-instance/12cc7627-cce5-4011-b342-1a3891017aba"
},
{
"id": "185483392",
"relationship-label": "tosca.relationships.HostedOn",
"node-type": "vserver",
"url": "/aai/v16/cloud-infrastructure/cloud-regions/cloud-region/Cloud/Region/tenants/tenant/EXAMPLE_TENANT/vservers/vserver/b0bffe38-4cb7-44e5-913f-3a9790a59a6f"
}
]
},
{
"id": "110780608",
"node-type": "generic-vnf",
"url": "/aai/v16/network/generic-vnfs/generic-vnf/33621b1e-c32c-42b8-8e11-14ae51759363",
"properties": {
"vnf-id": "33621b1e-c32c-42b8-8e11-14ae51759363",
"vnf-name": "VNF_NAME3",
"vnf-type": "TE",
"service-id": "d7bb0a21-66f2-4e6d-87d9-9ef3ced63ae4",
"prov-status": "PROV",
"equipment-role": "EXAMPLE_SERVICE_SUBSCRIPTION",
"orchestration-status": "Activated",
"ipv4-oam-address": "10.15.16.17",
"nm-lan-v6-address": "::dc03",
"in-maint": false,
"is-closed-loop-disabled": false,
"resource-version": "1516639583080",
"nm-profile-name": "EXAMPLE_PROFILE2"
},
"related-to": [
{
"id": "280850472",
"relationship-label": "org.onap.relationships.inventory.ComposedOf",
"node-type": "service-instance",
"url": "/aai/v16/business/customers/customer/EXAMPLE_CUSTOMER/service-subscriptions/service-subscription/EXAMPLE_SERVICE_SUBSCRIPTION/service-instances/service-instance/12cc7627-cce5-4011-b342-1a3891017aba"
},
{
"id": "370032800",
"relationship-label": "tosca.relationships.HostedOn",
"node-type": "vserver",
"url": "/aai/v16/cloud-infrastructure/cloud-regions/cloud-region/Cloud/Region/tenants/tenant/EXAMPLE_TENANT_2/vservers/vserver/7675f45c-6eb7-4eb1-8a60-62761385d747"
},
{
"id": "60018832",
"relationship-label": "org.onap.relationships.inventory.Uses",
"node-type": "ipsec-configuration",
"url": "/aai/v16/network/ipsec-configurations/ipsec-configuration/61afcbc8-a8d2-4114-9d9f-8e4d603c1f59"
}
]
}
]
}