OpenManage Enterprise Version 3.3.1 and OpenManage Enterprise - Modular Edition Version 1.10.00 RESTful API Guide

NOTE: The interface name of the network adapter in an appliance varies based on the hypervisor.

Description

This method configures the network adapter.

Privilege

APPLIANCE_SETUP

HTTP response code

200

Example for primary interface

Example request body

 {
    "InterfaceName": "ens33",
    "ProfileName": "ens33",
    "EnableNIC": true,
    "Ipv4Configuration": {
        "Enable": true,
        "EnableDHCP": true,
        "StaticIPAddress": "",
        "StaticSubnetMask": "",
        "StaticGateway": "",
        "UseDHCPForDNSServerNames": true,
        "StaticPreferredDNSServer": "",
        "StaticAlternateDNSServer": ""
    },
    "Ipv6Configuration": {
        "Enable": false,
        "EnableAutoConfiguration": false,
        "StaticIPAddress": "",
        "StaticPrefixLength": 0,
        "StaticGateway": "",
        "UseDHCPForDNSServerNames": false,
        "StaticPreferredDNSServer": "",
        "StaticAlternateDNSServer": ""
    },
    "ManagementVLAN": {
        "EnableVLAN": false,
        "Id": 0
    },
    "DnsConfiguration": {
        "RegisterWithDNS": false,
        "DnsName": "",
        "UseDHCPForDNSDomainName": false,
        "DnsDomainName": "",
        "FqdndomainName": "",
        "Ipv4CurrentPreferredDNSServer": "",
        "Ipv4CurrentAlternateDNSServer": "",
        "Ipv6CurrentPreferredDNSServer": "",
        "Ipv6CurrentAlternateDNSServer": ""
    },
    "Delay": 0,
    "PrimaryInterface": true
}

Example for primary interface

Example response body

{
    "Id": 10085,
    "JobName": "OMERealtime_Task",
    "JobDescription": "Generic OME runtime task",
    "NextRun": null,
    "LastRun": null,
    "StartTime": null,
    "EndTime": null,
    "Schedule": "startnow",
    "State": "Enabled",
    "CreatedBy": "system",
    "UpdatedBy": null,
    "LastRunStatus": {
        "Id": 2080,
        "Name": "New"
    },
    "JobType": {
        "Id": 207,
        "Name": "OMERealtime_Task",
        "Internal": true
    },
    "JobStatus": {
        "Id": 2080,
        "Name": "New"
    },
    "Targets": [],
    "Params": [
        {
            "JobId": 10085,
            "Key": "Nmcli_Update",
            "Value": "{\"interfaceName\":\"ens36\",\"profileName\":\"ens36\",\"enableNIC\":true,\"ipv4Configuration\":{\"enable\":true,\"enableDHCP\":true,\"staticIPAddress\":\"\",\"staticSubnetMask\":\"\",\"staticGateway\":\"\",\"useDHCPForDNSServerNames\":false,\"staticPreferredDNSServer\":\"\",\"staticAlternateDNSServer\":\"\"},\"ipv6Configuration\":{\"enable\":true,\"enableAutoConfiguration\":true,\"staticIPAddress\":\"\",\"staticPrefixLength\":0,\"staticGateway\":\"\",\"useDHCPForDNSServerNames\":false,\"staticPreferredDNSServer\":\"\",\"staticAlternateDNSServer\":\"\"},\"managementVLAN\":{\"enableVLAN\":false,\"id\":0},\"dnsConfiguration\":{\"registerWithDNS\":false,\"dnsName\":\"\",\"useDHCPForDNSDomainName\":false,\"dnsDomainName\":\"\",\"ipv4CurrentPreferredDNSServer\":\"\",\"ipv4CurrentAlternateDNSServer\":\"\",\"ipv6CurrentPreferredDNSServer\":\"\",\"ipv6CurrentAlternateDNSServer\":\"\",\"fqdndomainName\":\"\"},\"currentSettings\":{\"ipv4Address\":[],\"ipv4Gateway\":\"\",\"ipv4Dns\":[],\"ipv4Domain\":\"\",\"ipv6Address\":[],\"ipv6LinkLocalAddress\":\"\",\"ipv6Gateway\":\"\",\"ipv6Dns\":[],\"ipv6Domain\":\"\"},\"delay\":0,\"primaryInterface\":false,\"modifiedConfigs\":{}}"
        }
    ],
    "Visible": true,
    "Editable": true,
    "Builtin": false
}

