interface_groups

Configuration Editor for API to add, modify, delete, and get interface groups. resource.

Read/write properties

is_bridged <Boolean>

Enable bridge pairs between the selected interfaces..

eth_interfaces <String[]>

Give interface id to be included in ethernet interface.

package_name <String>

Config package name using which the site API operation should be performed.. Minimum length = 1 Maximum length = 141

bypass_mode <String>

The behavior of bridge-paired interfaces in the Interface Group in the event of Appliance/Service restart or failure.. Possible values = [fail_to_wire,fail_to_block]

bridge_pair <bridge_pair_obj[]>

Add brige pair associated with the group.

security <String>

The security of the Interface Group's network segment. Trusted segments are generally protected by a firewall.. Possible values = [trusted,untrusted]

id <Integer>

.

site_name <String>

Site Name in which interface group should be added.. Minimum length = 1 Maximum length = 42

virtual_interfaces <virtual_interfaces_obj[]>

List of virtual interfaces associated with the interface group..

wccp <Boolean>

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..

Read only properties

Operations

add delete get (all) modify

[add]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/interface_groups

Description: Use this operation to add interface group

HTTP Method: POST

Request Payload: JSON

{"interface_groups": { "is_bridged":<Boolean_value> , "eth_interfaces":<String_value[]> , "package_name":<String_value> , "bypass_mode":<String_value> , "bridge_pair":[{ "device_two":<String_value> , "lsp_enabled":<Boolean_value> , "device_one":<String_value> }] , "security":<String_value> , "id":<Integer_value> , "site_name":<String_value> , "virtual_interfaces":[{ "firewall_zone":<String_value> , "name":<String_value> , "dhcp_client":<Boolean_value> , "routing_domain":<String_value> , "vlan_id":<Integer_value> }] , "wccp":<Boolean_value> }}

Response Payload: JSON

{ "interface_groups":{ "is_bridged":<Boolean_value>

, "eth_interfaces":<String_value> , "package_name":<String_value> , "bypass_mode":<String_value> , "bridge_pair":[{ "device_two":<String_value> , "lsp_enabled":<Boolean_value> , "device_one":<String_value> }], "security":<String_value> , "id":<Integer_value> , "site_name":<String_value> , "virtual_interfaces":[{ "firewall_zone":<String_value> , "name":<String_value> , "dhcp_client":<Boolean_value> , "routing_domain":<String_value> , "vlan_id":<Integer_value> }], "wccp":<Boolean_value> }]}

[delete]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/interface_groups/site_name=<String>,package_name=<String>

Description: Use this operation to delete an interface group.

HTTP Method: DELETE

Response Payload: JSON

{ "errorcode": 0, "message": "Done", "severity": <String;_value> }

[get (all)]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/interface_groups/package_name=<package_name>

Description: Use this operation to get the list of interface groups

HTTP Method: GET

Response Payload: JSON

{"interface_groups":[{ "is_bridged":<Boolean_value>

, "eth_interfaces":<String_value> , "package_name":<String_value> , "bypass_mode":<String_value> , "bridge_pair":[{ "device_two":<String_value> , "lsp_enabled":<Boolean_value> , "device_one":<String_value> }], "security":<String_value> , "id":<Integer_value> , "site_name":<String_value> , "virtual_interfaces":[{ "firewall_zone":<String_value> , "name":<String_value> , "dhcp_client":<Boolean_value> , "routing_domain":<String_value> , "vlan_id":<Integer_value> }], "wccp":<Boolean_value> }]}

[modify]{}

URL: http://<MGMT-IP>/sdwan/nitro/v1/config_editor/interface_groups

Description: Use this operation to modify a Virtual IP address

HTTP Method: PUT

Request Payload: JSON

{"interface_groups":{ "is_bridged":<Boolean_value> , "eth_interfaces":<String_value[]> , "package_name":<String_value> , "bypass_mode":<String_value> , "bridge_pair":[{ "device_two":<String_value> , "lsp_enabled":<Boolean_value> , "device_one":<String_value> }] , "security":<String_value> , "id":<Integer_value> , "site_name":<String_value> , "virtual_interfaces":[{ "firewall_zone":<String_value> , "name":<String_value> , "dhcp_client":<Boolean_value> , "routing_domain":<String_value> , "vlan_id":<Integer_value> }] , "wccp":<Boolean_value> }}

Response Payload: JSON

{ "interface_groups":[{ "is_bridged":<Boolean_value>

, "eth_interfaces":<String_value> , "package_name":<String_value> , "bypass_mode":<String_value> , "bridge_pair":[{ "device_two":<String_value> , "lsp_enabled":<Boolean_value> , "device_one":<String_value> }], "security":<String_value> , "id":<Integer_value> , "site_name":<String_value> , "virtual_interfaces":[{ "firewall_zone":<String_value> , "name":<String_value> , "dhcp_client":<Boolean_value> , "routing_domain":<String_value> , "vlan_id":<Integer_value> }], "wccp":<Boolean_value> }]}