interface_groups¶
Overview¶
API to add, modify, delete, and get interface groups.
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP
Tags¶
- interface_groups : Operations related to interface_groups
Paths¶
POST operation for interface_groups¶
POST /interface_groups
Description¶
Use this operation to add interface group
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource successfully added | interface_groups_post_success_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Produces¶
application/json
Tags¶
- interface_groups
Get operation for interface_groups¶
GET /interface_groups
Description¶
Use this operation to get the list of interface groups
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | interface_groups_response_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Produces¶
application/json
Tags¶
- interface_groups
PUT operation for interface_groups¶
PUT /interface_groups
Description¶
Use this operation to modify a Virtual IP address
Parameters¶
| Type | Name | Schema |
|---|---|---|
| Body | body optional |
interface_groups_request_schema |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource modified added | interface_groups_put_success_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- interface_groups
DELETE operation for interface_groups¶
DELETE /interface_groups/{deletePathParam}
Description¶
Use this operation to delete an interface group.
Parameters¶
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | deletePathParam required |
Object Primary Key for DELETE operation | object |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource delete added | interface_groups_delete_success_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Produces¶
application/json
Tags¶
- interface_groups
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
bridge_pair¶
Add brige pair associated with the group
Type : < bridge_pair > array
| Name | Description | Schema |
|---|---|---|
| device_one optional |
device one which forms the bridge pair | string |
| device_two optional |
device two which forms the bridge pair | string |
| lsp_enabled optional |
If enabled, the link state of the bridge pair are synchronized | boolean |
bypass_mode¶
The behavior of bridge-paired interfaces in the Interface Group in the event of Appliance/Service restart or failure.
Type : enum (fail_to_wire, fail_to_block)
eth_interfaces¶
Give interface id to be included in ethernet interface
Type : < string > array
id¶
Type : integer
interface_groups¶
| Name | Schema |
|---|---|
| bridge_pair optional |
bridge_pair |
| bypass_mode optional |
bypass_mode |
| eth_interfaces optional |
eth_interfaces |
| id optional |
id |
| is_bridged optional |
is_bridged |
| package_name optional |
package_name |
| security optional |
security |
| site_name optional |
site_name |
| virtual_interfaces optional |
virtual_interfaces |
| wccp optional |
wccp |
interface_groups_delete_success_schema¶
| Name | Schema |
|---|---|
| interface_groups optional |
interface_groups |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
interface_groups_post_success_schema¶
| Name | Schema |
|---|---|
| interface_groups optional |
interface_groups |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
interface_groups_put_success_schema¶
| Name | Schema |
|---|---|
| interface_groups optional |
interface_groups |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
interface_groups_request_schema¶
| Name | Schema |
|---|---|
| interface_groups optional |
interface_groups |
interface_groups_response_schema¶
Type : < interface_groups_response_schema > array
interface_groups_response_schema
| Name | Schema |
|---|---|
| bridge_pair optional |
bridge_pair |
| bypass_mode optional |
bypass_mode |
| eth_interfaces optional |
eth_interfaces |
| id optional |
id |
| is_bridged optional |
is_bridged |
| package_name optional |
package_name |
| security optional |
security |
| site_name optional |
site_name |
| virtual_interfaces optional |
virtual_interfaces |
| wccp optional |
wccp |
is_bridged¶
Enable bridge pairs between the selected interfaces.
Type : boolean
package_name¶
Config package name using which the site API operation should be performed.
Type : string
security¶
The security of the Interface Group's network segment. Trusted segments are generally protected by a firewall.
Type : enum (trusted, untrusted)
site_name¶
Site Name in which interface group should be added.
Type : string
virtual_interfaces¶
List of virtual interfaces associated with the interface group.
Type : < virtual_interfaces > array
| Name | Description | Schema |
|---|---|---|
| client_mode optional |
The client mode can be DHCP, Static/Dynamic PPPOE for this interface. | string |
| dhcp_client optional |
The client mode can be DHCP, Static/Dynamic PPPOE for this interface. | boolean |
| firewall_zone optional |
Firewall zone | string |
| name optional |
A name by which the Virtual Interface will be referenced. | string |
| pppoe_ac_name optional |
PPPOE Account Name | string |
| pppoe_auth_type optional |
PPPOE Authentication type can be auto, pap, chap, eap | string |
| pppoe_password optional |
PPPOE user password | string |
| pppoe_reconnect_hold_off_time optional |
Wait time in seconds after which PPPOE sessions try to reconnect | integer |
| pppoe_service_name optional |
PPPOE service name | string |
| pppoe_username optional |
PPPOE user name | string |
| routing_domain optional |
routing domain | string |
| vlan_id optional |
The ID for identifying and marking traffic to and from the Virtual Interface. An ID of '0' may be used for native/untagged traffic. | integer |
wccp¶
Enabling this feature will cause the corresponding routing domain's TCP traffic to be redirected to the SD-WAN Optimization appliance for optimization. The listener should be enabled on interface groups with only ONE ethernet interface.
Type : boolean