Network Get Summary

Network Get Summary

Properties of a network.

Request
URI
GET
https://{vcenter-host}/sdk/vim25/{release}/Network/{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 Network/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.2.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
Network Operations
POST
Network Destroy Task
POST
Network Destroy Network
GET
Network Get Alarm Actions Enabled
GET
Network Get Available Field
GET
Network Get Config Issue
GET
Network Get Config Status
GET
Network Get Custom Value
GET
Network Get Declared Alarm State
GET
Network Get Disabled Method
GET
Network Get Effective Role
GET
Network Get Host
GET
Network Get Name
GET
Network Get Overall Status
GET
Network Get Parent
GET
Network Get Permission
GET
Network Get Recent Task
GET
Network Get Summary
GET
Network Get Tag
GET
Network Get Triggered Alarm State
GET
Network Get Value
GET
Network Get Vm
POST
Network Reload
POST
Network Rename Task
POST
Network Set Custom Value