scaleout¶
Configure Scaleout
scaleout Specification¶
Type Intermediate Resource Element Name scaleout Element URI /axapi/v3/scaleout Element Attributes scaleout_attributes Schema scaleout schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Get Object | GET | /axapi/v3/scaleout | scaleout_attributes |
scaleout attributes¶
apps
Description: apps is a JSON Block. Please see below for apps
Type: Object
Refernce Object: /axapi/v3/scaleout/apps
cluster-list
Type: List
Refernce Object: /axapi/v3/scaleout/cluster/{cluster-id}
distributed-forwarding
Description: distributed-forwarding is a JSON Block. Please see below for distributed-forwarding
Type: Object
Refernce Object: /axapi/v3/scaleout/distributed-forwarding
status
Description: status is a JSON Block. Please see below for status
Type: Object
Refernce Object: /axapi/v3/scaleout/status
traffic-map
Description: traffic-map is a JSON Block. Please see below for traffic-map
Type: Object
Refernce Object: /axapi/v3/scaleout/traffic-map
status¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
distributed-forwarding¶
Specification Type object fw
Description Enable FW
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
apps¶
Specification Type object enable
Description Enable Scaleout for apps
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
traffic-map¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
cluster-list¶
Specification Type list Block object keys cluster-devices
Description: cluster-devices is a JSON Block. Please see below for cluster-list_cluster-devices
Type: Object
Refernce Object: /axapi/v3/scaleout/cluster/{cluster-id}/cluster-devices
cluster-id
Description Scaleout cluster-id
Type: number
Range: 1-64
db-config
Description: db-config is a JSON Block. Please see below for cluster-list_db-config
Type: Object
Refernce Object: /axapi/v3/scaleout/cluster/{cluster-id}/db-config
device-groups
Description: device-groups is a JSON Block. Please see below for cluster-list_device-groups
Type: Object
Refernce Object: /axapi/v3/scaleout/cluster/{cluster-id}/device-groups
follow-vcs
Description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
local-device
Description: local-device is a JSON Block. Please see below for cluster-list_local-device
Type: Object
Refernce Object: /axapi/v3/scaleout/cluster/{cluster-id}/local-device
service-config
Description: service-config is a JSON Block. Please see below for cluster-list_service-config
Type: Object
Refernce Object: /axapi/v3/scaleout/cluster/{cluster-id}/service-config
tracking-template
Description: tracking-template is a JSON Block. Please see below for cluster-list_tracking-template
Type: Object
Refernce Object: /axapi/v3/scaleout/cluster/{cluster-id}/tracking-template
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
cluster-list_local-device¶
Specification Type object 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 cluster-list_local-device_exclude-interfaces
Type: Object
Refernce 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 cluster-list_local-device_l2-redirect
Type: Object
Refernce 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 cluster-list_local-device_session-sync
Type: Object
Refernce 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 cluster-list_local-device_tracking-template
Type: Object
Refernce Object: /axapi/v3/scaleout/cluster/{cluster-id}/local-device/tracking-template
traffic-redirection
Description: traffic-redirection is a JSON Block. Please see below for cluster-list_local-device_traffic-redirection
Type: Object
Refernce 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
cluster-list_local-device_session-sync¶
Specification 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 cluster-list_local-device_session-sync_interfaces
Type: Object
Refernce 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 cluster-list_local-device_session-sync_reachability-options
Type: Object
Refernce 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
cluster-list_local-device_session-sync_interfaces¶
Specification Type object eth-cfg
Type: Listloopback-cfg
Type: Listtrunk-cfg
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ve-cfg
Type: List
cluster-list_local-device_session-sync_interfaces_ve-cfg¶
Specification Type list Block object keys ve
Description Virtual ethernet Interface (Virtual ethernet interface number)
Type: number
Range: 2-4094
cluster-list_local-device_session-sync_interfaces_loopback-cfg¶
Specification Type list Block object keys loopback
Description Loopback Interface(Not applicable in ‘layer-2’ mode) (Loopback interface number)
Type: number
Range: 0-10
cluster-list_local-device_session-sync_interfaces_trunk-cfg¶
Specification Type list Block object keys trunk
Description Trunk Interface (Trunk interface number)
Type: number
Range: 1-4096
cluster-list_local-device_session-sync_interfaces_eth-cfg¶
Specification Type list Block object keys ethernet
Description Ethernet Interface (Ethernet interface number)
Type: number
Format: interface
cluster-list_local-device_session-sync_reachability-options¶
Specification 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
cluster-list_local-device_exclude-interfaces¶
Specification Type object eth-cfg
Type: Listloopback-cfg
Type: Listtrunk-cfg
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ve-cfg
Type: List
cluster-list_local-device_exclude-interfaces_ve-cfg¶
Specification Type list Block object keys ve
Description Virtual ethernet Interface (Virtual ethernet interface number)
Type: number
Range: 2-4094
cluster-list_local-device_exclude-interfaces_loopback-cfg¶
Specification Type list Block object keys loopback
Description Loopback Interface (Loopback interface number)
Type: number
Range: 0-10
cluster-list_local-device_exclude-interfaces_trunk-cfg¶
Specification Type list Block object keys trunk
Description Trunk Interface (Trunk interface number)
Type: number
Range: 1-4096
cluster-list_local-device_exclude-interfaces_eth-cfg¶
Specification Type list Block object keys ethernet
Description Ethernet Interface (Ethernet interface number)
Type: number
Format: interface
cluster-list_local-device_l2-redirect¶
Specification 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
cluster-list_local-device_traffic-redirection¶
Specification 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 cluster-list_local-device_traffic-redirection_interfaces
Type: Object
Refernce 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 cluster-list_local-device_traffic-redirection_reachability-options
Type: Object
Refernce 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
cluster-list_local-device_traffic-redirection_interfaces¶
Specification Type object eth-cfg
Type: Listloopback-cfg
Type: Listtrunk-cfg
Type: Listuuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ve-cfg
Type: List
cluster-list_local-device_traffic-redirection_interfaces_ve-cfg¶
Specification Type list Block object keys ve
Description Virtual ethernet Interface (Virtual ethernet interface number)
Type: number
Range: 2-4094
cluster-list_local-device_traffic-redirection_interfaces_loopback-cfg¶
Specification Type list Block object keys loopback
Description Loopback Interface (Loopback interface number)
Type: number
Range: 0-10
cluster-list_local-device_traffic-redirection_interfaces_trunk-cfg¶
Specification Type list Block object keys trunk
Description Trunk Interface (Trunk interface number)
Type: number
Range: 1-4096
cluster-list_local-device_traffic-redirection_interfaces_eth-cfg¶
Specification Type list Block object keys ethernet
Description Ethernet Interface (Ethernet interface number)
Type: number
Format: interface
cluster-list_local-device_traffic-redirection_reachability-options¶
Specification 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
cluster-list_local-device_tracking-template¶
Specification Type object template-list
Type: List
Refernce Object: /axapi/v3/scaleout/cluster/{cluster-id}/local-device/tracking-template/template/{template}
cluster-list_local-device_tracking-template_template-list¶
Specification Type list Block object keys template
Description bind tracking template name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
threshold-cfg
Type: Listuser-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
cluster-list_local-device_tracking-template_template-list_threshold-cfg¶
Specification 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
cluster-list_cluster-devices¶
Specification Type object cluster-discovery-timeout
Description: cluster-discovery-timeout is a JSON Block. Please see below for cluster-list_cluster-devices_cluster-discovery-timeout
Type: Object
Refernce Object: /axapi/v3/scaleout/cluster/{cluster-id}/cluster-devices/cluster-discovery-timeout
device-id-list
Type: List
Refernce Object: /axapi/v3/scaleout/cluster/{cluster-id}/cluster-devices/device-id/{device-id}
minimum-nodes
Description: minimum-nodes is a JSON Block. Please see below for cluster-list_cluster-devices_minimum-nodes
Type: Object
Refernce Object: /axapi/v3/scaleout/cluster/{cluster-id}/cluster-devices/minimum-nodes
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
cluster-list_cluster-devices_cluster-discovery-timeout¶
Specification Type object timer-val
Description Cluster node discovery timeout value (secs (Default: 120))
Type: number
Range: 60-86400
Default: 120
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
cluster-list_cluster-devices_device-id-list¶
Specification Type list Block object keys action
Description ‘enable’: enable; ‘disable’: disable;
Type: string
Supported Values: enable, disable
Default: enable
device-id
Description scaleout device id
Type: number
Range: 1-16
ip
Description
Type: string
Format: ipv4-address
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
cluster-list_cluster-devices_minimum-nodes¶
Specification Type object minimum-nodes-num
Description Specify the minimum number of the node required to start service
Type: number
Range: 1-8
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
cluster-list_device-groups¶
Specification Type object device-group-list
Type: List
Refernce Object: /axapi/v3/scaleout/cluster/{cluster-id}/device-groups/device-group/{device-group}
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
cluster-list_device-groups_device-group-list¶
Specification Type list Block object keys device-group
Description scaleout device group
Type: number
Range: 1-16
device-id-list
Type: Listuser-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
cluster-list_device-groups_device-group-list_device-id-list¶
Specification Type list Block object keys device-id-end
Description
Type: number
device-id-start
Description
Type: number
cluster-list_service-config¶
Specification Type object template-list
Type: List
Refernce Object: /axapi/v3/scaleout/cluster/{cluster-id}/service-config/template/{name}
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
cluster-list_service-config_template-list¶
Specification Type list Block object keys bucket-count
Description Number of traffic buckets
Type: number
Range: 1-256
Default: 256
device-group
Description Device group id
Type: number
Range: 1-16
name
Description Scaleout template Name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
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
cluster-list_db-config¶
Specification Type object uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
cluster-list_tracking-template¶
Specification Type object template-list
Type: List
Refernce Object: /axapi/v3/scaleout/cluster/{cluster-id}/tracking-template/template/{template}
cluster-list_tracking-template_template-list¶
Specification Type list Block object keys template
Description bind tracking template name
Type: string
Maximum Length: 63 characters
Maximum Length: 1 characters
threshold-cfg
Type: Listuser-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
cluster-list_tracking-template_template-list_threshold-cfg¶
Specification 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