Patch Machine Network Interface

Patch Machine Network Interface

Patch network interface with a given id for specific machine. Only name, description, IPv4 address and custom property updates are supported. The change to name and IPv4 address will not propagate to cloud endpoint for provisioned machines.

Request
URI
PATCH
https://vra-interop-222-139.lvn.broadcom.net/iaas/api/machines/{id}/network-interfaces/{networkId}
COPY
Path Parameters
string
id
Required

The ID of the machine.

string
networkId
Required

The ID of the network interface.

Query Parameters
string
apiVersion
Required

The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

Request Body

NetworkInterface Specification

UpdateNetworkInterfaceSpecification of type(s) application/json
Required 
{
    "description": "string",
    "customProperties": {
        "customProperties": "string"
    },
    "name": "string",
    "address": "string"
}
string
description
Optional

Describes the network interface of the machine within the scope of your organization and is not propagated to the cloud

object
customProperties
Optional

Additional custom properties that may be used to extend the machine. Internal custom properties (for example, prefixed with: "__") can not be updated.

string
name
Optional

Network interface name used during machine network interface provisioning. This property only takes effect if it is set before machine provisioning starts. The change will not propagate to cloud endpoint for provisioned machines.

string
address
Optional

Set IPv4 address for the machine network interface. The change will not propagate to cloud endpoint for provisioned machines.

Authentication
This operation uses the following authentication methods.
Responses
200

Successful operation

Returns NetworkInterface of type(s) application/json 
"NetworkInterface Object"
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 object
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.


403

Forbidden

Returns ServiceErrorResponse of type(s) application/json 
"ServiceErrorResponse Object"
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


404

Not found

Returns ServiceErrorResponse of type(s) application/json 
"ServiceErrorResponse Object"
string
message
Optional

message

string
messageId
Optional

messageId

array of string
stackTrace
Optional

stackTrace

integer As int32 As int32
statusCode
Optional

statusCode

integer As int32 As int32
errorCode
Optional

errorCode

array of string
details
Optional

details

string
serverErrorId
Optional

serverErrorId

string
documentKind
Optional

documentKind

integer As int32 As int32
internalErrorCode
Optional

internalErrorCode


Code Samples
COPY
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'
On This Page
Network Operations
GET
Get Machine Network Interface
PATCH
Patch Machine Network Interface