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

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


Section '''[[API_EN|API]]''' ERP "UserSide"
Section '''[[API_EN|API]]''' ERP "UserSide"


Purpose: Vlan
Purpose: VLAN


  Optional parameters:
  Optional parameters:
Строка 14: Строка 14:


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


==== delete ====
==== delete ====
Строка 26: Строка 25:
  Description: Delete vlan
  Description: Delete vlan
  Required parameters:
  Required parameters:
   vid - vlan id
   vid - VLAN ID


==== edit ====
==== edit ====
Строка 32: Строка 31:


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


==== get_list ====
==== get_list ====
Строка 46: Строка 44:


  Description: Get vlan list
  Description: Get vlan list
  Obligatory parameters:
  Required parameters:
   No
   No
  Optional parameters:
  Optional parameters:
   vid - VlanID ''(this will list devices and ports with this Vlan)''
   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

Текущая версия от 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