scaleout cluster local-device¶

Local device configuration

local-device Specification¶

Parameter Value

Type Configuration Resource

Element Name local-device

Element URI /axapi/v3/scaleout/cluster/{cluster-id}/local-device

Element Attributes local-device_attributes

Partition Visibility shared

Schema local-device schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/scaleout/cluster/{cluster-id}/local-device	local-device attributes
POST /axapi/v3/scaleout/cluster/1/local-device Payload: { "local-device": { "priority": 1, "l2-redirect": { "redirect-eth": 1, "ethernet-vlan": 2 } } }
Get Object	GET	/axapi/v3/scaleout/cluster/{cluster-id}/local-device	local-device attributes
GET /axapi/v3/scaleout/cluster/1/local-device Reponse: { "local-device": { "priority": 1, "action": "enable", "cluster-mode": "layer-2", "uuid": "0ff9fdec-5107-11ee-a47e-3b140db7f68c", "l2-redirect": { "redirect-eth": 1, "ethernet-vlan": 2, "uuid": "0ffa0c6a-5107-11ee-a47e-3b140db7f68c", "a10-url": "/axapi/v3/scaleout/cluster/1/local-device/l2-redirect" }, "a10-url": "/axapi/v3/scaleout/cluster/1/local-device" } }
Modify Object	POST	/axapi/v3/scaleout/cluster/{cluster-id}/local-device	local-device attributes
Replace Object	PUT	/axapi/v3/scaleout/cluster/{cluster-id}/local-device	local-device attributes
PUT /axapi/v3/scaleout/cluster/1/local-device Payload: { "local-device": { "priority": 2, "l2-redirect": { "redirect-eth": 2 } } }
Delete Object	DELETE	/axapi/v3/scaleout/cluster/{cluster-id}/local-device	local-device attributes
DELETE /axapi/v3/scaleout/cluster/1/local-device Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

local-device attributes¶

action

Description ‘enable’: enable; ‘disable’: disable;

Type: string

Supported Values: enable, disable

Default: enable

cluster-mode

Description ‘layer-2’: Nodes in cluster are layer 2 connected (default mode); ‘layer-3’: Nodes in cluster are l3 connected;

Type: string

Supported Values: layer-2, layer-3

Default: layer-2

exclude-interfaces

Description: exclude-interfaces is a JSON Block. Please see below for exclude-interfaces

Type: Object

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/local-device/exclude-interfaces

id

Description

Type: number

Range: 1-16

l2-redirect

Description: l2-redirect is a JSON Block. Please see below for l2-redirect

Type: Object

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/local-device/l2-redirect

priority

Description

Type: number

Range: 1-255

session-sync

Description: session-sync is a JSON Block. Please see below for session-sync

Type: Object

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/local-device/session-sync

start-delay

Description

Type: number

Range: 10-300

tracking-template

Description: tracking-template is a JSON Block. Please see below for tracking-template

Type: Object

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/local-device/tracking-template

traffic-redirection

Description: traffic-redirection is a JSON Block. Please see below for traffic-redirection

Type: Object

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/local-device/traffic-redirection

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

session-sync¶

Specification Value

Type object

follow-shared

Description Follow shared partition for session sync

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

interfaces

Description: interfaces is a JSON Block. Please see below for session-sync_interfaces

Type: Object

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/local-device/session-sync/interfaces

reachability-options

Description: reachability-options is a JSON Block. Please see below for session-sync_reachability-options

Type: Object

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/local-device/session-sync/reachability-options

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

session-sync_interfaces¶

Specification Value

Type object

eth-cfg

Type: List

loopback-cfg

Type: List

trunk-cfg

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ve-cfg

Type: List

session-sync_interfaces_ve-cfg¶

Specification Value

Type list

Block object keys

ve

Description Virtual ethernet Interface (Virtual ethernet interface number)

Type: number

Range: 2-4094

session-sync_interfaces_loopback-cfg¶

Specification Value

Type list

Block object keys

loopback

Description Loopback Interface(Not applicable in ‘layer-2’ mode) (Loopback interface number)

Type: number

Range: 0-10

session-sync_interfaces_trunk-cfg¶

Specification Value

Type list

Block object keys

trunk

Description Trunk Interface (Trunk interface number)

Type: number

Range: 1-4096

session-sync_interfaces_eth-cfg¶

Specification Value

Type list

Block object keys

ethernet

Description Ethernet Interface (Ethernet interface number)

Type: number

Format: interface

session-sync_reachability-options¶

