Opaque Network Get Summary

Opaque Network Get Summary

Properties of a network.

Request
URI
GET
https://{vcenter-host}/sdk/vim25/{release}/OpaqueNetwork/{moId}/summary
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the property attaches; the serialized managed object reference for a request has the form moType/moId, in this case OpaqueNetwork/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns NetworkSummary of type(s) application/json
This response body class contains all of the following: DataObject 
{
    "_typeName": "string",
    "network": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "name": "string",
    "accessible": false,
    "ipPoolName": "string",
    "ipPoolId": 0
}
MoRefNetwork
network
Optional

Reference to an instance of the Network managed object.

string
name
Required

Name of the network.

boolean
accessible
Required

At least one host is configured to provide this network.

string
ipPoolName
Required

Name of the associated IP pool.

Empty if the network is not associated with an IP pool.

integer As int32 As int32
ipPoolId
Optional

Identifier of the associated IP pool.

Zero if the network is not associated with an IP pool.


On This Page
Virtual Infrastructure Operations
POST
Opaque Network Destroy Task
POST
Opaque Network Destroy Network
GET
Opaque Network Get Alarm Actions Enabled
GET
Opaque Network Get Available Field
GET
Opaque Network Get Capability
GET
Opaque Network Get Config Issue
GET
Opaque Network Get Config Status
GET
Opaque Network Get Custom Value
GET
Opaque Network Get Declared Alarm State
GET
Opaque Network Get Disabled Method
GET
Opaque Network Get Effective Role
GET
Opaque Network Get Extra Config
GET
Opaque Network Get Host
GET
Opaque Network Get Name
GET
Opaque Network Get Overall Status
GET
Opaque Network Get Parent
GET
Opaque Network Get Permission
GET
Opaque Network Get Recent Task
GET
Opaque Network Get Summary
GET
Opaque Network Get Tag
GET
Opaque Network Get Triggered Alarm State
GET
Opaque Network Get Value
GET
Opaque Network Get Vm
POST
Opaque Network Reload
POST
Opaque Network Rename Task
POST
Opaque Network Set Custom Value