Graph Topology

The method takes the following arguments.

The topology objects can contain the following properties:

The method returns the following response.

Example function using the createTopologies method to create two topologies named "host" and "location":

function createTopologies()
{
    logger.warning("Creating topologies");
    var topo1 = 
    {
         name: "host",
         description: "Host-based topology",
         active: true
    }; 
    var topo2 = 
    {
         name: "location",
         description: "Location-based topology",
         active: true
    };
    var topologiesNotCreated = graphtopo.createTopologies([topo1, topo2]);  
    logger.warning("Returned object to string from createTopologies: " + JSON.stringify(topologiesNotCreated));
}

The method takes the following arguments.

The topology objects can contain the following properties:

The method returns the following response.

The request fails if any of the following are true:

Example function using the updateTopologies method to update the descriptions of two topologies named "host" and "location":

function updateTopologies()
{
    logger.warning("Updating topologies");
    var topo1 = 
    {
        name: "host",
        description: "Host-based network topology"
    }; 
    var topo2 = 
    {
        name: "location",
        description: "Location-based network topology"
    };
    var topologiesNotUpdated = graphtopo.updateTopologies([topo1, topo2]);  
    logger.warning("Returned object to string from updateTopologies: " + JSON.stringify(topologiesNotUpdated));
}

The method takes the following arguments.

The method returns the following response.

The request fails if name is being used to filter a Recipe, or does not exist.

Example function using the deleteTopology method to delete a topology named "host":

function deleteTopo(host) 
{    
    var deleteTopoResult = graphtopo.deleteTopology(host);    
    logger.warning("Returned object to string from deleteTopo: " + JSON.stringify(deleteTopoResult));
}

The method takes the following arguments.

The method returns the following response.

Example request using the getTopology method to retrieve a topology named "host":

var topology = graphtopo.getTopology(host);

The response object contains details of the "host" topology:

{
    name: "host", 
    description: "Host-based topology",
    active: true
}

The method takes no request arguments.

The method returns the following response.

Example request using the getActiveTopologies method to retrieve all active topologies:

var active = graphtopo.getActiveTopologies();

The response object contains details of all active topologies:

[
    {
        name: "host", 
        description: "Host-based topology",
        active: true
    },
    {
        name: "location", 
        description: "Location-based topology",
        active: true
    }
]

The method takes no request arguments.

The method returns the following response.

Example request using the getInactiveTopologies method to retrieve all inactive topologies:

var inactive = graphtopo.getInactiveTopologies();

The response object contains details of all inactive topologies:

[
    {
        name: "virtual", 
        description: "Virtual topology",
        active: false
    },
    {
        name: "physical", 
        description: "Physical topology",
        active: false
    }
]

The method takes the following arguments.

The method returns the following response.

Example request using the getTopologiesForSituation method to retrieve all topologies linked to Situation 12:

var situationtopos = graphtopo.getTopologiesForSituation(12);

The response object contains details of all linked topologies and their causal flags:

[
    {
        "name" : "host", 
        "causal" : true 
    }, 
    { 
        "name" : "location", 
        "causal" : false 
    }
]

The method takes the following arguments.

The method returns the following response.

Example function using the cloneTopology method to clone the "host" topology and name the clone "host_new":

function cloneTopology(host, host_new) 
{  
    logger.warning("Calling function cloneTopology for topo: [" + host + "] - new name will be: [" + host_new + "]");  
    var clonedTopology = graphtopo.cloneTopology(host, host_new);
    logger.warning("Returned object to string from cloneTopology: " + JSON.stringify(clonedTopology));
}

The response contains details of the "host_new" topology:

{ 
    "name" : "host_new", 
    "description" : "host-based topology",
    "active": false
}

The method takes the following arguments.

The topology object contains the following properties:

The method returns the following response.

The request fails if any of the following are true:

Example function using the replaceTopology method to replace the "host" topology with the "host_new" topology and set its status to active:

function replaceTopology(host, host_new) 
{  
    logger.warning("Calling function replaceTopology - topology to replace: [" + host + "], replacing topology: [" + host_new + "]");  
    var replacingTopology = { name: host_new, active: true };
    var replacedTopology = graphtopo.replaceTopology(host, replacing_topology);  
    logger.warning("Returned object to string from replaceTopology: " + JSON.stringify(replacedTopology));
}

In this example, if there is no topology named "host" the "host_new" topology is renamed "host".

The method takes the following arguments.

The node objects can contain the following properties:

The method returns the following response.

Example function using the createNodes method to create two nodes in the "host" topology named "node1" and "node2":

function createNodes()
{
    logger.warning("Creating nodes");
    var node1 = 
    {
        name: "node1",
        description: "First node"
    }; 
    var node2 = 
    {
        name: "node2",
        description: "Second node"
    };
    var nodesNotCreated = graphtopo.createNodes(host, [node1, node2]);  
    logger.warning("Returned object to string from createNodes: " + JSON.stringify(nodesNotCreated));
}

The method takes the following arguments.

The nodes objects can contain the following properties:

The method returns the following response.

Example function using the updateNodes method to update two nodes in the "host" topology named "node1" and "node2":

function updateNodes()
{
    logger.warning("Updating nodes");
    var node1 = 
    {
        name: "node1",
        description: "Primary node"
    }; 
    var node2 = 
    {
        name: "node2",
        description: "Secondary node"
    };
    var nodesNotUpdated = graphtopo.updateNodes(host, [node1, node2]);
    logger.warning("Returned object to string from updateNodes: " + JSON.stringify(nodesNotUpdated));
}

