{"type":"doc","content":[{"type":"paragraph","content":[{"text":"","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Table of Contents","type":"text"}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"2"}},"macroMetadata":{"macroId":{"value":"388a2a8c-1a91-40ed-83fe-4ac6ef51f41e"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}}}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Introduction","type":"text"}]},{"type":"paragraph","content":[{"text":"A&AI (Active and Available Inventory) is implemented using a graph database. A graph database is an online database management system with Create, Read, Update and Delete (CRUD) operations working on a graph data model.","type":"text"}]},{"type":"paragraph","content":[{"text":"The A&AI REST API provides access to the A&AI active inventory graph. The API is largely configured off of models and configuration files. Each vertex in the graph has an API that can be called separately or, if part of a tree structure, as a nested element with one or more generations (parent, grandparent, etc.).","type":"text"}]},{"type":"paragraph","content":[{"text":"The edges of the graph are provisioned using a relationship list construct. For PUT methods, a relationship contains the vertex type or category (related-to) and a URI that provides the identity of the resource within A&AI. The URI can be used with the server root to call A&AI to get more details of the related resource but cannot be cached for long periods. (e.g., the version of the URI may get deprecated when the release changes).","type":"text"}]},{"type":"paragraph","content":[{"text":"The REST API describes each API that A&AI provides, independent of the caller of the API, therefore there is no information to be found here regarding the expectations on the callers. That information is conveyed in AID documents for each client. AIDs will describe the information expected from specific clients, but may not contain the full payloads that would be needed on an update. Please see the concurrency notes referenced below in order to do the right kind of PUTs (GET, replace just what you are changing, PUT) or use the PATCH capability.","type":"text"}]},{"type":"paragraph","content":[{"text":"Features of Release 10 can be found here: {needs link to A&AI document}","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"AAIService API","type":"text"}]},{"type":"rule"},{"type":"paragraph","content":[{"text":"AAIService is an implementation of a REST API client for SDNC-ADAPTORS feature. It exposes its CRUD services through ","type":"text"},{"text":"SvcLogicResource ","type":"text"},{"text":"interface.","type":"text"}]},{"type":"paragraph","content":[{"text":"The most common utilization of AAIService is done in SLI DirectedGraph","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"Below are snippets of working directed graph code.","type":"text"}]},{"type":"paragraph","content":[{"text":"Plugin","type":"text","marks":[{"type":"strong"}]},{"text":" simply tells DirectedGraph we want to use the AAIService so the value will always be the same for any nodes using AAIService.","type":"text"}]},{"type":"paragraph","content":[{"text":"Resource","type":"text","marks":[{"type":"strong"}]},{"text":" - is a node type identifier. In general It must match the name found in A&AI documentation (xsd or html file). When invoking search services, resource can be set to nodes-query or named-query.","type":"text"}]},{"type":"paragraph","content":[{"text":"Key","type":"text","marks":[{"type":"strong"}]},{"text":" is a set of name-value pairs identifying the node.","type":"text"}]},{"type":"paragraph","content":[{"text":"pfx","type":"text","marks":[{"type":"strong"}]},{"text":" is short for prefix. if data is being retrieved this is where AAIService will write the data to in context memory.","type":"text"}]},{"type":"paragraph","content":[{"text":"force","type":"text","marks":[{"type":"strong"}]},{"text":" and ","type":"text"},{"text":"local-only","type":"text","marks":[{"type":"strong"}]},{"text":" apply to some of the nodes. Values of these parameters are ignored in AAIService.","type":"text"},{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Create:","type":"text"}]},{"type":"paragraph","content":[{"text":"Save should be used when the caller wants to create a new resource in A&AI.","type":"text"}]},{"type":"codeBlock","content":[{"text":" \n\n\n\n\n\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Delete","type":"text"}]},{"type":"paragraph","content":[{"text":"Delete should be used when the caller wants to remove a resource in A&AI.","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Retrieve: ","type":"text"}]},{"type":"paragraph","content":[{"text":"Get-resource should be used when the caller wants to retrieve an existing resource from A&AI. The caller must pass the key of the resource. If the resource is a child the keys of the resource's parent must be passed as well.","type":"text"}]},{"type":"codeBlock","content":[{"text":"","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"update","type":"text"}]},{"type":"paragraph","content":[{"text":"Update should be used when the caller wants to update an existing resource in A&AI.","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n\n\n\n\n\n","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Understanding AAI Documentation","type":"text"}]},{"type":"rule"},{"type":"paragraph","content":[{"text":"Before you start defining path identifiers in the key, you need to download the document listing all paths in AAI. . If you don't have access to this community you may need to request it.","type":"text"}]},{"type":"paragraph","content":[{"text":"Two important document each DirectedGraph developer should become familiar with are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"the XSD document: {link is missing}","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"the AAI index document {link is missing}","type":"text"}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"The XSD document defines the AAI model.","type":"text"}]},{"type":"paragraph","content":[{"text":"The Index document lists all API paths supported.","type":"text"}]},{"type":"paragraph","content":[{"text":"When viewing these documents the viewer should be able to:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Identify the parent-child relationship among resources","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"See all of the possible attributes for a resource","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Identify the keys required for a given resource","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"AAIService is tightly coupled to the A&AI schema. By viewing the AAI schema you get both insight into A&AI as well as AAIService.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example of Using The HTML file","type":"text"}]},{"type":"paragraph","content":[{"text":"The v11_aai_index.html document lists paths supported by AAI REST API.","type":"text"}]},{"type":"mediaSingle","attrs":{"layout":"align-start"},"content":[{"type":"media","attrs":{"width":1024,"id":"b6a70a0b-9baa-43c1-bfdf-65a1e80b4975","collection":"contentId-16237213","type":"file","height":406}}]},{"type":"paragraph","content":[{"text":"The path may contain multiple nodes. Each node is identified by the node type and its primary id.","type":"text"}]},{"type":"paragraph","content":[{"text":"If we look at vserver we can see it has the attributes vserver-id, vserver-name, vserver-name2, etc.","type":"text"}]},{"type":"paragraph","content":[{"text":"Vserver is quite indented in this document. If it appears under another resource it is a child of that resource.","type":"text"}]},{"type":"paragraph","content":[{"text":"From looking at the document we should be able to see how the full path is constructed","type":"text"}]},{"type":"codeBlock","content":[{"text":"/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"How to select right resource for AAIService","type":"text"}]},{"type":"rule"},{"type":"paragraph","content":[{"text":"There are 3 types of resource names used by AAIService:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"name of the data type to be used by the request. Names of these types have to match the names of data types supported by AAI, as defined in AAI documentation, usually aai_schema_vX.xsd, where X represents the release number in AAI system. Examples are: generic-vnf, pserver, tenant, and so on.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Extended name for processing of relationship-list. It consists of the data type from item 1 appended with \":relationship-list\". This is used for adding/deleting relationship data to existing nodes.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Special functions: Currently there are 2 special functions: named-query and nodes-query.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"How to create the key string for AAIService","type":"text"}]},{"type":"rule"},{"type":"paragraph","content":[{"text":"The key string contains the identifiers of the elements in the path.","type":"text"}]},{"type":"paragraph","content":[{"text":"For example the path for generic-vnf looks as follows: /network/generic-vnfs/generic-vnf/{vnf-id}/. Each field enclosed in braces represents a key, so in this example {vnf-id}.","type":"text"}]},{"type":"paragraph","content":[{"text":"In the directed graph node the key needs to follow the format resource-name.resource-key. For this example attribute will appear as","type":"text"}]},{"type":"codeBlock","content":[{"text":"key=\"generic-vnf.vnf-id = '$Some-value'\"","type":"text"}]},{"type":"paragraph","content":[{"text":"Not that the key string does not use back ticks! Many developers think these are necessary and include them in error.","type":"text"}]},{"type":"paragraph","content":[{"text":"If you have a child resource its path will contain keys pertaining to its parent resources.","type":"text"}]},{"type":"paragraph","content":[{"text":"The path for vserver is below","type":"text"}]},{"type":"codeBlock","content":[{"text":"/cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}","type":"text"}]},{"type":"paragraph","content":[{"text":"In this case we have the following variables that need to be included in the key. They are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"cloud-owner","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"cloud-region-id","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"tenant-id","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"vserver-id","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Since we have to include resource name with the identifier, the keys will be looking as follows:cloud-owner","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"cloud-region.cloud-owner","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"cloud-region.cloud-region-id","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"tenant.tenant-id","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"vserver.vserver-id","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Below is an example of what this node might look like. Note that when multiple key fields are used they must be AND'ed together like below. (Note: use spaces around AND as well as around equal sign) ","type":"text"}]},{"type":"codeBlock","content":[{"text":"","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Special key names","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"selflink","type":"text"}]},{"type":"paragraph","content":[{"text":"In some situations the developer may know the path to the resource, for example after calling nodes-query, the response contains the resource type and resource link.","type":"text"},{"type":"hardBreak"},{"text":"To address such case, AAIService provides a special key name to be used to retrieve the data. The key name is 'selflink'. Developer can use returned resource-link to pass it to node.","type":"text"}]},{"type":"paragraph","content":[{"text":"The DG node to retrieve data using selflink is:","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"get-resource using selflink","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"depth","type":"text"}]},{"type":"paragraph","content":[{"text":"If you take for example the sub-paths starting with generic-vnf, user may not want to be retrieving full graphs that exists for an instance of generic-vnf, in which case retrieving the entire graph would be unnecessary but also may lead to straining the resources.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Path examples","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"/aai/v11/network/generic-vnfs/generic-vnf/{vnf-id} \n/aai/v11/network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id} \n/aai/v11/network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid} \n/aai/v11/network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid} \n/aai/v11/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}\n/aai/v11/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}\n/aai/v11/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface} \n/aai/v11/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id} \n/aai/v11/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address} \n/aai/v11/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address} \n/aai/v11/network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name} \n/aai/v11/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}\n/aai/v11/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}\n/aai/v11/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface} \n/aai/v11/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id} \n/aai/v11/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}\n/aai/v11/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}\n/aai/v11/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name} \n/aai/v11/network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name} \n ","type":"text"}]},{"type":"paragraph","content":[{"text":"To improve the performance of AAI database queries, the AAI system controls the amount of data being returned By default it will return the first layer or depth of zero layer, plus relationship list.","type":"text"}]},{"type":"paragraph","content":[{"text":"For users interested in getting sub-layers or data, AAI provides an option to specify the depth of the data to be returned. AAIService supports depth selection through key string. Simply add \" AND depth = 1 \" to the KEY string.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Using depth in DG node","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Difference between and ","type":"text"}]},{"type":"paragraph","content":[{"text":"When writing data the developer should understand the difference between and .","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" command creates a new data entry, It can be compared to SQL INSERT command. Use this command to write new data entry to AAI datastore..","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" command modifies the state of existing data entry. It can be compared to SQL UPDATE command. Use this command to modify/update existing data entry in AAI datastore..","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"It is critical to follow this rule as command will fail if the data entry with the same id already exists. ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#ff0000"}}]}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}