Viewing Service Networks

Service networks (servicenets) are created in the system to provide shared services across multiple tenants. The shared services include access to storage, networks, and other engineered systems. An example of an external service provider is an Oracle ZFS storage appliance that provides storage shared across tenants. A dedicated InfiniBand partition is allocated for a servicenet, and no two servicenets share the partition.
The networks can be of type EoIB or IPoIB. The Oracle Cloud Administrator creates and manages these servicenets. In order to view a service network, a tenant must be granted access to the servicenet's underlying vNet by the Oracle Cloud Administrator. This is done with the use of vNet access.
  • IPoIB Service Networks: The IPoIB servicenet is used for communication between service consumers and service providers. The servicenet is constructed over InfiniBand inside the system, between engineered Systems, or external ZFS appliance interconnected using InfiniBand.

  • EoIB Service Networks: The EoIB servicenet is used for communication with a service provider or service consumer located outside the system over Ethernet through NM2 Gateways.

Discover Service Networks

This API enables you to discover a list of service networks defined within a 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

/svcnet/container/

URI

https://api_endpoint/svcnet/container/

URI Parameter

Parameter Description
container Hierarchical name-space for service networks.

Example URI

https://api.oc.example.com/svcnet/cloud/public/

Example Response Body

{
 "result": [
  "/cloud/public/EoIB-OMS",
  "/cloud/public/EoIB-management",
  "/cloud/public/IPoIB-default",
  "/cloud/public/IPoIB-instance-storage",
  "/cloud/public/IPoIB-ldap-internal",
  "/cloud/public/IPoIB-load-balancer",
  "/cloud/public/IPoIB-management",
  "/cloud/public/IPoIB-storage",
  "/cloud/public/servicenet1",
  "/cloud/public/svcnet-ipoib"
 ]
}

Get Service Network

This API enables you to retrieve information for a specific service network.

Method

GET

REST Resource

/svcnet/name

URI

https://api_endpoint/svcnet/name

URI Parameter

Parameter Description
name Name of the service network. For example /oracle/public/mysvcnet

Example URI

https://api.oc.example.com/svcnet/cloud/public/IPoIB-default

Example Response Body

{
        "pkey": "0x7fff", 
        "infranet": true, 
        "description": "Infrastructure service network: cloud/public/IPoIB-default", 
        "uri": "https://api.oc.example.com/svcnet/cloud/public/IPoIB-default", 
        "foreign_partition": true, 
        "num_provider_nodes": 0, 
        "type": "ipoib", 
        "ibrt_name": "0x7fff", 
        "name": "/cloud/public/IPoIB-default"
}

List Service Networks

This API enables you to retrieve information for all the service networks within a specific container.

Method

GET

REST Resource

/svcnet/container/

URI

https://api_endpoint/svcnet/container/

URI Parameter

Parameter Description
container Hierarchical namespace for service networks

Example URI

https://api.oc.example.com/svcnet/oracle/public/

Example Response Body

{
        "result": 
        [{
                "pkey": "0x1402", 
                "infranet": true, 
                "description": "Infrastructure service network: oracle/public/IPoIB-virt-admin", 
                "uri": "https://api.oc.example.com/svcnet/oracle/public/IPoIB-virt-admin", 
                "foreign_partition": false, 
                "num_provider_nodes": 1, 
                "type": "ipoib", 
                "ibrt_name": "IPoIB-virt-admin-c2", 
                "name": "/oracle/public/IPoIB-virt-admin"
        }]
}