NetworkInterface

NetworkInterface
NetworkInterface

Represents a network interface.
HATEOAS links:
cloud-accounts - array[CloudAccount] - List of cloud accounts where this network domain exists.
security-groups - array[SecurityGroup] - List of security groups for this network interface.
self - NetworkInterface - Self link to this network interface

JSON Example
{
    "id": "9.0E49",
    "createdAt": "2012-09-27",
    "updatedAt": "2012-09-27",
    "owner": "[email protected]",
    "ownerType": "ad_group",
    "orgId": "42413b31-1716-477e-9a88-9dc1c3cb1cdf",
    "_links": {
        "empty": false
    },
    "name": "my-name",
    "description": "my-description",
    "externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
    "deviceIndex": 1,
    "addresses": [
        "10.1.2.190"
    ],
    "securityGroupIds": [
        "string"
    ],
    "externalRegionId": "ap-northeast-2",
    "tags": [
        {
            "key": "vmware.enumeration.type",
            "value": "nec2_net_interface"
        }
    ],
    "customProperties": {
        "awaitIp": "true"
    },
    "cloudAccountIds": [
        9e+49
    ]
}
string
id
Required

The id of this resource instance

string
createdAt
Optional

Date when the entity was created. The date is in ISO 8601 and UTC.

string
updatedAt
Optional

Date when the entity was last updated. The date is ISO 8601 and UTC.

string
owner
Optional

Email of the user or display name of the group that owns the entity.

string
ownerType
Optional

Type of a owner(user/ad_group) that owns the entity.

string
orgId
Optional

The id of the organization this entity belongs to.

object
_links
Required

HATEOAS of the entity

string
name
Optional

A human-friendly name used as an identifier in APIs that support this option.

string
description
Optional

A human-friendly description.

string
externalId
Optional

External entity Id on the provider side.

integer As int32 As int32
deviceIndex
Optional

The device index of this network interface.

array of string
addresses
Optional

A list of IP addresses allocated or in use by this network interface.

array of string
securityGroupIds
Optional

A list of security group ids this network interface is associated with

string
externalRegionId
Required

The external regionId of the network interface.

array of Tag
tags
Optional

A set of tag keys and optional values that were set on this network interface.

object
customProperties
Optional

Additional properties that may be used to extend the base type.

array of string
cloudAccountIds
Optional

Set of ids of the cloud accounts this entity belongs to.

Returned By