API vlan EN: различия между версиями

Материал из WiKi - UserSide
(Align EN API terminology with project localization)
(Fix Ukrainian API localization)
 
(не показана 1 промежуточная версия этого же участника)
Строка 1: Строка 1:
[[API_vlan|ru]] | '''en'''
'''en''' | [[API_vlan_UK|uk]] | [[API vlan|ru]]


Section '''[[API_EN|API]]''' ERP "UserSide"
Section '''[[API_EN|API]]''' ERP "UserSide"
Строка 14: Строка 14:


  Description: Add vlan
  Description: Add vlan
  Obligatory parameters:
  Required parameters:
   vid - VLAN ID
   vid - VLAN ID
   name - name
   name - name
Строка 31: Строка 31:


  Description: Edit vlan
  Description: Edit vlan
  Obligatory parameters:
  Required parameters:
   vid - VLAN ID
   vid - VLAN ID
  Optional parameters:
  Optional parameters:
Строка 44: Строка 44:


  Description: Get vlan list
  Description: Get vlan list
  Obligatory parameters:
  Required parameters:
   No
   No
  Optional parameters:
  Optional parameters:

Текущая версия от 11:38, 10 мая 2026

en | uk | ru

Section API ERP "UserSide"

Purpose: VLAN

Optional parameters:
action - request subcategory (possible value: see below)

Subcategories

add

Added in: 3.17dev1

Description: Add vlan
Required parameters:
 vid - VLAN ID
 name - name
Optional parameters:
 comment - notes

delete

Added in: 3.17dev1

Description: Delete vlan
Required parameters:
 vid - VLAN ID

edit

Added in: 3.17dev1

Description: Edit vlan
Required parameters:
 vid - VLAN ID
Optional parameters:
 name - name
 comment - notes

get_list

Modified in: 3.18beta1 (added vid parameter)

Added in: 3.17dev1

Description: Get vlan list
Required parameters:
 No
Optional parameters:
 vid - VLAN ID (this will list devices and ports with this VLAN)

customer_add_to_vlan

Added in: 3.19.49

Description: Add a customer to vlan

Required parameters:
 vid - VLAN ID
 customer_id - customer id

customer_remove_from_vlan

Added in: 3.19.49

Description: Remove a customer from vlan

Required parameters:
 vid - VLAN ID
 customer_id - customer id