Neutron/DeviceInventory

Provider API

/v2.0/services/lbaas/devices.json	GET
/v2.0/services/lbaas/devices.json	POST
/v2.0/services/lbaas/devices/{device_id}.json	GET
/v2.0/services/lbaas/devices/{device_id}.json	DELETE

/v2.0/services/lbaas/algorithms.json	GET
/v2.0/services/lbaas/protocols.json	GET

List devices

Verb	URI
GET	/devices

Normal Response Code: 200

Error Response Codes: Unauthorized (401)

This operation does not require a request body, unless the Quantum server is running without Keystone integration.

This operation returns a response body.

JSON Request:

GET /v2.0/services/lbaas/devices.json
Accept: application/json

JSON Response:

{
    "devices": [
        {
            "id": "f2bf34e028b64ce593aa8bab56259cad",
            "name": "HAP-001",
            "type": "HAPROXY",
            "version": "1.0",
            "is_public": "true", 
            "mgmt_ip": "10.0.0.6",
            "mgmt_port": 22,
            "mgmt_user": "user",
            "mgmt_password": "swordfish"
        }
    ]
}

Show device

Verb	URI
GET	/vip/{vip_id}

Normal Response Code: 200

Error Response Codes: Unauthorized (401), Not Found (404)

This operation does not require a request body, unless the Quantum server is running without Keystone integration.

This operation returns a response body.

JSON Request:

GET /v2.0/services/lbaas/devices/{afc75773-640e-403c-9fff-62ba98db1f19}.json
Accept: application/json

JSON Response:

{
    "device": {
        "id": "f2bf34e028b64ce593aa8bab56259cad",
        "name": "HAP-001",
        "type": "HAPROXY",
        "version": "1.0",
        "is_public": "true",
        "mgmt_ip": "10.0.0.6",
        "mgmt_port": 22,
        "mgmt_user": "user",
        "mgmt_password": "swordfish",
        "capabilities": {
            "algorithms": [
                "STATIC_RR",
                "ROUND_ROBIN",
                "HASH_SOURCE",
                "LEAST_CONNECTION",
                "HASH_URI"
            ],
            "protocols": [
                "TCP",
                "HTTP"
            ],
            "healthMonitors": [
                "ICMP",
                "HTTP_GET",
                "HTTP_HEAD"
            ],
            "sessionPersistences": [
                "COOKIE",
                "SRC_ADDR"
            ]
        }
    }

}

Create Device

Verb	URI
POST	/devices

Normal Response Code: 201

Error Response Codes: Bad Request (400) Unauthorized (401)

This operation requires a request body. The request body must contain a network object that specifies a symbolic name for the network.

This operation returns a response body.

JSON Request:

POST /v2.0/services/lbaas/devices.json
Content-Type: application/json
Accept: application/json

{
    "device": {
        "name": "HAP-001",
        "type": "HAPROXY",
        "version": "1.0",
        "is_public": "false", 
        "mgmt_ip": "10.0.0.6",
        "mgmt_port": 22,
        "mgmt_user": "user",
        "mgmt_password": "swordfish"
    }
}

JSON Response:

{
    "device": {
        "id": "f2bf34e028b64ce593aa8bab56259cad",
        "name": "HAP-001",
        "type": "HAPROXY",
        "version": "1.0",
        "is_public": "true", 
        "mgmt_ip": "10.0.0.6",
        "mgmt_port": 22,
        "mgmt_user": "user",
        "mgmt_password": "swordfish"
    }
}

Delete Device

Verb	URI
DELETE	/device/{device_id}

Normal Response Code: 204

Error Response Codes: Unauthorized (401), Not Found (404)

This operation does not require a request body.

This operation does not return a response body.

JSON Request:

DELETE /v2.0/services/lbaas/devices/{afc75773-640e-403c-9fff-62ba98db1f19}.json
Accept: application/json

JSON Response:

status: 204