Example for secondary interface

Example request body

{
            "InterfaceName": "ens36",
            "ProfileName": "ens36",
            "EnableNIC": true,
            "Ipv4Configuration": {
                "Enable": false,
                "EnableDHCP": false,
                "StaticIPAddress": "",
                "StaticSubnetMask": "",
                "StaticGateway": ""
            },
            "Ipv6Configuration": {
                "Enable": true,
                "EnableAutoConfiguration": true,
                "StaticIPAddress": "",
                "StaticPrefixLength": 0,
                "StaticGateway": ""
            },
            "ManagementVLAN": {
                "EnableVLAN": false,
                "Id": 0
            },
            "Delay": 0,
            "PrimaryInterface": false
        }

Example for secondary interface

Example response body

{
    "Id": 10085,
    "JobName": "OMERealtime_Task",
    "JobDescription": "Generic OME runtime task",
    "NextRun": null,
    "LastRun": null,
    "StartTime": null,
    "EndTime": null,
    "Schedule": "startnow",
    "State": "Enabled",
    "CreatedBy": "system",
    "UpdatedBy": null,
    "LastRunStatus": {
        "Id": 2080,
        "Name": "New"
    },
    "JobType": {
        "Id": 207,
        "Name": "OMERealtime_Task",
        "Internal": true
    },
    "JobStatus": {
        "Id": 2080,
        "Name": "New"
    },
    "Targets": [],
    "Params": [
        {
            "JobId": 10085,
            "Key": "Nmcli_Update",
            "Value": "{\"interfaceName\":\"ens36\",\"profileName\":\"ens36\",\"enableNIC\":true,\"ipv4Configuration\":{\"enable\":true,\"enableDHCP\":true,\"staticIPAddress\":\"\",\"staticSubnetMask\":\"\",\"staticGateway\":\"\",\"useDHCPForDNSServerNames\":false,\"staticPreferredDNSServer\":\"\",\"staticAlternateDNSServer\":\"\"},\"ipv6Configuration\":{\"enable\":true,\"enableAutoConfiguration\":true,\"staticIPAddress\":\"\",\"staticPrefixLength\":0,\"staticGateway\":\"\",\"useDHCPForDNSServerNames\":false,\"staticPreferredDNSServer\":\"\",\"staticAlternateDNSServer\":\"\"},\"managementVLAN\":{\"enableVLAN\":false,\"id\":0},\"dnsConfiguration\":{\"registerWithDNS\":false,\"dnsName\":\"\",\"useDHCPForDNSDomainName\":false,\"dnsDomainName\":\"\",\"ipv4CurrentPreferredDNSServer\":\"\",\"ipv4CurrentAlternateDNSServer\":\"\",\"ipv6CurrentPreferredDNSServer\":\"\",\"ipv6CurrentAlternateDNSServer\":\"\",\"fqdndomainName\":\"\"},\"currentSettings\":{\"ipv4Address\":[],\"ipv4Gateway\":\"\",\"ipv4Dns\":[],\"ipv4Domain\":\"\",\"ipv6Address\":[],\"ipv6LinkLocalAddress\":\"\",\"ipv6Gateway\":\"\",\"ipv6Dns\":[],\"ipv6Domain\":\"\"},\"delay\":0,\"primaryInterface\":false,\"modifiedConfigs\":{}}"
        }
    ],
    "Visible": true,
    "Editable": true,
    "Builtin": false
}