Specification Value

Type object

skip-default-route

Description Do not choose default route for redirection(Not applicable in ‘layer-2’ mode)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

exclude-interfaces¶

Specification Value

Type object

eth-cfg

Type: List

loopback-cfg

Type: List

trunk-cfg

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ve-cfg

Type: List

exclude-interfaces_ve-cfg¶

Specification Value

Type list

Block object keys

ve

Description Virtual ethernet Interface (Virtual ethernet interface number)

Type: number

Range: 2-4094

exclude-interfaces_loopback-cfg¶

Specification Value

Type list

Block object keys

loopback

Description Loopback Interface (Loopback interface number)

Type: number

Range: 0-10

exclude-interfaces_trunk-cfg¶

Specification Value

Type list

Block object keys

trunk

Description Trunk Interface (Trunk interface number)

Type: number

Range: 1-4096

exclude-interfaces_eth-cfg¶

Specification Value

Type list

Block object keys

ethernet

Description Ethernet Interface (Ethernet interface number)

Type: number

Format: interface

l2-redirect¶

Specification Value

Type object

ethernet-vlan

Description VLAN ID

Type: number

Range: 2-4094

redirect-eth

Description Ethernet port (Port Value)

Type: number

Format: interface

Mutual Exclusion: redirect-eth and redirect-trunk are mutually exclusive

redirect-trunk

Description L2 Trunk group

Type: number

Range: 1-4096

Mutual Exclusion: redirect-trunk and redirect-eth are mutually exclusive

trunk-vlan

Description VLAN ID

Type: number

Range: 2-4094

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

traffic-redirection¶

Specification Value

Type object

follow-shared

Description Follow shared partition for redirection

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

interfaces

Description: interfaces is a JSON Block. Please see below for traffic-redirection_interfaces

Type: Object

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/local-device/traffic-redirection/interfaces

reachability-options

Description: reachability-options is a JSON Block. Please see below for traffic-redirection_reachability-options

Type: Object

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/local-device/traffic-redirection/reachability-options

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

traffic-redirection_interfaces¶

Specification Value

Type object

eth-cfg

Type: List

loopback-cfg

Type: List

trunk-cfg

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

ve-cfg

Type: List

traffic-redirection_interfaces_ve-cfg¶

Specification Value

Type list

Block object keys

ve

Description Virtual ethernet Interface (Virtual ethernet interface number)

Type: number

Range: 2-4094

traffic-redirection_interfaces_loopback-cfg¶

Specification Value

Type list

Block object keys

loopback

Description Loopback Interface (Loopback interface number)

Type: number

Range: 0-10

traffic-redirection_interfaces_trunk-cfg¶

Specification Value

Type list

Block object keys

trunk

Description Trunk Interface (Trunk interface number)

Type: number

Range: 1-4096

traffic-redirection_interfaces_eth-cfg¶

Specification Value

Type list

Block object keys

ethernet

Description Ethernet Interface (Ethernet interface number)

Type: number

Format: interface

traffic-redirection_reachability-options¶

Specification Value

Type object

skip-default-route

Description Do not choose default route for redirection

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

tracking-template¶

Specification Value

Type object

multi-template-list

Type: List

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/local-device/tracking-template/multi-template/{multi-template}

template-list

Type: List

Reference Object: /axapi/v3/scaleout/cluster/{cluster-id}/local-device/tracking-template/template/{template}

tracking-template_multi-template-list¶

Specification Value

Type list

Block object keys

action

Description ‘down’: node stops processing user traffic; ‘exit-cluster’: node exits scaleout cluster;

Type: string

Supported Values: down, exit-cluster

multi-template

Description bind multi tracking template name

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

template

Type: List

threshold

Description action triggering threshold

Type: number

Range: 1-65535

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

tracking-template_multi-template-list_template¶

Specification Value

Type list

Block object keys

partition-name

Description Partition name

Type: string

Maximum Length: 14 characters

Maximum Length: 1 characters

Reference Object: /axapi/v3/partition

template-name

Description bind tracking template name

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

tracking-template_template-list¶

Specification Value

Type list

Block object keys

template

Description bind tracking template name

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

threshold-cfg

Type: List

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

tracking-template_template-list_threshold-cfg¶

Specification Value

Type list

Block object keys

action

Description ‘down’: node stops processing user traffic; ‘exit-cluster’: node exits scaleout cluster;

Type: string

Supported Values: down, exit-cluster

threshold

Description action triggering threshold

Type: number

Range: 1-65535