Skip to content

Latest commit

 

History

History
174 lines (110 loc) · 5.94 KB

VMNetworkAdaptersManagementApi.md

File metadata and controls

174 lines (110 loc) · 5.94 KB

\VMNetworkAdaptersManagementApi

All URIs are relative to http://localhost/api

Method HTTP request Description
CreateNICDevice Post /vms/{id}/nic Creates a network adapter in the VM
DeleteNICDevice Delete /vms/{id}/nic/{index} Deletes a VM network adapter
GetAllNICDevices Get /vms/{id}/nic Returns all network adapters in the VM
GetIPAddress Get /vms/{id}/ip Returns the IP address of a VM
GetNicInfo Get /vms/{id}/nicips Returns the IP stack configuration of all NICs of a VM
UpdateNICDevice Put /vms/{id}/nic/{index} Updates a network adapter in the VM

CreateNICDevice

NicDevice CreateNICDevice(ctx, id, parameters) Creates a network adapter in the VM

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID of VM
parameters NicDeviceParameter Parameters of network adapter to create

Return type

NicDevice

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.vmware.vmw.rest-v1+json
  • Accept: application/vnd.vmware.vmw.rest-v1+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteNICDevice

DeleteNICDevice(ctx, id, index) Deletes a VM network adapter

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID of VM
index string Index of VM network adapter

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.vmware.vmw.rest-v1+json
  • Accept: application/vnd.vmware.vmw.rest-v1+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllNICDevices

NicDevices GetAllNICDevices(ctx, id) Returns all network adapters in the VM

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID of VM

Return type

NicDevices

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.vmware.vmw.rest-v1+json
  • Accept: application/vnd.vmware.vmw.rest-v1+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetIPAddress

InlineResponse200 GetIPAddress(ctx, id) Returns the IP address of a VM

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID of VM

Return type

InlineResponse200

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.vmware.vmw.rest-v1+json
  • Accept: application/vnd.vmware.vmw.rest-v1+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetNicInfo

NicIpStackAll GetNicInfo(ctx, id) Returns the IP stack configuration of all NICs of a VM

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID of VM

Return type

NicIpStackAll

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.vmware.vmw.rest-v1+json
  • Accept: application/vnd.vmware.vmw.rest-v1+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateNICDevice

NicDevice UpdateNICDevice(ctx, id, index, parameters) Updates a network adapter in the VM

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string ID of VM
index string Index of VM network adapter
parameters NicDeviceParameter Parameters of network adapter to update to

Return type

NicDevice

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/vnd.vmware.vmw.rest-v1+json
  • Accept: application/vnd.vmware.vmw.rest-v1+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]