The method takes the following arguments.

The method returns the following response.

Example function using the deleteNodes method to delete two nodes in the "host" topology named "node1" and "node2":

function deleteNodes()
{
    logger.warning("Deleting nodes");
    var nodesNotDeleted = graphtopo.deleteNodes(host, ["node1", "node2"]);  
    logger.warning("Returned object to string from deleteNodes: " + JSON.stringify(nodesNotDeleted));
}

The method takes the following arguments.

The method returns the following response.

Example using the getNode method to return details of "node1" in the "host" topology.

var node1 = graphtopo.getNode("host", "node1");

The response object contains the node details:

{
    name: "node1", 
    description: "First node"
}

The method takes the following arguments.

The method returns the following response.

Example using the getAllNodes method to return details of all nodes in the "host" topology:

var allNodes = graphtopo.getAllNodes("host");

The response object contains details of the nodes in the "host" topology:

[
    {
        name: "node1", 
        description: First node
    },
    {
        name: "node2", 
        description: Second node
    }
]

The method takes the following arguments.

The method returns the following response.

Example using the isConnected method to check whether the "node1" node is in the "host" topology.

var isNodeInTopo = graphtopo.isConnected("host", "node1");

The method takes the following arguments.

The method returns the following response.

Example using the numberOfConnections method to return the number of connections from node "node1" in the "host" topology:

var return = topo.numberOfConnections("host", "node1");
logger.warning("numberOfConnections -> " + return);

This example logs the following message:

WARN : ... [CLogModule.java]:99 +|numberOfConnections -> 3|+

The method takes the following arguments.

The method returns the following response.

Example function using the distance method to calculate the number of hops between nodes "node1" and "node2" in the "host" topology:

function distance(host, node1, node2) 
{
    logger.warning("Calling function distance for topo: [" + host + "] and nodes: [" + node1 + "], [" + node2 + "]");
    var distance = graphtopo.distance(host, nost1, node2);
    logger.warning("Returned object to string from distance: " + JSON.stringify(distance));
}

The method takes the following arguments.

The method returns the following response.

Example function using the distance method to calculate the distance between nodes "node1" and "node2" in the "host" topology, where the number of hops is 5 or less:

function distance(host, node1, node2, 5.0) 
{
    logger.warning("Calling function distance (with max hops) for topo: [" + host + "] and nodes: [" + node1 + "], [" + node2 + "] and radius: [5.0]");
    var distanceWithMaxHops = graphtopo.distance(host, node1, node2, 5.0);
    logger.warning("Returned object to string from distance (with max hops): " + JSON.stringify(distance));
}

The method takes the following arguments.

The link objects can contain the following properties:

The method returns the following response.

Example function using the createLinks method to create links "node1" > "node2" and "node2" > "node3" in the "host" topology:

function createLinks()
{
    logger.warning("Creating links");
    var link1 = 
    {
        sourceNode: "node1",
        sinkNode: "node2",
        description: "link1"
   }; 
   var link2 = 
    {
        sourceNode: "node2",
        sinkNode: "node3",
        description: "link2"
   };
   var linksNotCreated = graphtopo.createLinks(host, [link1, link2]);  
   logger.warning("Returned object to string from createLinks: " + JSON.stringify(linksNotCreated));
}

The method takes the following arguments.

The method returns the following response.

Example using the getLink method to return details of the link between "node1" and "node2" in the "host" topology.

var linkdetails = graphtopo.getLink("host", "node1", "node2");

The response object contains the link details:

{
    description: "link1",
    sourceNode: "node1",
    sinkNode: "node2"
}

The method takes the following arguments.

The method returns the following response.

Example using the getAllLinksForTopology method to retrieve details of all links in the "host" topology:

var linkDetails = graphtopo.getAllLinksForTopology("host");

The response object contains details of the links:

[
    {
        description: "link1",
        sourceNode: "node1",
        sinkNode: "node2"
    },
    {
        description: "link2",
        sourceNode: "node2",
        sinkNode: "node3"
    }
]

The method takes the following arguments.

The method returns the following response.

Example using the getAllLinksForNode method to retrieve link details for the "node2" node in the "host" topology:

var linksForNode = graphtopo.getAllLinksForNode("host", "node2");

The response object contains details of the links:

[
    {
        description: "link1",
        sourceNode: "node2",
        sinkNode: "node1"
    },
    {
        description: "link2",
        sourceNode: "node2",
        sinkNode: "node3"
    }
]

The method takes the following arguments.

The method returns the following response.

Example using the deleteAllLinksForNode method to delete all links for the "node2" node in the "host" topology:

var deleteLinks = graphtopo.deleteAllLinksForNode("host", "node2");

The method takes the following arguments.

The link objects can contain the following properties:

The method returns the following response.

Example function using the deleteLinks method to delete two links in the "host" topology between "node1" ands "node2", and "node2" and "node3":

function deleteLinks()
{
    logger.warning("Deleting links");
    var link1 = 
    {
        sourceNode: "node1",
        sinkNode: "node2"
    }; 
    var link2 = 
    {
        sourceNode: "node2",
        sinkNode: "node3"
    };
    var linksNotDeleted = graphtopo.deleteLinks("host", [link1, link2]);  
    logger.warning("Returned object to string from deleteLinks: " + JSON.stringify(linksNotDeleted));
}