Versions Compared

Old Version 7

changes.mady.by.user The Force

Saved on

compared with

New Version Current

changes.mady.by.user The Force

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from this space and version 8.0.0

VLAN

Warning
ProVision's APIv1 system has been replaced by APIv2, and is now considered deprecated. 

Table of Contents

Table of Contents

 


getById

URLapi/v1/api.php?target=vlan&action=getById
Descriptionget information of a vlan
Returns

Examples

SUCCESSFUL{"success":1,"message":"1 VLAN found. ","data":[{"id":"11190","vlan":"176","domain_id":"1","resource_id":null,"name":"","domain_name":"DefaultDomain","tags":[],"tagsString":[]}]}
ERROR{ "success":0, "message":"error message" }


Required Parameters


NameTypeExampleDescription
idINTEGER11190ID of the VLAN


Optional Parameters

None

Example URLapi/v1/api.php?target=vlan&action=getById&id=11190

...

getDomains

URLapi/v1/api.php?target=vlan&action=getDomains
Descriptionget list and info of all domains or a specific domain. When specifying the domain the results will include tag info
Returns

Examples

SUCCESSFUL

{"success":1,"message":"6 Domains found. ","data":[{"id":"1","domain":"DefaultDomain","attr_6c":{"range":"S","restricted":[1,1002,1003,1004,1005]},"vlans":[{"id":"22866","vlan":"10","name":""},{"id":"1","vlan":"101","name":""},{"id":"3","vlan":"102","name":""},{"id":"22865","vlan":"104","name":""},{"id":"4","vlan":"105","name":"NewName"},{"id":"5","vlan":"106","name":"ThisIsAName"},{"id":"2","vlan":"107","name":""},{"id":"11189","vlan":"175","name":"SomeWhoCallMeTim"},{"id":"11190","vlan":"176","name":""},{"id":"11191","vlan":"177","name":""},{"id":"11192","vlan":"178","name":""},{"id":"7","vlan":"996","name":""},{"id":"8","vlan":"997","name":""},{"id":"9","vlan":"998","name":""},{"id":"10","vlan":"999","name":"CORP-DMZ"},{"id":"6","vlan":"1021","name":""}],"vlans_unnamed":null,"type":"domain","util":{"S":{"used":15,"total":1000}}},{"id":"2","domain":"6connect.com","attr_6c":{"range":"S","restricted":[1,1002,1003,1004,1005]},"vlans":[{"id":"19","vlan":"10","name":""},{"id":"20","vlan":"11","name":""},

...

{"id":"12755","vlan":"70","name":""},{"id":"12756","vlan":"71","name":""},{"id":"12757","vlan":"72","name":""},{"id":"12758","vlan":"73","name":""},{"id":"12759","vlan":"74","name":""},{"id":"12760","vlan":"75","name":""}],"vlans_unnamed":null,"type":"domain","util":{"S":{"used":38,"total":1000},"E":{"used":0,"total":3089}}}]}

ERROR{ "success":0, "message":"error message" }


Required Parameters

None 


Optional Parameters


NameTypeExampleDescription
idINTEGER2ID of the domain


Example URLapi/v1/api.php?target=vlan&action=getDomains&id=2

...

update

URLapi/v1/api.php?target=vlan&action=update
DescriptionUpdate properties of a VLAN: name, tags, or both.
Returns

Examples

SUCCESSFUL{"success":1,"message":"VLAN (table ID 11735) updated","id":"11735","data":[{"id":"11735","vlan":"50","domain_id":"7","resource_id":null,"name":"","domain_name":"lax.com","tags":[],"tagsString":[]}]}
ERROR{ "success":0, "message":"error message" }


Required Parameters


NameTypeExampleDescription
idINTEGER11735VLAN record ID (which is “id” of the VLANs in “get” action results)


Optional Parameters


NameTypeExampleDescription
nameSTRING or empty stringHQname of the VLAN
tagsINTEGER or STRING or empty string111,112

ID of tags to be assigned to this VLAN. Multiple tags IDs are assignable with a comma delimiter.

Empty parameter will result in no tags being assigned.

enabledBOOLEANfalseSet the VLAN as enabled (true) or disabled (false).


Example URL

api/v1/api.php?target=vlan&action=update&id=11735&name=OReilly&tags=156,159

api/v1/api.php?target=vlan&action=update&id=11735&name=OReilly

api/v1/api.php?target=vlan&action=update&id=11735&tags=156,159

api/v1/api.php?target=vlan&action=update&id=11735&name=

api/v1/api.php?target=vlan&action=update&id=11735&tags=

...

smartAssign

URL api.php?target=vlan&action=smartAssign
Description Finds and enables an unassigned VLAN matching the provided search parameters and optionally renames it.
Returns

Examples

SUCCESSFUL

Return Data:  the full domain description, plus the chosen VLAN with its new name (optional)

 {"success":1,"message":"VLAN enabled. ","data":{"21":{"id":"21","domain":"Swisscom Demo","attr_6c":"{\"range\":\"E\"}","attr_custom":null,"vlans":[{"id":"46183","vlan":"1808","name":"RESERVED_DEV"}]}}}

ERROR{ "success":0, "message":"error message" }


Required Parameters


NameTypeExampleDescription
domainIdINTEGER15The Id number of the domain you would like to Smart Assign from.


Optional Parameters


NameTypeExampleDescription
tagsSTRINGINTEGER5,7,12A comma-separated list of the Tag Ids being used for the Smart Assign.
nameSTRING

CustomerName_13 , RESERVED_DEV

The name that will be assigned to the VLAN matching the given search parameters. 


Example URLapi.php?target=vlan&action=smartAssign&domainId=21&name=RESERVED_DEV&tags=5,7,12

...