Viewing vCables

A virtual cable (vCable) is an internal representation of the link between an instance's network interface and a specific network. A vCable is created automatically when an instance is launched and is deleted when the instance is deleted. When a vCable is deleted (on instance termination), entities that depend on them are also deleted.

Topics:

Discover vCables

This API enables you to discover vCable objects in a specific container.

Note:

The discover API calls display the names of the objects in the specified container, not the details about the objects. To list the names of the objects, you must set the Accept header to application/oracle-compute-v3+directory+json. For all other purposes, you must set the Accept header to application/oracle-compute-v3+json.

Method

GET

REST Resource

/vcable/container/

URI

https://api_endpoint/vcable/container/

URI Parameter

Parameter	Description
container	Hierarchical namespace for vCables. For example, `/mytenant/public/myvcable`

Example URI

http://api.oc.example.com/vcable/mytenant/public

Example Response Body

{
    "result": [
        "/mytenant/public/450e9885-42a0-44ec-b102-9bbaf9c2c1e0",
        "/mytenant/public/c65ccbbd-80b1-40c5-a100-356434c17374",
        "/mytenant/public/dca6695a-7b72-49cb-9a70-20369b24a3d5",
        "/mytenant/public/e8ec90f9-95a0-444f-bafe-ec5c87518d77"
    ]
}

Get vCable

This API enables you to retrieve information for a specific vCable.

Method

GET

REST Resource

/vcable/name

URI

https://api_endpoint/vcable/name

URI Parameter

Parameter	Description
name	Name of vCable.

Example URI

http://api.oc.example.com/vcable/mytenant/public/450e9885-42a0-44ec-b102-9bbaf9c2c1e0

Example Response Body

{
 "net_config": 
 {
  "owner": {"type": "tenant", "name": "mytenant"}, 
  "ip": "192.168.160.67", 
  "netmask": "255.255.255.192", 
  "type": "IPoIB"
 }, 
 "vethernet_id": "-1", 
 "vnetreservation": "/mytenant/public/vnetres2", 
 "uri": "http://api.oc.example.com/vcable/mytenant/public/450e9885-42a0-44ec-b102-9bbaf9c2c1e0", 
 "options": {}, 
 "instance": "/mytenant/public/32970825-74b9-4a19-aa84-570eabed8325", 
 "vnet": "/mytenant/public/IPoIB-Test", 
 "vethernet": "/mytenant/public/default", 
 "address": [null, "192.168.160.67"], 
 "model": "", 
 "vethernet_type": "ipoib",  
 "id": "/mytenant/public/450e9885-42a0-44ec-b102-9bbaf9c2c1e0", 
 "dhcp_options": []
}

List vCables

This API enables you to retrieve information for vCables in a specific container.

Method

GET

REST Resource

/vcable/container/

URI

https://api_endpoint/vcable/container?vnet=vnetValue&vethernet_id=vethrenet_idValue&vethernet_type=vethernet_typeValue&id=idvalue&instance=instanceValue&vethernet=vethernetValue

URI Parameters

Parameter	Description
container	Hierarchical namespace for vCables. For example, `/mytenant/public/myvcable`
vnet=vnetValue	(Optional) The path of the vNET used to create the vCable. If specified, the vCable listing is scoped to only include vCables linked to the specified vNET.
vethernet_id=vethernet_idValue	(Optional) The vEthernet Id for the vCable. If specified, the vCable listing is scoped to only include vCables with the specified Id. The parameter is always set to -1 for infiniband networks.
vethernet_type=vethernet_typeValue	(Optional) The type of vEthernet for the vCable. Possible values are `ipoib` or `eoib`. If specified, the vCable listing will be scoped to only include vCables linked to vEthernets of the specified type.
id=idValue	(Optional) Unique identifier of the particular vCable for which you want to retrieve info.
instance=instanceValue	(Optional) A specific instance you want to list vCables for. If specified, the listing will be scoped to only include vCables linked to this specific instance.
vethernet=vethernetValue	(Optional) The path of the vEthernet used to create the vCable. If specified, the listing will be scoped to only include vCables linked to this specific vEthernet.

Example URI

https://api.oc.example.com/vcable/mytenant/?vethernet=/oracle/public/default

Example Response Body

{
 "result": 
  [{
   "vethernet_id": "0", 
   "uri": "http://api.oc.example.com/vcable/mytenant/public/06202d2e-3c30-42ca-974f-61cfdeb37120", 
   "proxyuri": null, 
   "instance": "/mytenant/public/917385c0-7951-4463-bafa-d817b9174bf5", 
   "vethernet": "/oracle/public/default", 
   "address": ["c6:b0:3a:0a:bf:6c", "0.0.0.0"], 
   "model": "", 
   "vethernet_type": "vlan", 
   "id": "/mytenant/public/06202d2e-3c30-42ca-974f-61cfdeb37120"
 }]
}