Skip to end of metadata
Go to start of metadata

See also POMBA Casablanca Model

Class Diagram





Dublin POMBA common model corresponds to v13 of A&AI API schema

Swagger Model


POMBA Context Builder API static swagger specification  -  POMBA Common Model.html


Common Model Schema
{
  "service": {
    "uuid": "string",
    "name": "string",
    "modelVersionID": "string",
    "modelInvariantUUID": "string",
    "dataQuality": {
      "status": "ok",
      "errorText": "string"
    },
    "attributes": [
      {
        "name": "adminStatus",
        "value": "string",
        "dataQuality": {
          "status": "ok",
          "errorText": "string"
        }
      }
    ]
  },
  "dataQuality": {
    "status": "ok",
    "errorText": "string"
  },
  "networkList": [
    {
      "uuid": "string",
      "name": "string",
      "modelVersionID": "string",
      "modelInvariantUUID": "string",
      "dataQuality": {
        "status": "ok",
        "errorText": "string"
      },
      "networkPolicies": [
        {
          "uuid": "string",
          "name": "string",
          "dataQuality": {
            "status": "ok",
            "errorText": "string"
          },
          "attributes": [
            {
              "name": "adminStatus",
              "value": "string",
              "dataQuality": {
                "status": "ok",
                "errorText": "string"
              }
            }
          ]
        }
      ],
      "attributes": [
        {
          "name": "adminStatus",
          "value": "string",
          "dataQuality": {
            "status": "ok",
            "errorText": "string"
          }
        }
      ]
    }
  ],
  "attributes": [
    {
      "name": "adminStatus",
      "value": "string",
      "dataQuality": {
        "status": "ok",
        "errorText": "string"
      }
    }
  ],
  "vnfs": [
    {
      "uuid": "string",
      "name": "string",
      "type": "string",
      "modelVersionID": "string",
      "modelInvariantUUID": "string",
      "dataQuality": {
        "status": "ok",
        "errorText": "string"
      },
      "vfModules": [
        {
          "uuid": "string",
          "name": "string",
          "modelVersionID": "string",
          "modelInvariantUUID": "string",
          "modelCustomizationUUID": "string",
          "maxInstances": 0,
          "minInstances": 0,
          "dataQuality": {
            "status": "ok",
            "errorText": "string"
          },
          "vms": [
            {
              "uuid": "string",
              "name": "string",
              "dataQuality": {
                "status": "ok",
                "errorText": "string"
              },
              "attributes": [
                {
                  "name": "adminStatus",
                  "value": "string",
                  "dataQuality": {
                    "status": "ok",
                    "errorText": "string"
                  }
                }
              ],
              "pserver": {
                "uuid": "string",
                "name": "string",
                "dataQuality": {
                  "status": "ok",
                  "errorText": "string"
                },
                "logicalLinkList": [
                  {
                    "uuid": "string",
                    "name": "string",
                    "modelVersionID": "string",
                    "modelInvariantUUID": "string",
                    "dataQuality": {
                      "status": "ok",
                      "errorText": "string"
                    },
                    "attributes": [
                      {
                        "name": "adminStatus",
                        "value": "string",
                        "dataQuality": {
                          "status": "ok",
                          "errorText": "string"
                        }
                      }
                    ]
                  }
                ],
                "attributes": [
                  {
                    "name": "adminStatus",
                    "value": "string",
                    "dataQuality": {
                      "status": "ok",
                      "errorText": "string"
                    }
                  }
                ],
                "pinterfaceList": [
                  {
                    "uuid": "string",
                    "name": "string",
                    "dataQuality": {
                      "status": "ok",
                      "errorText": "string"
                    },
                    "physicalLinkList": [
                      {
                        "uuid": "string",
                        "name": "string",
                        "dataQuality": {
                          "status": "ok",
                          "errorText": "string"
                        },
                        "attributes": [
                          {
                            "name": "adminStatus",
                            "value": "string",
                            "dataQuality": {
                              "status": "ok",
                              "errorText": "string"
                            }
                          }
                        ]
                      }
                    ],
                    "port": {
                      "uuid": "string",
                      "name": "string",
                      "dataQuality": {
                        "status": "ok",
                        "errorText": "string"
                      },
                      "attributes": [
                        {
                          "name": "adminStatus",
                          "value": "string",
                          "dataQuality": {
                            "status": "ok",
                            "errorText": "string"
                          }
                        }
                      ]
                    },
                    "attributes": [
                      {
                        "name": "adminStatus",
                        "value": "string",
                        "dataQuality": {
                          "status": "ok",
                          "errorText": "string"
                        }
                      }
                    ]
                  }
                ]
              },
              "linterfaceList": [
                {
                  "uuid": "string",
                  "name": "string",
                  "dataQuality": {
                    "status": "ok",
                    "errorText": "string"
                  },
                  "port": {
                    "uuid": "string",
                    "name": "string",
                    "dataQuality": {
                      "status": "ok",
                      "errorText": "string"
                    },
                    "attributes": [
                      {
                        "name": "adminStatus",
                        "value": "string",
                        "dataQuality": {
                          "status": "ok",
                          "errorText": "string"
                        }
                      }
                    ]
                  },
                  "attributes": [
                    {
                      "name": "adminStatus",
                      "value": "string",
                      "dataQuality": {
                        "status": "ok",
                        "errorText": "string"
                      }
                    }
                  ]
                }
              ]
            }
          ],
          "networks": [
            {
              "uuid": "string",
              "name": "string",
              "modelVersionID": "string",
              "modelInvariantUUID": "string",
              "dataQuality": {
                "status": "ok",
                "errorText": "string"
              },
              "networkPolicies": [
                {
                  "uuid": "string",
                  "name": "string",
                  "dataQuality": {
                    "status": "ok",
                    "errorText": "string"
                  },
                  "attributes": [
                    {
                      "name": "adminStatus",
                      "value": "string",
                      "dataQuality": {
                        "status": "ok",
                        "errorText": "string"
                      }
                    }
                  ]
                }
              ],
              "attributes": [
                {
                  "name": "adminStatus",
                  "value": "string",
                  "dataQuality": {
                    "status": "ok",
                    "errorText": "string"
                  }
                }
              ]
            }
          ],
          "attributes": [
            {
              "name": "adminStatus",
              "value": "string",
              "dataQuality": {
                "status": "ok",
                "errorText": "string"
              }
            }
          ]
        }
      ],
      "vnfcs": [
        {
          "uuid": "string",
          "name": "string",
          "modelVersionID": "string",
          "modelInvariantUUID": "string",
          "dataQuality": {
            "status": "ok",
            "errorText": "string"
          },
          "attributes": [
            {
              "name": "adminStatus",
              "value": "string",
              "dataQuality": {
                "status": "ok",
                "errorText": "string"
              }
            }
          ]
        }
      ],
      "networks": [
        {
          "uuid": "string",
          "name": "string",
          "modelVersionID": "string",
          "modelInvariantUUID": "string",
          "dataQuality": {
            "status": "ok",
            "errorText": "string"
          },
          "networkPolicies": [
            {
              "uuid": "string",
              "name": "string",
              "dataQuality": {
                "status": "ok",
                "errorText": "string"
              },
              "attributes": [
                {
                  "name": "adminStatus",
                  "value": "string",
                  "dataQuality": {
                    "status": "ok",
                    "errorText": "string"
                  }
                }
              ]
            }
          ],
          "attributes": [
            {
              "name": "adminStatus",
              "value": "string",
              "dataQuality": {
                "status": "ok",
                "errorText": "string"
              }
            }
          ]
        }
      ],
      "attributes": [
        {
          "name": "adminStatus",
          "value": "string",
          "dataQuality": {
            "status": "ok",
            "errorText": "string"
          }
        }
      ]
    }
  ],
  "pnfs": [
    {
      "uuid": "string",
      "name": "string",
      "modelVersionID": "string",
      "modelInvariantUUID": "string",
      "dataQuality": {
        "status": "ok",
        "errorText": "string"
      },
      "attributes": [
        {
          "name": "adminStatus",
          "value": "string",
          "dataQuality": {
            "status": "ok",
            "errorText": "string"
          }
        }
      ]
    }
  ]
}

  • No labels

6 Comments

    • Network has direct relationships with PNFs and physical links
    • PNF has direct relationship with p-interfaces and l-interfaces
    1. To avoid loops, we could have one set of relationships for each tree root.

    2. Curious to know what is the relationship between the POMBA Common Model and the AAI schema? There seems to be an overlap in these object definitions and relationships.

      Added item for discussion on 2018-11-15 AAI Developers Meeting

  1. POMBA is a client of AAI APIs. It retrieves certain objects from AAI and transforms it into POMBA COMMON model which is aimed to represent flat structure of service instance representation.

    It is true that AAI schema is primary source for POMBA common model and therefore there is an overlap, but in general POMBA common model represents the superset of the all various objects and their relationships that are available from different orchestration platform components, such as SDC, SDN-C, A&AI , openstack and etc...


    1. Thanks Geora! Sharon also left a message on the AAI Developers to the same effect. We are having discussions about the AAI Schema Services with a view to future dynamic schema updates, e.g. via SDC modelling, so we are interested in the downstream impacts of such a change.


  2. The model diagram and swagger spec currently contains loops.

    It will need to be properly handled in the context of the flow, depends on the initiation root