Appliance Networking Interfaces get

Appliance Networking Interfaces get

Get information about a particular network interface.

Request
URI
GET
https://{api_host}/api/appliance/networking/interfaces/{interface_name}
COPY
Path Parameters
string
interface_name
Required

Network interface, for example, "nic0".

The parameter must be an identifier for the resource type: com.vmware.appliance.networking.interfaces.

Authentication
This operation uses the following authentication methods.
Responses
200

Network interface information.

Returns Appliance Networking Interfaces InterfaceInfo of type(s) application/json 
{
    "name": "string",
    "status": "string",
    "mac": "string",
    "ipv4": {
        "configurable": false,
        "mode": "string",
        "address": "string",
        "prefix": 0,
        "default_gateway": "string"
    },
    "ipv6": {
        "dhcp": false,
        "autoconf": false,
        "addresses": [
            {
                "origin": "string",
                "status": "string",
                "address": "string",
                "prefix": 0
            }
        ],
        "default_gateway": "string",
        "configurable": false
    }
}
string
name
Required

Interface name, for example, "nic0", "nic1".

string
status
Required

Interface status.

For more information see: Appliance Networking Interfaces InterfaceStatus.

string
mac
Required

MAC address. For example 00:0C:29:94:BB:5A.

ipv4
Optional

IPv4 Address information.

This property was added in vSphere API 6.7.

ipv4 This property will be missing or null if IPv4 is not enabled.

ipv6
Optional

IPv6 Address information.

This property was added in vSphere API 6.7.

ipv6 This property will be missing or null if IPv6 is not enabled.


404

if the specified interface is not found.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0 
"Vapi Std Errors NotFound Object"

500

Generic error

Returns Vapi Std Errors Error of type(s) application/json 
"Vapi Std Errors Error Object"
array of object
messages
Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string
error_type
Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/appliance/networking/interfaces/{interface_name}
On This Page
Appliance Operations
GET
Appliance Networking Interfaces list
GET
Appliance Networking Interfaces get