Skip to main content

AttachVmRequest

Request to connect a VM to a network.

vmIdstring<uuid>

Id of the VM to attach. Required.

ipAddress IPAddress (string)

IPv4 address to assign to the VM on this network. Omit to let the platform allocate one automatically.

addressFamilyAddressFamily (string)

Address family of the address (IPv4 or IPv6).

Possible values: [Unknown, Unspecified, Unix, InterNetwork, ImpLink, Pup, Chaos, NS, Ipx, Iso, Osi, Ecma, DataKit, Ccitt, Sna, DecNet, DataLink, Lat, HyperChannel, AppleTalk, NetBios, VoiceView, FireFox, Banyan, Atm, InterNetworkV6, Cluster, Ieee12844, Irda, NetworkDesigners, Max, Packet, ControllerAreaNetwork]

scopeIdinteger<int64>

IPv6 scope identifier of the address.

isIPv6Multicastboolean

Whether the address is an IPv6 multicast address.

isIPv6LinkLocalboolean

Whether the address is an IPv6 link-local address.

isIPv6SiteLocalboolean

Whether the address is an IPv6 site-local address.

isIPv6Teredoboolean

Whether the address is an IPv6 Teredo address.

isIPv6UniqueLocalboolean

Whether the address is an IPv6 unique-local address.

isIPv4MappedToIPv6boolean

Whether the address is an IPv4 address mapped into the IPv6 space.

addressinteger<int64>deprecated

IP address value.

AttachVmRequest
{
"vmId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"ipAddress": "192.168.0.1"
}