system path

Layer-2 path

path Specification

Parameter Value
Type Collection
Object Key(s) l2hm-path-name
Collection Name path-list
Collection URI /axapi/v3/system/path
Element Name path
Element URI /axapi/v3/system/path/{l2hm-path-name}
Element Attributes path_attributes
Partition Visibility shared
Operational Data URI /axapi/v3/system/path/{l2hm-path-name}/oper
Schema path schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/system/path

path attributes

Create List

POST

/axapi/v3/system/path

path attributes

Get Object

GET

/axapi/v3/system/path/{l2hm-path-name}

path attributes

Get List

GET

/axapi/v3/system/path

path-list

Modify Object

POST

/axapi/v3/system/path/{l2hm-path-name}

path attributes

Replace Object

PUT

/axapi/v3/system/path/{l2hm-path-name}

path attributes

Replace List

PUT

/axapi/v3/system/path

path-list

Delete Object

DELETE

/axapi/v3/system/path/{l2hm-path-name}

path attributes

path-list

path-list is JSON List of path attributes

path-list : [

path attributes

ifpair-eth-end

Description Ethernet port

Type: number

Format: interface

ifpair-eth-start

Description Ethernet port (Interface number)

Type: number

Format: interface

ifpair-trunk-end

Description Trunk Group

Type: number

Range: 1-4096

Reference Object: /axapi/v3/interface/trunk

ifpair-trunk-start

Description Trunk groups

Type: number

Range: 1-4096

Reference Object: /axapi/v3/interface/trunk

l2hm-attach

Description Monitor Name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

l2hm-path-name

Description Monitor Name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Default: hc-obj

l2hm-setup-test-api

Description Test-API Interface (Ethernet Interface)

Type: number

Format: interface

l2hm-vlan

Description VLAN id

Type: number

Range: 2-4094

Reference Object: /axapi/v3/network/vlan

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