/system/erps_rings/{ERPS_Ring.id}/instances/{ERPS_Ring_Instance.instance_id}

patch

https://switch-ip/rest/v10.13/system/erps_rings/{ERPS_Ring.id}/instances/{ERPS_Ring_Instance.instance_id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

ERPS_Ring.id

string

required

Reference Resource: ERPS_Ring
Unique identifier of the ring.

ERPS_Ring_Instance.instance_id

string

required

Reference Resource: ERPS_Ring_Instance
Instances of the ring.

Body Params

protected_vlans

array of strings

length ≤ 4094

Reference Resource: VLAN
Set of datapath VLANs that will be managed by this instance. If the control VLAN is included here, it will be ignored.

protected_vlans

control_vlan

string

Reference Resource: VLAN
VLAN used by this ring instance for exchanging R-APS packets.

recovery_mode

string

enum

Recovery mode for this instance. This is only applicable when the node is an RPL owner for this instance.

Allowed:

rpl_port

string

enum

Specifies the ring protection link port.

Allowed:

description

string

length ≤ 256

Free form description of the ring instance.

instance_id

integer

required

Reference Resource: ERPS_Ring_Instance
Instances of the ring.

enable

boolean

Enables the ring instance.

role

string

enum

Role of the node in the instance. If role is not specified, it is a regular node. 'rpl_owner': blocks traffic on the rpl port in steady state and sends periodic R-APS packets on both ports of the ring. 'rpl_neighbour': blocks traffic on the rpl port in steady state but does not generate any R-APS packet.

Allowed:

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

415

Unsupported Media Type

500

Internal Server Error

501

Not Implemented

503

Service Unavailable

Language

Loading…

Response

Click Try It! to start a request and see the response here!