VSphereAutomation::Appliance::NetworkingInterfacesApi

All URIs are relative to https://<vcenter>/rest

Method HTTP request Description
get GET /appliance/networking/interfaces/interface_name Get information about a particular network interface.
list GET /appliance/networking/interfaces Get list of available network interfaces, including those that are not yet configured.

get

ApplianceNetworkingInterfacesResult get(interface_name)

Get information about a particular network interface.

Example

# load the gem
require 'vsphere-automation-appliance'
# setup authorization
VSphereAutomation::Configuration.new.tap do |config|
  # Configure API key authorization: api_key
  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
end

api_instance = VSphereAutomation::Appliance::NetworkingInterfacesApi.new
interface_name = 'interface_name_example' # String | Network interface, for example, \"nic0\".

begin
  #Get information about a particular network interface.
  result = api_instance.get(interface_name)
  p result
rescue VSphereAutomation::ApiError => e
  puts "Exception when calling NetworkingInterfacesApi->get: #{e}"
end

Parameters

Name Type Description Notes
interface_name String Network interface, for example, &quot;nic0&quot;.

Return type

ApplianceNetworkingInterfacesResult

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

list

ApplianceNetworkingInterfacesListResult list

Get list of available network interfaces, including those that are not yet configured.

Example

# load the gem
require 'vsphere-automation-appliance'
# setup authorization
VSphereAutomation::Configuration.new.tap do |config|
  # Configure API key authorization: api_key
  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
end

api_instance = VSphereAutomation::Appliance::NetworkingInterfacesApi.new

begin
  #Get list of available network interfaces, including those that are not yet configured.
  result = api_instance.list
  p result
rescue VSphereAutomation::ApiError => e
  puts "Exception when calling NetworkingInterfacesApi->list: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

ApplianceNetworkingInterfacesListResult

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json