Show Security Device Interface


Overview

Show security device Interface associated with specific tenant.


Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/ecl-api/devices/interface/{os_port_id}?tenantid={tenantid}&usertoken={x-subject-token}

HTTP Request Header

X-Auth-Token: <token_id>

Request Parameter

Request Parameters
Parameter Type Format Description Required
tenantid String UUID Tenant ID of the owner (UUID) Yes
usertoken String UUID User Token (UUID) Yes
portid String UUID Port ID registered in Openstack(UUID) Yes

Sample Request Body

This API does not require Request Body.


Response

HTTP Response Code

Response Codes
Response Code Description
200 OK
400 Request format is invalid
401 Unauthorized
404 Not found
500 Internal Server Error

Response Parameter

Response Parameters
Parameter Type Format Description
device_interfaces Object - Show security device Interface details associated with specific tenant
os_ip_address String IP Address Port IP address (if available)
msa_port_id String UUID Port id on the Network-based Security devices (registered in MSA)
os_port_name String - Port name on Openstack
os_server_id String UUID Server id of Network-based Security devices
os_port_id String UUID Port id on Openstack
os_network_id String UUID Network Id to which Port is associated on Openstack
os_subnet_id String UUID Subnet Id to which Port is associated on Openstack
os_port_status String - Port Status on Openstack
os_mac_address String MAC Address Port MAC address on Openstack

Sample Response Body

Normal Response

{
    "device_interfaces": [{
         "os_ip_address": "104.0.0.42",
         "msa_port_id": "port7",
         "os_port_name": "port7-NCS4507",
         "os_server_id": "4615fc66-6454-42d9-a73e-33f18246706c",
         "os_port_id": "73d033d6-42b2-4aef-b33c-f886829f749b",
         "os_network_id": "b8ccba25-f49a-4695-9814-9ebd6f3432e7",
         "os_subnet_id": "510b4efb-029c-4812-8c7d-edde1ef1fe17",
         "os_port_status": "ACTIVE",
         "os_mac_address": "fa:16:3e:94:9b:bd"
    }]
}

Error Response

{
    "error": {
         "message": "error message"
    }
}
Show Security Device
Search Logs