Show Security Device¶

Overview¶

Show security device details associated with specific tenant.

Synchronous / Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

HTTP Request Path¶

{endpoint}/ecl-api/devices/{serverid}?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
serverid	String	UUID	Server 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	Object	-	Security device details associated with specific tenant
msa_device_id	String	-	MSA Device External reference
os_server_id	String	UUID	Server id of Network-based Security devices
os_server_name	String	-	Server name on Openstack
os_availability_zone	String	-	Availability zone information
os_admin_username	String	-	Name of admin
os_server_status	String	-	Server Status
interfaces	Array	-	Interfaces details associated with the Security Device
os_ip_address	String	IP Address	Port IP address (if available)
msa_vrrp_mac	String	MAC Address	VRRP MAC address of the Port (if available)
msa_port_id	String	UUID	Port id on the Network-based Security devices (registered in MSA)
msa_vrrp_id	String	Numeric	Port VRRP ID on Forti VM (registered on MSA)
os_port_name	String	-	Port name on Openstack
msa_vrrp_grp_id	String	Numeric	Port VRRP Group ID on Forti VM (registered on MSA)
os_network_name	String	-	Network name to which Port is associated on Openstack
msa_vrrp_ip	String	IP Address	Port VRRP IP on Forti VM (registered on MSA)
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": [{
         "msa_device_id": "NCS4507",
         "os_server_id": "4615fc66-6454-42d9-a73e-33f18246706c",
         "os_server_name": "UTM-second_unit-NCS4507",
         "interfaces": [{
              "os_ip_address": "",
              "msa_vrrp_mac": "",
              "msa_port_id": "port6",
              "msa_vrrp_id": "",
              "os_port_name": "port6-NCS4507",
              "msa_vrrp_grp_id": "",
              "os_network_name": "ntt-utm-dummy-net",
              "msa_vrrp_ip": "",
              "os_port_status": "DOWN",
              "os_mac_address": "fa:16:3e:fa:7d:05",
         }],
         "os_availability_zone": "nova",
         "os_admin_username": "ntt-utm",
         "os_server_status": "ACTIVE"
    }]
}

Error Response¶

{
    "error": {
         "message": "error message"
    }
}

List Security Device Interfaces

Show Security Device Interface