Get Test Parameters

This API is valid only when at least one test is running. It returns data which includes shape IDs, end points etc. per test.

Get Test Parameters Aggregated by Shape

Request

URL http://ip:port/shunra/api/emulation/parameters/byshape/{testToken}
HTTP Method GET
HTTP Headers

Content-Type: application/json

Accept: application/json

Authorization: See Web Services Authentication.

Body None

Response

The Response includes the HTTP body in JSON format which holds the requested info.

HTTP Response Code

204 - No Content in case no emulation is running

200 - OK

HTTP Headers Content-Type: application/json; charset=UTF-8
HTTP Body
"parameters": {
    [{
        "userId": "admin",
        "emulationEngine": {
            "SERVER2008R2SP1": {
                "emulationParameters": {
                    "0c9fbd86-cd3f-46a3-aff7-6cd876b2ed2a70a89f3f-f2ad-4df8-a263-d7e4317ddfb7": {
                        "shapesIdentificationCollection": [{
                            "id": "ID_CLIENT",
                            "type": "ENDPOINT",
                            "name": "Client"
                        }, {
                            "id": "ID_SERVER",
                            "type": "ENDPOINT",
                            "name": "Server"
                        }, {
                            "id": "ID_CLIENT_GW",
                            "type": "GATEWAY",
                            "name": "Client Gateway"
                        }, {
                            "id": "ID_CLIENT_GW_NIC_1",
                            "type": "NIC",
                            "name": "Clent Uplink"
                        }, {
                            "id": "ID_CLIENT_GW_NIC_2",
                            "type": "NIC",
                            "name": "Clent Downlink"
                        }, {
                            "id": "ID_SERVER_GW",
                            "type": "GATEWAY",
                            "name": "Server Gateway"
                        }, {
                            "id": "ID_SERVER_GW_NIC_1",
                            "type": "NIC",
                            "name": "Server Downlink"
                        }, {
                            "id": "ID_SERVER_GW_NIC_2",
                            "type": "NIC",
                            "name": "Server Uplink"
                        }, {
                            "id": "ID_WAN_CLOUD",
                            "type": "WAN_CLOUD",
                            "name": "Wan"
                        }],
                        "endpointsCollection": [{
                            "id": "ID_CLIENT",
                            "name": "Client",
                            "includeIpRanges": [],
                            "excludeIpRanges": []
                        }, {
                            "id": "ID_SERVER",
                            "name": "Server",
                            "includeIpRanges": [],
                            "excludeIpRanges": []
                        }],
                        "emulationName": "VE DesktopProfessional Sample",
                        "executingNtx": "<NETWOR_X> .....</NETWOR_X>"
                    }
                }
            }
        }
    }]
}

Get Test Parameters Aggregated by Flow

Request

URL http://ip:port/shunra/api/emulation/parameters/byflow/{testToken}
HTTP Method GET
HTTP Headers

Content-Type: application/json

Accept: application/json

Authorization: See Web Services Authentication.

Body None

Response

The Response includes the HTTP body in JSON format which holds the requested information.

HTTP Response Code

204 - No Content in case no emulation is running

200 - OK

HTTP Headers Content-Type: application/json; charset=UTF-8
HTTP Body
{
    "parameters": [{
        "userId": "admin",
        "emulationEngine": {
            "SERVER2008R2SP1": {
                "emulationParameters": {
                    "bb224830-3d38-4579-b84b-8b6264d8efbd39572dcd-413e-40c5-ba46-c2fadd65f777": {
                        "flowsParams": {
                            "FLOWS_10": {
                                "shapesIdentificationCollection": [{
                                    "id": "ID_WAN_CLOUD_FLOWS_10",
                                    "type": "WAN_CLOUD",
                                    "name": "Wan"
                                }, {
                                    "id": "ID_CLIENT_GW_FLOWS_10",
                                    "type": "GATEWAY",
                                    "name": "Clientgateway"
                                }, {
                                    "id": "ID_CLIENT_GW__NIC_1_FLOWS_10",
                                    "type": "NIC",
                                    "name": "ClientUplink"
                                }, {
                                    "id": "ID_CLIENT_GW__NIC_2_FLOWS_10",
                                    "type": "NIC",
                                    "name": "ClientDownlink"
                                }, {
                                    "id": "ID_SERVER_GW_FLOWS_10",
                                    "type": "GATEWAY",
                                    "name": "Servergateway"
                                }, {
                                    "id": "ID_SERVER_GW__NIC_2_FLOWS_10",
                                    "type": "NIC",
                                    "name": "ServerDownlink"
                                }, {
                                    "id": "ID_SERVER_GW__NIC_1_FLOWS_10",
                                    "type": "NIC",
                                    "name": "ServerUplink"
                                }, {
                                    "id": "ID_CLIENT_FLOWS_10",
                                    "type": "ENDPOINT",
                                    "name": "Client"
                                }, {
                                    "id": "ID_SERVER_FLOWS_10",
                                    "type": "ENDPOINT",
                                    "name": "Server"
                                }, {
                                    "id": "ID_PACKET_LIST_CLIENT_FLOWS_10",
                                    "type": "PACKET_LIST",
                                    "name": "PACKET_LIST_CLIENT_FLOWS_10"
                                }],
                                "endpointsCollection": [{
                                    "id": "ID_CLIENT_FLOWS_10",
                                    "name": "Client",
                                    "includeIpRanges": [{
                                        "from": "172.30.1.1",
                                        "to": "172.30.254.254",
                                        "port": 0,
                                        "protocol": 0
                                    }],
                                    "excludeIpRanges": []
                                }, {
                                    "id": "ID_SERVER_FLOWS_10",
                                    "name": "Server",
                                    "includeIpRanges": [{
                                        "from": "50.50.50.19",
                                        "to": "50.50.50.19",
                                        "port": 0,
                                        "protocol": 0
                                    }],
                                    "excludeIpRanges": []
                                }],
                                "isDefaultModeFlow": false
                            }
                        },
                        "emulationName": "VE DesktopProfessional Sample",
                        "executingNtx": "<NETWOR_X>... </NETWOR_X>"
                    }
                }
            }
        }
    }]
}