OpenManage Enterprise Version 3.4 and OpenManage Enterprise - Modular Edition Version 1.20.00 RESTful API Guide

PDF

GET method for Networks

This method returns a list of available logical networks.

Description

Returns a list of available logical networks.

Privilege

VIEW

HTTP response codes

200

Example response body

	
{
    "@odata.context": "/api/$metadata#Collection(NetworkConfigurationService.Network)",
    "@odata.count": 3,
    "value": [
        {
            "@odata.type": "#NetworkConfigurationService.Network",
            "@odata.id": "/api/NetworkConfigurationService/Networks(10133)",
            "Id": 10133,
            "Name": "asd",
            "Description": "",
            "VlanMaximum": 2,
            "VlanMinimum": 2,
            "Type": 3,
            "CreatedBy": "system",
            "CreationTime": "1970-01-31 00:12:56.376",
            "UpdatedBy": null,
            "UpdatedTime": "1970-01-31 00:12:56.376",
            "InternalRefNWUUId": "00bc07d7-5d3c-429e-96a3-5c6600230851"
        },
        {
            "@odata.type": "#NetworkConfigurationService.Network",
            "@odata.id": "/api/NetworkConfigurationService/Networks(10134)",
            "Id": 10134,
            "Name": "Test",
            "Description": "test",
            "VlanMaximum": 1,
            "VlanMinimum": 1,
            "Type": 3,
            "CreatedBy": "system",
            "CreationTime": "1970-01-31 00:12:56.390",
            "UpdatedBy": null,
            "UpdatedTime": "1970-01-31 00:12:56.390",
            "InternalRefNWUUId": "5e74e25a-99db-41ce-ad9a-5bce07ba9094"
        },
        {
            "@odata.type": "#NetworkConfigurationService.Network",
            "@odata.id": "/api/NetworkConfigurationService/Networks(10135)",
            "Id": 10135,
            "Name": "se",
            "Description": "",
            "VlanMaximum": 10,
            "VlanMinimum": 10,
            "Type": 4,
            "CreatedBy": "system",
            "CreationTime": "1970-01-31 00:12:56.401",
            "UpdatedBy": null,
            "UpdatedTime": "1970-01-31 00:12:56.401",
            "InternalRefNWUUId": "8fc7c12f-780a-42db-96b1-830b8ef76335"
        }
    ]
}

Table 1. AttributesThis table lists the attributes that this method supports.
Attribute name	Description
Id	Unique identifier of the network.
Name	Name of the network.
Description	Description of the network.
VlanMaximum	VLan can be defined as either a range or a single value. If a single value is defined, the same value is assigned to both `VlanMaximum` and `VlanMinimum`.
VlanMinimum	VLan can be defined as either a range or a single value. If a single value is defined, the same value is assigned to both `VlanMaximum` and `VlanMinimum`. NOTE: To define a profile which is not in a range, the VlanMaximum and VlanMinimum need to be same.
Type	Network profile definition type. For more information, see /api/NetworkConfigurationService/NetworkTypes.
CreatedBy	The user who created the network.
CreationTime	Date and time when the network was created.
UpdatedBy	The user who last updated the network.
UpdatedTime	Date and time when the network was last updated.
Orderby	Order to apply to the output
InternalRefId	Reference ID used for internal purposes.