VMInterface

Read only API that can retrieve the VM interface associated with a domain, zone or subnet for mediation created VM's for REST created VM interfaces you need to set the additional proxy header in http request : X-Nuage-ProxyUservalue of the header has to be either :1) enterpriseName@UserName (example :bob@Alcatel Lucent), or 2) external ID of user in VSD, typically is UUID generally decided by the CMS tool in questionUser needs to have CMS privileges to use proxy user header.

Overview

associatedFloatingIPAddress string
attachedNetworkID string
attachedNetworkType enum (L2DOMAIN | SUBNET)
domainID string
domainName string
entityScope enum (ENTERPRISE | GLOBAL) autogenerated   filterable   orderable  
externalID string filterable   orderable   locally unique  
gateway string
IPAddress string filterable   orderable  
lastUpdatedBy string autogenerated  
MAC string filterable   orderable  
multiNICVPortName string
name string filterable   orderable  
netmask string
networkName string
policyDecisionID string
tierID string
VMUUID string filterable  
VPortID string
VPortName string
zoneID string
zoneName string

API Resource

/vminterfaces/id
delete get put

Parents

/zones/id/vminterfaces
get
/vports/id/vminterfaces
get
/subnets/id/vminterfaces
get
/domains/id/vminterfaces
get
/l2domains/id/vminterfaces
get
/vminterfaces
get
/vms/id/vminterfaces
get post

Children

/vminterfaces/id/tcas
get
/vminterfaces/id/redirectiontargets
get
/vminterfaces/id/metadatas
get post
/vminterfaces/id/dhcpoptions
get
/vminterfaces/id/globalmetadatas
get post put
/vminterfaces/id/policydecisions
get
/vminterfaces/id/policygroups
get
/vminterfaces/id/staticroutes
get
/vminterfaces/id/statistics
get
/vminterfaces/id/multicastchannelmaps
get
/vminterfaces/id/eventlogs
get

Members

This object has no members.

Attributes documentation

associatedFloatingIPAddress string
Discussion

Floating Ip Address of this network interface eg: 10.1.2.1

Charateristics

Format: free
SDK attribute: associatedFloatingIPAddress

attachedNetworkID string
Discussion

ID of the l2 domain or Subnet that the VM is attached to

Charateristics

Format: free
SDK attribute: attachedNetworkID

attachedNetworkType enum
Discussion

l2 domain or Subnet that the interface is attached to

Charateristics

Allowed values: L2DOMAIN, SUBNET
SDK attribute: attachedNetworkType

domainID string
Discussion

ID of the domain that the VM is attached to

Charateristics

Format: free
SDK attribute: domainID

domainName string
Discussion

Name of the domain that the VM is attached to

Charateristics

Format: free
SDK attribute: domainName

entityScope enum autogenerated   filterable   orderable  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
Format: free
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

gateway string
Discussion

Gateway of the subnet that the VM is connected to

Charateristics

Format: free
SDK attribute: gateway

IPAddress string filterable   orderable  
Discussion

IP address of the interface

Charateristics

Format: free
SDK attribute: IPAddress

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

MAC string filterable   orderable  
Discussion

MAC address of the interface

Charateristics

Format: free
SDK attribute: MAC

multiNICVPortName string
Discussion

Name of the Multi NIC VPort associated with this VM Interface

Charateristics

Format: free
SDK attribute: multiNICVPortName

name string filterable   orderable  
Discussion

Device name associated with this interface

Charateristics

Format: free
SDK attribute: name

netmask string
Discussion

Netmask of the subnet that the VM is attached to

Charateristics

Format: free
SDK attribute: netmask

networkName string
Discussion

Name of the network that the VM is attached to

Charateristics

Format: free
SDK attribute: networkName

policyDecisionID string
Discussion

The policy decision ID for this particular interface

Charateristics

Format: free
SDK attribute: policyDecisionID

tierID string
Discussion

ID of the tier that the interface is attached to.

Charateristics

Format: free
SDK attribute: tierID

VMUUID string filterable  
Discussion

UUID of the associated virtual machine

Charateristics

Format: free
SDK attribute: VMUUID

VPortID string
Discussion

ID of the vport that the interface is attached to

Charateristics

Format: free
SDK attribute: VPortID

VPortName string
Discussion

Name of the vport that the VM is attached to

Charateristics

Format: free
SDK attribute: VPortName

zoneID string
Discussion

ID of the zone that the interface is attached to

Charateristics

Format: free
SDK attribute: zoneID

zoneName string
Discussion

Name of the zone that the VM is attached to

Charateristics

Format: free
SDK attribute: zoneName