Teone | 620bafd | 2016-04-18 14:39:41 -0700 | [diff] [blame] | 1 | FORMAT: 1A |
| 2 | |
| 3 | # XOS |
| 4 | |
| 5 | |
Matteo Scandolo | b71510b | 2016-04-29 09:56:48 -0700 | [diff] [blame] | 6 | # Group Deployments |
| 7 | |
| 8 | List of the XOS deployments |
| 9 | |
| 10 | ## Deployments [/api/core/deployments/{id}/] |
| 11 | |
| 12 | ### List all deployments [GET] |
| 13 | |
| 14 | + Response 200 (application/json) |
| 15 | |
Matteo Scandolo | d5f3d05 | 2016-05-02 15:29:37 -0700 | [diff] [blame] | 16 | [ |
| 17 | { |
| 18 | "humanReadableName": "MyDeployment", |
| 19 | "id": 1, |
| 20 | "created": "2016-04-29T16:19:03.549901Z", |
| 21 | "updated": "2016-04-29T16:19:05.624151Z", |
| 22 | "enacted": null, |
| 23 | "policed": null, |
| 24 | "backend_register": "{}", |
| 25 | "backend_status": "0 - Provisioning in progress", |
| 26 | "deleted": false, |
| 27 | "write_protect": false, |
| 28 | "lazy_blocked": false, |
| 29 | "no_sync": true, |
| 30 | "name": "MyDeployment", |
| 31 | "accessControl": "allow all", |
| 32 | "images": [ |
| 33 | "1" |
| 34 | ], |
| 35 | "sites": [ |
| 36 | "1" |
| 37 | ], |
| 38 | "flavors": [ |
| 39 | "1", |
| 40 | "2", |
| 41 | "3" |
| 42 | ], |
| 43 | "dashboardviews": [ |
| 44 | "1" |
| 45 | ] |
| 46 | } |
| 47 | ] |
| 48 | |
Matteo Scandolo | 631b481 | 2016-05-02 15:51:34 -0700 | [diff] [blame^] | 49 | ### Create a deployment [POST] |
| 50 | |
| 51 | + Response 200 (application/json) |
| 52 | |
| 53 | { |
| 54 | "humanReadableName": "MyDeployment", |
| 55 | "id": 1, |
| 56 | "created": "2016-04-29T16:19:03.549901Z", |
| 57 | "updated": "2016-04-29T16:19:05.624151Z", |
| 58 | "enacted": null, |
| 59 | "policed": null, |
| 60 | "backend_register": "{}", |
| 61 | "backend_status": "0 - Provisioning in progress", |
| 62 | "deleted": false, |
| 63 | "write_protect": false, |
| 64 | "lazy_blocked": false, |
| 65 | "no_sync": true, |
| 66 | "name": "MyDeployment", |
| 67 | "accessControl": "allow all", |
| 68 | "images": [ |
| 69 | "1" |
| 70 | ], |
| 71 | "sites": [ |
| 72 | "1" |
| 73 | ], |
| 74 | "flavors": [ |
| 75 | "1", |
| 76 | "2", |
| 77 | "3" |
| 78 | ], |
| 79 | "dashboardviews": [ |
| 80 | "1" |
| 81 | ] |
| 82 | } |
| 83 | |
Matteo Scandolo | d5f3d05 | 2016-05-02 15:29:37 -0700 | [diff] [blame] | 84 | ### View a Deployment Detail [GET] |
| 85 | |
| 86 | + Parameters |
| 87 | + id: 1 (number) - ID of the Deployment in the form of an integer |
| 88 | |
| 89 | + Response 200 (application/json) |
| 90 | |
Matteo Scandolo | b71510b | 2016-04-29 09:56:48 -0700 | [diff] [blame] | 91 | { |
| 92 | "humanReadableName": "MyDeployment", |
| 93 | "id": 1, |
Matteo Scandolo | d5f3d05 | 2016-05-02 15:29:37 -0700 | [diff] [blame] | 94 | "created": "2016-04-27T21:46:57.354544Z", |
| 95 | "updated": "2016-04-27T21:47:05.221720Z", |
Matteo Scandolo | b71510b | 2016-04-29 09:56:48 -0700 | [diff] [blame] | 96 | "enacted": null, |
| 97 | "policed": null, |
| 98 | "backend_register": "{}", |
| 99 | "backend_status": "0 - Provisioning in progress", |
| 100 | "deleted": false, |
| 101 | "write_protect": false, |
| 102 | "lazy_blocked": false, |
| 103 | "no_sync": true, |
| 104 | "name": "MyDeployment", |
| 105 | "accessControl": "allow all", |
Matteo Scandolo | d5f3d05 | 2016-05-02 15:29:37 -0700 | [diff] [blame] | 106 | "images": [], |
Matteo Scandolo | b71510b | 2016-04-29 09:56:48 -0700 | [diff] [blame] | 107 | "sites": [ |
| 108 | "1" |
| 109 | ], |
| 110 | "flavors": [ |
Matteo Scandolo | d5f3d05 | 2016-05-02 15:29:37 -0700 | [diff] [blame] | 111 | "3", |
Matteo Scandolo | b71510b | 2016-04-29 09:56:48 -0700 | [diff] [blame] | 112 | "2", |
Matteo Scandolo | d5f3d05 | 2016-05-02 15:29:37 -0700 | [diff] [blame] | 113 | "1" |
Matteo Scandolo | b71510b | 2016-04-29 09:56:48 -0700 | [diff] [blame] | 114 | ], |
| 115 | "dashboardviews": [ |
Matteo Scandolo | d5f3d05 | 2016-05-02 15:29:37 -0700 | [diff] [blame] | 116 | "3" |
Matteo Scandolo | b71510b | 2016-04-29 09:56:48 -0700 | [diff] [blame] | 117 | ] |
| 118 | } |
Matteo Scandolo | d5f3d05 | 2016-05-02 15:29:37 -0700 | [diff] [blame] | 119 | |
Matteo Scandolo | 631b481 | 2016-05-02 15:51:34 -0700 | [diff] [blame^] | 120 | ### Delete a Deployment [DELETE] |
| 121 | |
| 122 | + Parameters |
| 123 | + id: 1 (number) - ID of the Deployment in the form of an integer |
| 124 | |
| 125 | + Response 204 |
Matteo Scandolo | b71510b | 2016-04-29 09:56:48 -0700 | [diff] [blame] | 126 | |
| 127 | |
| 128 | # Group Flavors |
| 129 | |
| 130 | List of the XOS flavors |
| 131 | |
| 132 | ## Flavors [/api/core/flavors/{id}/] |
| 133 | |
| 134 | ### List all flavors [GET] |
| 135 | |
| 136 | + Response 200 (application/json) |
| 137 | |
| 138 | [ |
| 139 | { |
| 140 | "humanReadableName": "m1.large", |
| 141 | "id": 1, |
| 142 | "created": "2016-04-29T16:19:01.979548Z", |
| 143 | "updated": "2016-04-29T16:19:03.568238Z", |
| 144 | "enacted": null, |
| 145 | "policed": null, |
| 146 | "backend_register": "{}", |
| 147 | "backend_status": "0 - Provisioning in progress", |
| 148 | "deleted": false, |
| 149 | "write_protect": false, |
| 150 | "lazy_blocked": false, |
| 151 | "no_sync": true, |
| 152 | "name": "m1.large", |
| 153 | "description": null, |
| 154 | "flavor": "m1.large", |
| 155 | "order": 0, |
| 156 | "default": false, |
| 157 | "deployments": [ |
| 158 | "1" |
| 159 | ] |
| 160 | } |
| 161 | ] |
| 162 | |
| 163 | ### View a Flavors Detail [GET] |
| 164 | |
| 165 | + Parameters |
| 166 | + id: 1 (number) - ID of the Flavors in the form of an integer |
| 167 | |
| 168 | + Response 200 (application/json) |
| 169 | |
| 170 | { |
| 171 | "humanReadableName": "m1.large", |
| 172 | "id": 1, |
| 173 | "created": "2016-04-29T16:19:01.979548Z", |
| 174 | "updated": "2016-04-29T16:19:03.568238Z", |
| 175 | "enacted": null, |
| 176 | "policed": null, |
| 177 | "backend_register": "{}", |
| 178 | "backend_status": "0 - Provisioning in progress", |
| 179 | "deleted": false, |
| 180 | "write_protect": false, |
| 181 | "lazy_blocked": false, |
| 182 | "no_sync": true, |
| 183 | "name": "m1.large", |
| 184 | "description": null, |
| 185 | "flavor": "m1.large", |
| 186 | "order": 0, |
| 187 | "default": false, |
| 188 | "deployments": [ |
| 189 | "1" |
| 190 | ] |
| 191 | } |
| 192 | |
| 193 | |
| 194 | # Group Instances |
| 195 | |
| 196 | List of the XOS instances |
| 197 | |
| 198 | ## Instances [/api/core/instances/{id}/] |
| 199 | |
| 200 | ### List all Instances [GET] |
| 201 | |
| 202 | + Response 200 (application/json) |
| 203 | |
| 204 | [ |
| 205 | { |
| 206 | "id": 1, |
| 207 | "humanReadableName": "uninstantiated-1", |
| 208 | "created": "2016-04-26T00:36:22.465259Z", |
| 209 | "updated": "2016-04-26T00:36:22.465288Z", |
| 210 | "enacted": null, |
| 211 | "policed": null, |
| 212 | "backend_register": "{}", |
| 213 | "backend_status": "0 - Provisioning in progress", |
| 214 | "deleted": false, |
| 215 | "write_protect": false, |
| 216 | "lazy_blocked": false, |
| 217 | "no_sync": false, |
| 218 | "instance_id": null, |
| 219 | "instance_uuid": null, |
| 220 | "name": "mysite_vcpe", |
| 221 | "instance_name": null, |
| 222 | "ip": null, |
| 223 | "image": "1", |
| 224 | "creator": "1", |
| 225 | "slice": "1", |
| 226 | "deployment": "1", |
| 227 | "node": "1", |
| 228 | "numberCores": 0, |
| 229 | "flavor": "1", |
| 230 | "userData": null, |
| 231 | "isolation": "vm", |
| 232 | "volumes": "/etc/dnsmasq.d,/etc/ufw", |
| 233 | "parent": null, |
| 234 | "networks": [ |
| 235 | "1" |
| 236 | ] |
| 237 | } |
| 238 | ] |
| 239 | |
| 240 | |
| 241 | |
| 242 | # Group Nodes |
| 243 | |
| 244 | List of the XOS nodes |
| 245 | |
| 246 | ## Nodes [/api/core/nodes/{id}/] |
| 247 | |
| 248 | ### List all nodes [GET] |
| 249 | |
| 250 | + Response 200 (application/json) |
| 251 | |
| 252 | [ |
| 253 | { |
| 254 | "humanReadableName": "node2.opencloud.us", |
| 255 | "id": 1, |
| 256 | "created": "2016-04-29T16:19:05.661567Z", |
| 257 | "updated": "2016-04-29T16:19:05.661454Z", |
| 258 | "enacted": null, |
| 259 | "policed": null, |
| 260 | "backend_register": "{}", |
| 261 | "backend_status": "0 - Provisioning in progress", |
| 262 | "deleted": false, |
| 263 | "write_protect": false, |
| 264 | "lazy_blocked": false, |
| 265 | "no_sync": true, |
| 266 | "name": "node2.opencloud.us", |
| 267 | "site_deployment": "1", |
| 268 | "site": "1", |
| 269 | "nodelabels": [] |
| 270 | } |
| 271 | ] |
| 272 | |
| 273 | |
| 274 | |
| 275 | # Group Sites |
| 276 | |
| 277 | List of the XOS sites |
| 278 | |
| 279 | ## Sites [/api/core/sites/{id}/] |
| 280 | |
| 281 | ### List all sites [GET] |
| 282 | |
| 283 | + Response 200 (application/json) |
| 284 | |
| 285 | { |
| 286 | "humanReadableName": "MySite", |
| 287 | "id": 1, |
| 288 | "created": "2016-04-29T16:19:03.587770Z", |
| 289 | "updated": "2016-04-29T16:19:05.651933Z", |
| 290 | "enacted": null, |
| 291 | "policed": null, |
| 292 | "backend_register": "{}", |
| 293 | "backend_status": "0 - Provisioning in progress", |
| 294 | "deleted": false, |
| 295 | "write_protect": false, |
| 296 | "lazy_blocked": false, |
| 297 | "no_sync": false, |
| 298 | "name": "MySite", |
| 299 | "site_url": "http://opencord.us/", |
| 300 | "enabled": true, |
| 301 | "hosts_nodes": true, |
| 302 | "hosts_users": true, |
| 303 | "location": null, |
| 304 | "longitude": null, |
| 305 | "latitude": null, |
| 306 | "login_base": "mysite", |
| 307 | "is_public": true, |
| 308 | "abbreviated_name": "", |
| 309 | "deployments": [ |
| 310 | "1" |
| 311 | ] |
| 312 | } |
| 313 | |
| 314 | |
| 315 | # Group Slices |
| 316 | |
| 317 | List of the XOS slices |
| 318 | |
| 319 | ## Slices [/api/core/slices/{id}/] |
| 320 | |
| 321 | ### List all slices [GET] |
| 322 | |
| 323 | + Response 200 (application/json) |
| 324 | |
| 325 | [ |
| 326 | { |
| 327 | "humanReadableName": "mysite_slice", |
| 328 | "id": 1, |
| 329 | "created": "2016-04-29T16:23:22.505072Z", |
| 330 | "updated": "2016-04-29T16:23:22.504691Z", |
| 331 | "enacted": null, |
| 332 | "policed": "2016-04-29T16:23:22.781298Z", |
| 333 | "backend_register": "{}", |
| 334 | "backend_status": "0 - Provisioning in progress", |
| 335 | "deleted": false, |
| 336 | "write_protect": false, |
| 337 | "lazy_blocked": false, |
| 338 | "no_sync": false, |
| 339 | "name": "mysite_slice", |
| 340 | "enabled": true, |
| 341 | "omf_friendly": false, |
| 342 | "description": "", |
| 343 | "slice_url": "", |
| 344 | "site": "http://apt118.apt.emulab.net/api/core/sites/1/", |
| 345 | "max_instances": 10, |
| 346 | "service": null, |
| 347 | "network": null, |
| 348 | "exposed_ports": null, |
| 349 | "serviceClass": "http://apt118.apt.emulab.net/api/core/serviceclasses/1/", |
| 350 | "creator": "http://apt118.apt.emulab.net/api/core/users/1/", |
| 351 | "default_flavor": null, |
| 352 | "default_image": null, |
| 353 | "mount_data_sets": "GenBank", |
| 354 | "default_isolation": "vm", |
| 355 | "networks": [ |
| 356 | "http://apt118.apt.emulab.net/api/core/networks/1/" |
| 357 | ] |
| 358 | } |
| 359 | ] |
| 360 | |
| 361 | |
| 362 | |
| 363 | # Group Users |
| 364 | |
| 365 | List of the XOS users |
| 366 | |
| 367 | ## Users [/api/core/users/{id}/] |
| 368 | |
| 369 | ### List all Users [GET] |
| 370 | |
| 371 | + Response 200 (application/json) |
| 372 | |
| 373 | [ |
| 374 | { |
| 375 | "id": 2, |
| 376 | "password": "pbkdf2_sha256$12000$9gn8DmZuIoz2$YPQkx3AOOV7jZNYr2ddrgUCkiuaPpvb8+aJR7RwLZNA=", |
| 377 | "last_login": "2016-04-12T18:50:45.880823Z", |
| 378 | "email": "johndoe@myhouse.com", |
| 379 | "username": "johndoe@myhouse.com", |
| 380 | "firstname": "john", |
| 381 | "lastname": "doe", |
| 382 | "phone": null, |
| 383 | "user_url": null, |
| 384 | "site": "http://xos.dev:9999/api/core/sites/1/", |
| 385 | "public_key": null, |
| 386 | "is_active": true, |
| 387 | "is_admin": false, |
| 388 | "is_staff": true, |
| 389 | "is_readonly": false, |
| 390 | "is_registering": false, |
| 391 | "is_appuser": false, |
| 392 | "login_page": null, |
| 393 | "created": "2016-04-12T18:50:45.912602Z", |
| 394 | "updated": "2016-04-12T18:50:45.912671Z", |
| 395 | "enacted": null, |
| 396 | "policed": null, |
| 397 | "backend_status": "Provisioning in progress", |
| 398 | "deleted": false, |
| 399 | "write_protect": false, |
| 400 | "timezone": "America/New_York" |
| 401 | } |
| 402 | ] |
| 403 | |
| 404 | |
| 405 | |
Matteo Scandolo | a2be8d4 | 2016-04-29 15:34:17 -0700 | [diff] [blame] | 406 | # Group Example |
| 407 | |
| 408 | ## Example Services Collection [/api/service/exampleservice/] |
| 409 | |
| 410 | ### List all Example Services [GET] |
| 411 | |
| 412 | + Response 200 (application/json) |
| 413 | |
| 414 | [ |
| 415 | { |
| 416 | "humanReadableName": "MyExample", |
| 417 | "id": 1, |
| 418 | "service_message": "This is the test message" |
| 419 | } |
| 420 | ] |
| 421 | |
| 422 | |
| 423 | # Group ONOS Services |
| 424 | |
| 425 | List of the active onos services |
| 426 | |
| 427 | ## ONOS Services Collection [/api/service/onos/] |
| 428 | |
| 429 | ### List all ONOS Services [GET] |
| 430 | |
| 431 | + Response 200 (application/json) |
| 432 | |
| 433 | [ |
| 434 | { |
| 435 | "humanReadableName": "service_ONOS_vBNG", |
| 436 | "id": 5, |
| 437 | "rest_hostname": "", |
| 438 | "rest_port": "8181", |
| 439 | "no_container": false, |
| 440 | "node_key": "" |
| 441 | } |
| 442 | ] |
| 443 | |
| 444 | |
| 445 | # Group vSG |
| 446 | |
| 447 | ## vSG Collection [/api/service/vsg/] |
| 448 | |
| 449 | ### List all vSGs [GET] |
| 450 | |
| 451 | + Response 200 (application/json) |
| 452 | |
| 453 | [ |
| 454 | { |
| 455 | "humanReadableName": "service_vsg", |
| 456 | "id": 2, |
| 457 | "dns_servers": "8.8.8.8", |
| 458 | "url_filter_kind": null, |
| 459 | "node_label": null |
| 460 | } |
| 461 | ] |
| 462 | |
| 463 | |
Matteo Scandolo | d5f3d05 | 2016-05-02 15:29:37 -0700 | [diff] [blame] | 464 | # Group Utility |
| 465 | |
| 466 | List of the XOS Utility API |
| 467 | |
| 468 | ## Login [/api/utility/login/] |
| 469 | |
| 470 | ### Log a user in the system [POST] |
| 471 | |
| 472 | + Request (application/json) |
| 473 | |
| 474 | { |
| 475 | "username": "padmin@vicci.org", |
| 476 | "password": "letmein" |
| 477 | } |
| 478 | |
| 479 | + Response 200 (application/json) |
| 480 | |
| 481 | { |
| 482 | "xoscsrftoken":"xuvsRC1jkXAsnrdRlgJvcXpmtthTAqqf", |
| 483 | "xossessionid":"7ds5a3wzjlgbjqo4odkd25qsm0j2s6zg", |
| 484 | "user": "{\"policed\": null, \"site\": 3, \"is_appuser\": false, \"is_staff\": true, \"backend_status\": \"Provisioning in progress\", \"id\": 3, \"is_registering\": false, \"last_login\": \"2016-04-30T22:51:04.788675+00:00\", \"email\": \"padmin@vicci.org\", \"no_sync\": false, \"username\": \"padmin@vicci.org\", \"dashboards\": [11], \"login_page\": null, \"firstname\": \"XOS\", \"user_url\": null, \"deleted\": false, \"lastname\": \"admin\", \"is_active\": true, \"lazy_blocked\": false, \"phone\": null, \"is_admin\": true, \"enacted\": null, \"public_key\": null, \"is_readonly\": false, \"no_policy\": false, \"write_protect\": false}" |
| 485 | } |
| 486 | |
| 487 | ## Logout [/api/utility/logout/] |
| 488 | |
| 489 | ### Log a user out of the system [POST] |
| 490 | |
| 491 | + Request (application/json) |
| 492 | {xossessionid: "sessionId"} |
| 493 | |
| 494 | + Response 200 (application/json) |
| 495 | |
| 496 | |
| 497 | |
Teone | 620bafd | 2016-04-18 14:39:41 -0700 | [diff] [blame] | 498 | # Group Subscribers |
| 499 | |
| 500 | Resource related to the CORD Subscribers. |
| 501 | |
Matteo Scandolo | e25820a | 2016-04-27 17:31:11 -0700 | [diff] [blame] | 502 | ## Subscribers [/api/tenant/cord/subscriber/{subscriber_id}/] |
Teone | 620bafd | 2016-04-18 14:39:41 -0700 | [diff] [blame] | 503 | |
| 504 | ### List All Subscribers [GET] |
| 505 | |
| 506 | + Response 200 (application/json) |
| 507 | |
| 508 | [ |
| 509 | { |
| 510 | "humanReadableName": "cordSubscriber-1", |
| 511 | "id": 1, |
| 512 | "features": { |
| 513 | "cdn": false, |
| 514 | "uplink_speed": 1000000000, |
| 515 | "downlink_speed": 1000000000, |
| 516 | "uverse": false, |
| 517 | "status": "enabled" |
| 518 | }, |
| 519 | "identity": { |
| 520 | "account_num": "123", |
| 521 | "name": "My House" |
| 522 | }, |
| 523 | "related": { |
| 524 | "instance_name": "mysite_vcpe", |
| 525 | "vsg_id": 4, |
| 526 | "compute_node_name": "node2.opencloud.us", |
| 527 | "c_tag": "432", |
| 528 | "instance_id": 1, |
| 529 | "wan_container_ip": null, |
| 530 | "volt_id": 3, |
| 531 | "s_tag": "222" |
| 532 | } |
| 533 | } |
| 534 | ] |
| 535 | |
Matteo Scandolo | e25820a | 2016-04-27 17:31:11 -0700 | [diff] [blame] | 536 | |
| 537 | ### View a Subscriber Detail [GET] |
Teone | 620bafd | 2016-04-18 14:39:41 -0700 | [diff] [blame] | 538 | |
| 539 | + Parameters |
| 540 | + subscriber_id: 1 (number) - ID of the Subscriber in the form of an integer |
| 541 | |
Teone | 620bafd | 2016-04-18 14:39:41 -0700 | [diff] [blame] | 542 | + Response 200 (application/json) |
| 543 | |
| 544 | { |
| 545 | "humanReadableName": "cordSubscriber-1", |
| 546 | "id": 1, |
| 547 | "features": { |
| 548 | "cdn": false, |
| 549 | "uplink_speed": 1000000000, |
| 550 | "downlink_speed": 1000000000, |
| 551 | "uverse": false, |
| 552 | "status": "enabled" |
| 553 | }, |
| 554 | "identity": { |
| 555 | "account_num": "123", |
| 556 | "name": "My House" |
| 557 | }, |
| 558 | "related": { |
| 559 | "instance_name": "mysite_vcpe", |
| 560 | "vsg_id": 4, |
| 561 | "compute_node_name": "node2.opencloud.us", |
| 562 | "c_tag": "432", |
| 563 | "instance_id": 1, |
| 564 | "wan_container_ip": null, |
| 565 | "volt_id": 3, |
| 566 | "s_tag": "222" |
| 567 | } |
| 568 | } |
| 569 | |
| 570 | ### Delete a Subscriber [DELETE] |
| 571 | |
Matteo Scandolo | e25820a | 2016-04-27 17:31:11 -0700 | [diff] [blame] | 572 | + Parameters |
| 573 | + subscriber_id: 1 (number) - ID of the Subscriber in the form of an integer |
| 574 | |
Teone | 620bafd | 2016-04-18 14:39:41 -0700 | [diff] [blame] | 575 | + Response 204 |
| 576 | |
| 577 | ### Subscriber features [/api/tenant/cord/subscriber/{subscriber_id}/features/] |
| 578 | |
| 579 | + Parameters |
| 580 | + subscriber_id: 1 (number) - ID of the Subscriber in the form of an integer |
| 581 | |
| 582 | ### View a Subscriber Features Detail [GET] |
| 583 | |
| 584 | + Response 200 (application/json) |
| 585 | |
| 586 | { |
| 587 | "cdn": false, |
| 588 | "uplink_speed": 1000000000, |
| 589 | "downlink_speed": 1000000000, |
| 590 | "uverse": true, |
| 591 | "status": "enabled" |
| 592 | } |
| 593 | |
| 594 | #### Subscriber features uplink_speed [/api/tenant/cord/subscriber/{subscriber_id}/features/uplink_speed/] |
| 595 | |
| 596 | + Parameters |
| 597 | + subscriber_id: 1 (number) - ID of the Subscriber in the form of an integer |
| 598 | |
| 599 | #### Read Subscriber uplink_speed [GET] |
| 600 | |
| 601 | + Response 200 (application/json) |
| 602 | |
| 603 | { |
| 604 | "uplink_speed": 1000000000 |
| 605 | } |
| 606 | |
| 607 | #### Update Subscriber uplink_speed [PUT] |
| 608 | |
| 609 | + Request 200 (application/json) |
| 610 | |
| 611 | { |
| 612 | "uplink_speed": 1000000000 |
| 613 | } |
| 614 | |
| 615 | + Response 200 (application/json) |
| 616 | |
| 617 | { |
| 618 | "uplink_speed": 1000000000 |
| 619 | } |
| 620 | |
| 621 | #### Subscriber features downlink_speed [/api/tenant/cord/subscriber/{subscriber_id}/features/downlink_speed/] |
| 622 | |
| 623 | + Parameters |
| 624 | + subscriber_id: 1 (number) - ID of the Subscriber in the form of an integer |
| 625 | |
| 626 | #### Read Subscriber downlink_speed [GET] |
| 627 | |
| 628 | + Response 200 (application/json) |
| 629 | |
| 630 | { |
| 631 | "downlink_speed": 1000000000 |
| 632 | } |
| 633 | |
| 634 | #### Update Subscriber downlink_speed [PUT] |
| 635 | |
| 636 | + Request 200 (application/json) |
| 637 | |
| 638 | { |
| 639 | "downlink_speed": 1000000000 |
| 640 | } |
| 641 | |
| 642 | + Response 200 (application/json) |
| 643 | |
| 644 | { |
| 645 | "downlink_speed": 1000000000 |
| 646 | } |
| 647 | |
| 648 | #### Subscriber features cdn [/api/tenant/cord/subscriber/{subscriber_id}/features/cdn/] |
| 649 | |
| 650 | + Parameters |
| 651 | + subscriber_id: 1 (number) - ID of the Subscriber in the form of an integer |
| 652 | |
| 653 | #### Read Subscriber cdn [GET] |
| 654 | |
| 655 | + Response 200 (application/json) |
| 656 | |
| 657 | { |
| 658 | "cdn": false |
| 659 | } |
| 660 | |
| 661 | #### Update Subscriber cdn [PUT] |
| 662 | |
| 663 | + Request 200 (application/json) |
| 664 | |
| 665 | { |
| 666 | "cdn": false |
| 667 | } |
| 668 | |
| 669 | + Response 200 (application/json) |
| 670 | |
| 671 | { |
| 672 | "cdn": false |
| 673 | } |
| 674 | |
| 675 | #### Subscriber features uverse [/api/tenant/cord/subscriber/{subscriber_id}/features/uverse/] |
| 676 | |
| 677 | + Parameters |
| 678 | + subscriber_id: 1 (number) - ID of the Subscriber in the form of an integer |
| 679 | |
| 680 | #### Read Subscriber uverse [GET] |
| 681 | |
| 682 | + Response 200 (application/json) |
| 683 | |
| 684 | { |
| 685 | "uverse": false |
| 686 | } |
| 687 | |
| 688 | #### Update Subscriber uverse [PUT] |
| 689 | |
| 690 | + Request 200 (application/json) |
| 691 | |
| 692 | { |
| 693 | "uverse": false |
| 694 | } |
| 695 | |
| 696 | + Response 200 (application/json) |
| 697 | |
| 698 | { |
| 699 | "uverse": false |
| 700 | } |
| 701 | |
| 702 | #### Subscriber features status [/api/tenant/cord/subscriber/{subscriber_id}/features/status/] |
| 703 | |
| 704 | + Parameters |
| 705 | + subscriber_id: 1 (number) - ID of the Subscriber in the form of an integer |
| 706 | |
| 707 | #### Read Subscriber status [GET] |
| 708 | |
| 709 | + Response 200 (application/json) |
| 710 | |
| 711 | { |
| 712 | "status": "enabled" |
| 713 | } |
| 714 | |
| 715 | #### Update Subscriber status [PUT] |
| 716 | |
| 717 | + Request 200 (application/json) |
| 718 | |
| 719 | { |
| 720 | "status": "enabled" |
| 721 | } |
| 722 | |
| 723 | + Response 200 (application/json) |
| 724 | |
| 725 | { |
| 726 | "status": "enabled" |
| 727 | } |
| 728 | |
| 729 | |
| 730 | # Group Truckroll |
| 731 | |
| 732 | Virtual Truckroll, enable to perform basic test on user connectivity such as ping, traceroute and tcpdump. |
| 733 | |
Matteo Scandolo | e25820a | 2016-04-27 17:31:11 -0700 | [diff] [blame] | 734 | ## Truckroll Collection [/api/tenant/truckroll/{truckroll_id}/] |
Teone | 620bafd | 2016-04-18 14:39:41 -0700 | [diff] [blame] | 735 | |
| 736 | ### List all Truckroll [GET] |
| 737 | |
| 738 | + Response 200 (application/json) |
| 739 | |
| 740 | [ |
| 741 | { |
| 742 | "humanReadableName": "vTR-tenant-9", |
| 743 | "id": 9, |
| 744 | "provider_service": 6, |
| 745 | "target_id": 2, |
| 746 | "scope": "container", |
| 747 | "test": "ping", |
| 748 | "argument": "8.8.8.8", |
| 749 | "result": "", |
| 750 | "result_code": "", |
| 751 | "is_synced": false, |
| 752 | "backend_status": "2 - Exception('Unreachable results in ansible recipe',)" |
| 753 | } |
| 754 | ] |
| 755 | |
| 756 | ### Create a Truckroll [POST] |
| 757 | |
Matteo Scandolo | e25820a | 2016-04-27 17:31:11 -0700 | [diff] [blame] | 758 | A virtual truckroll is complete once is_synced equal true |
| 759 | |
Teone | 620bafd | 2016-04-18 14:39:41 -0700 | [diff] [blame] | 760 | + Request (application/json) |
| 761 | |
| 762 | { |
| 763 | "target_id": 2, |
| 764 | "scope": "container", |
| 765 | "test": "ping", |
| 766 | "argument": "8.8.8.8" |
| 767 | } |
| 768 | |
| 769 | + Response 201 (application/json) |
| 770 | |
| 771 | { |
| 772 | "humanReadableName": "vTR-tenant-1", |
| 773 | "id": 1, |
| 774 | "provider_service": 6, |
| 775 | "target_id": 2, |
| 776 | "scope": "container", |
| 777 | "test": "ping", |
| 778 | "argument": "8.8.8.8", |
| 779 | "result": null, |
| 780 | "result_code": null, |
| 781 | "is_synced": false, |
| 782 | "backend_status": "0 - Provisioning in progress" |
| 783 | } |
| 784 | |
Teone | 620bafd | 2016-04-18 14:39:41 -0700 | [diff] [blame] | 785 | |
Matteo Scandolo | e25820a | 2016-04-27 17:31:11 -0700 | [diff] [blame] | 786 | ### View a Truckroll Detail [GET] |
Teone | 620bafd | 2016-04-18 14:39:41 -0700 | [diff] [blame] | 787 | |
| 788 | + Parameters |
| 789 | + truckroll_id: 1 (number) - ID of the Truckroll in the form of an integer |
| 790 | |
Teone | 620bafd | 2016-04-18 14:39:41 -0700 | [diff] [blame] | 791 | + Response 200 (application/json) |
| 792 | |
| 793 | { |
| 794 | "humanReadableName": "vTR-tenant-10", |
| 795 | "id": 10, |
| 796 | "provider_service": 6, |
| 797 | "target_id": 2, |
| 798 | "scope": "container", |
| 799 | "test": "ping", |
| 800 | "argument": "8.8.8.8", |
| 801 | "result": null, |
| 802 | "result_code": null, |
| 803 | "is_synced": false, |
| 804 | "backend_status": "0 - Provisioning in progress" |
| 805 | } |
| 806 | |
| 807 | ### Delete a Truckroll Detail [DELETE] |
| 808 | |
Matteo Scandolo | e25820a | 2016-04-27 17:31:11 -0700 | [diff] [blame] | 809 | + Parameters |
| 810 | + truckroll_id: 1 (number) - ID of the Truckroll in the form of an integer |
| 811 | |
Teone | 620bafd | 2016-04-18 14:39:41 -0700 | [diff] [blame] | 812 | + Response 204 |
| 813 | |
| 814 | |
| 815 | |
| 816 | # Group vOLT |
| 817 | |
| 818 | OLT devices aggregate a set of subscriber connections |
| 819 | |
Matteo Scandolo | e25820a | 2016-04-27 17:31:11 -0700 | [diff] [blame] | 820 | ## vOLT Collection [/api/tenant/cord/volt/{volt_id}/] |
Teone | 620bafd | 2016-04-18 14:39:41 -0700 | [diff] [blame] | 821 | |
| 822 | ### List all vOLT [GET] |
| 823 | |
| 824 | + Response 200 (application/json) |
| 825 | |
| 826 | [ |
| 827 | { |
| 828 | "humanReadableName": "vOLT-tenant-1", |
| 829 | "id": 1, |
| 830 | "service_specific_id": "123", |
| 831 | "s_tag": "222", |
| 832 | "c_tag": "432", |
| 833 | "subscriber": 1, |
| 834 | "related": { |
| 835 | "instance_id": 1, |
| 836 | "instance_name": "mysite_vcpe", |
| 837 | "vsg_id": 4, |
| 838 | "wan_container_ip": null, |
| 839 | "compute_node_name": "node2.opencloud.us" |
| 840 | } |
| 841 | } |
| 842 | ] |
| 843 | |
| 844 | ### Create a vOLT [POST] |
| 845 | |
| 846 | + Request (application/json) |
| 847 | |
| 848 | { |
| 849 | "s_tag": "222", |
| 850 | "c_tag": "432", |
| 851 | "subscriber": 1 |
| 852 | } |
| 853 | |
| 854 | + Response 201 (application/json) |
| 855 | |
| 856 | { |
| 857 | "humanReadableName": "vOLT-tenant-1", |
| 858 | "id": 1, |
| 859 | "service_specific_id": "123", |
| 860 | "s_tag": "222", |
| 861 | "c_tag": "432", |
| 862 | "subscriber": 1, |
| 863 | "related": { |
| 864 | "instance_id": 1, |
| 865 | "instance_name": "mysite_vcpe", |
| 866 | "vsg_id": 4, |
| 867 | "wan_container_ip": null, |
| 868 | "compute_node_name": "node2.opencloud.us" |
| 869 | } |
| 870 | } |
| 871 | |
Matteo Scandolo | e25820a | 2016-04-27 17:31:11 -0700 | [diff] [blame] | 872 | ### View a vOLT Detail [GET] |
Teone | 620bafd | 2016-04-18 14:39:41 -0700 | [diff] [blame] | 873 | |
| 874 | + Parameters |
| 875 | + volt_id: 1 (number) - ID of the vOLT in the form of an integer |
| 876 | |
Teone | 620bafd | 2016-04-18 14:39:41 -0700 | [diff] [blame] | 877 | + Response 200 (application/json) |
| 878 | |
| 879 | { |
| 880 | "humanReadableName": "vOLT-tenant-1", |
| 881 | "id": 1, |
| 882 | "service_specific_id": "123", |
| 883 | "s_tag": "222", |
| 884 | "c_tag": "432", |
| 885 | "subscriber": 1, |
| 886 | "related": { |
| 887 | "instance_id": 1, |
| 888 | "instance_name": "mysite_vcpe", |
| 889 | "vsg_id": 4, |
| 890 | "wan_container_ip": null, |
| 891 | "compute_node_name": "node2.opencloud.us" |
| 892 | } |
| 893 | } |
| 894 | |
| 895 | |
| 896 | |
| 897 | # Group ONOS Apps |
| 898 | |
Matteo Scandolo | e25820a | 2016-04-27 17:31:11 -0700 | [diff] [blame] | 899 | ## ONOS App Collection [/api/tenant/onos/app/] |
Teone | 620bafd | 2016-04-18 14:39:41 -0700 | [diff] [blame] | 900 | |
| 901 | ### List all apps [GET] |
| 902 | |
| 903 | + Response 200 (application/json) |
| 904 | |
| 905 | [ |
| 906 | { |
| 907 | "humanReadableName": "onos-tenant-7", |
| 908 | "id": 7, |
| 909 | "name": "vBNG_ONOS_app", |
| 910 | "dependencies": "org.onosproject.proxyarp, org.onosproject.virtualbng, org.onosproject.openflow, org.onosproject.fwd" |
| 911 | } |
| 912 | ] |