# VegaOsApi.InterfaceApi

All URIs are relative to *http://218.108.7.113:8080/*

Method | HTTP request | Description
------------- | ------------- | -------------
[**interfaceIfManagementIpGet**](InterfaceApi.md#interfaceIfManagementIpGet) | **GET** /interface/{if_management}/ip | Return IP status for management interface
[**interfaceIfManagementRoutesGet**](InterfaceApi.md#interfaceIfManagementRoutesGet) | **GET** /interface/{if_management}/routes | Return network routes for management interface
[**interfaceIfMgtGuestMacGet**](InterfaceApi.md#interfaceIfMgtGuestMacGet) | **GET** /interface/{if_mgt_guest}/mac | Return MAC address for mangement interface and guest interface
[**interfaceIfnameGet**](InterfaceApi.md#interfaceIfnameGet) | **GET** /interface/{ifname} | Return configurations for interface ifname
[**interfaceIfnameMaclearningGet**](InterfaceApi.md#interfaceIfnameMaclearningGet) | **GET** /interface/{ifname}/maclearning | Return MAC learning table for interface `ifname`
[**interfaceIfnamePatch**](InterfaceApi.md#interfaceIfnamePatch) | **PATCH** /interface/{ifname} | Modify configurations for interface `ifname`
[**interfaceIfnameStatusGet**](InterfaceApi.md#interfaceIfnameStatusGet) | **GET** /interface/{ifname}/status | Return interface status for interface `ifname`
[**interfacesGet**](InterfaceApi.md#interfacesGet) | **GET** /interfaces | Return configurations for all interfaces
[**interfacesMaclearningGet**](InterfaceApi.md#interfacesMaclearningGet) | **GET** /interfaces/maclearning | Return MAC learning table for all interfaces
[**interfacesPatch**](InterfaceApi.md#interfacesPatch) | **PATCH** /interfaces | Modify configurations for all interfaces


<a name="interfaceIfManagementIpGet"></a>
# **interfaceIfManagementIpGet**
> interfaceIfManagementIpGet(ifManagement)

Return IP status for management interface

Return IP status for management interface. Shows both statically configured and dynamically assigned (DHCP) IPs

### Example
```javascript
var VegaOsApi = require('vega_os_api');
var defaultClient = VegaOsApi.ApiClient.default;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new VegaOsApi.InterfaceApi();

var ifManagement = "ifManagement_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.interfaceIfManagementIpGet(ifManagement, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ifManagement** | **String**|  | 

### Return type

null (empty response body)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="interfaceIfManagementRoutesGet"></a>
# **interfaceIfManagementRoutesGet**
> interfaceIfManagementRoutesGet(ifManagement)

Return network routes for management interface

Return network routes for management interface, Shows both statically configured and dynamically assigned (DHCP) routes.

### Example
```javascript
var VegaOsApi = require('vega_os_api');
var defaultClient = VegaOsApi.ApiClient.default;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new VegaOsApi.InterfaceApi();

var ifManagement = "ifManagement_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.interfaceIfManagementRoutesGet(ifManagement, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ifManagement** | **String**|  | 

### Return type

null (empty response body)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="interfaceIfMgtGuestMacGet"></a>
# **interfaceIfMgtGuestMacGet**
> interfaceIfMgtGuestMacGet(ifMgtGuest)

Return MAC address for mangement interface and guest interface

Return MAC address for management interface and guest interface

### Example
```javascript
var VegaOsApi = require('vega_os_api');
var defaultClient = VegaOsApi.ApiClient.default;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new VegaOsApi.InterfaceApi();

var ifMgtGuest = "ifMgtGuest_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.interfaceIfMgtGuestMacGet(ifMgtGuest, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ifMgtGuest** | **String**|  | 

### Return type

null (empty response body)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="interfaceIfnameGet"></a>
# **interfaceIfnameGet**
> interfaceIfnameGet(ifname)

Return configurations for interface ifname

Return configurations for interface ifname

### Example
```javascript
var VegaOsApi = require('vega_os_api');
var defaultClient = VegaOsApi.ApiClient.default;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new VegaOsApi.InterfaceApi();

var ifname = "ifname_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.interfaceIfnameGet(ifname, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ifname** | **String**|  | 

### Return type

null (empty response body)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="interfaceIfnameMaclearningGet"></a>
# **interfaceIfnameMaclearningGet**
> interfaceIfnameMaclearningGet(ifname)

Return MAC learning table for interface &#x60;ifname&#x60;

Return MAC learning table for interface &#x60;ifname&#x60;

### Example
```javascript
var VegaOsApi = require('vega_os_api');
var defaultClient = VegaOsApi.ApiClient.default;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new VegaOsApi.InterfaceApi();

var ifname = "ifname_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.interfaceIfnameMaclearningGet(ifname, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ifname** | **String**|  | 

### Return type

null (empty response body)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="interfaceIfnamePatch"></a>
# **interfaceIfnamePatch**
> interfaceIfnamePatch(ifnameinterfaceConf)

Modify configurations for interface &#x60;ifname&#x60;

Modify configurations for interface &#x60;ifname&#x60;

### Example
```javascript
var VegaOsApi = require('vega_os_api');
var defaultClient = VegaOsApi.ApiClient.default;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new VegaOsApi.InterfaceApi();

var ifname = "ifname_example"; // String | 

var interfaceConf = new VegaOsApi.InterfaceConf(); // InterfaceConf | Interface config


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.interfaceIfnamePatch(ifnameinterfaceConf, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ifname** | **String**|  | 
 **interfaceConf** | [**InterfaceConf**](InterfaceConf.md)| Interface config | 

### Return type

null (empty response body)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="interfaceIfnameStatusGet"></a>
# **interfaceIfnameStatusGet**
> interfaceIfnameStatusGet(ifname)

Return interface status for interface &#x60;ifname&#x60;

Return interface status for interface &#x60;ifname&#x60;, NOTE: virtual interfaces may return &#x60;unknown&#x60;

### Example
```javascript
var VegaOsApi = require('vega_os_api');
var defaultClient = VegaOsApi.ApiClient.default;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new VegaOsApi.InterfaceApi();

var ifname = "ifname_example"; // String | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.interfaceIfnameStatusGet(ifname, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **ifname** | **String**|  | 

### Return type

null (empty response body)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="interfacesGet"></a>
# **interfacesGet**
> interfacesGet()

Return configurations for all interfaces

Return configurations for all interfaces

### Example
```javascript
var VegaOsApi = require('vega_os_api');
var defaultClient = VegaOsApi.ApiClient.default;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new VegaOsApi.InterfaceApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.interfacesGet(callback);
```

### Parameters
This endpoint does not need any parameter.

### Return type

null (empty response body)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="interfacesMaclearningGet"></a>
# **interfacesMaclearningGet**
> interfacesMaclearningGet()

Return MAC learning table for all interfaces

Return MAC learning table for all interfaces

### Example
```javascript
var VegaOsApi = require('vega_os_api');
var defaultClient = VegaOsApi.ApiClient.default;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new VegaOsApi.InterfaceApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.interfacesMaclearningGet(callback);
```

### Parameters
This endpoint does not need any parameter.

### Return type

null (empty response body)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="interfacesPatch"></a>
# **interfacesPatch**
> interfacesPatch()

Modify configurations for all interfaces

Modify configurations for all interfaces

### Example
```javascript
var VegaOsApi = require('vega_os_api');
var defaultClient = VegaOsApi.ApiClient.default;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME';
basicAuth.password = 'YOUR PASSWORD';

var apiInstance = new VegaOsApi.InterfaceApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.interfacesPatch(callback);
```

### Parameters
This endpoint does not need any parameter.

### Return type

null (empty response body)

### Authorization

[basicAuth](../README.md#basicAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json