vcs device¶

VCS Device

device Specification¶

Parameter Value

Type Collection

Object Key(s) device

Collection Name device-list

Collection URI /axapi/v3/vcs/device

Element Name device

Element URI /axapi/v3/vcs/device/{device}

Element Attributes device_attributes

Partition Visibility shared

Schema device schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/vcs/device	device attributes
POST /axapi/v3/vcs/device/ Payload: { "device": { "device": 2, "user-tag": "a" } }
Create List	POST	/axapi/v3/vcs/device	device attributes
Get Object	GET	/axapi/v3/vcs/device/{device}	device attributes
GET /axapi/v3/vcs/device/2 Reponse: { "device": { "device": 2, "unicast-port": 41216, "management": 0, "ttl": 64, "enable": 0, "uuid": "7e5923ca-513a-11ee-ac47-933e6efb40fb", "user-tag": "a", "a10-url": "/axapi/v3/vcs/device/2" } }
Get List	GET	/axapi/v3/vcs/device	device-list
Modify Object	POST	/axapi/v3/vcs/device/{device}	device attributes
Replace Object	PUT	/axapi/v3/vcs/device/{device}	device attributes
PUT /axapi/v3/vcs/device/2 Payload: { "device": { "device": 2, "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/vcs/device	device-list
Delete Object	DELETE	/axapi/v3/vcs/device/{device}	device attributes
DELETE /axapi/v3/vcs/device/2 Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "The changed configuration of aVCS will take effect only after 'vcs reload'.\n" } }

device-list¶

device-list is JSON List of device attributes

device-list : [

{ device attributes },

{ device attributes },

…

]

device attributes¶

affinity-vrrp-a-vrid

Description vrid-group

Type: number

Range: 0-31

device

Description Device ID

Type: number

enable

Description Enable

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

ethernet-cfg

Type: List

management

Description Management interface

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

priority

Description Device priority

Type: number

Range: 1-255

trunk-cfg

Type: List

ttl

Description TTL of the VCS packet

Type: number

Range: 1-128

Default: 64

unicast-port

Description Port used in unicast communication (Port number)

Type: number

Range: 1024-65535

Default: 41216

user-tag

Description Customized tag

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ve-cfg

Type: List

ethernet-cfg¶

Specification Value

Type list

Block object keys

ethernet

Description Ethernet (Ethernet interface number)

Type: number

Format: interface

ve-cfg¶

Specification Value

Type list

Block object keys

ve

Description VE interface (VE interface number)

Type: number

Range: 2-4094

trunk-cfg¶

Specification Value

Type list

Block object keys

trunk

Description Trunk interface (Trunk interface number)

Type: number

Range: 1-4096