zone¶
Security zone
zone Specification¶
Parameter
Value
Type
Collection
Object Key(s)
name
Collection Name
Collection URI
/axapi/v3/zone
Element Name
zone
Element URI
/axapi/v3/zone/{name}
Element Attributes
zone_attributes
Partition Visibility
shared
Schema
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/zone | ||
Create List | POST | /axapi/v3/zone | ||
Get Object | GET | /axapi/v3/zone/{name} | ||
Get List | GET | /axapi/v3/zone | ||
Modify Object | POST | /axapi/v3/zone/{name} | ||
Replace Object | PUT | /axapi/v3/zone/{name} | ||
Replace List | PUT | /axapi/v3/zone | ||
Delete Object | DELETE | /axapi/v3/zone/{name} | ||
zone-list¶
zone-list is JSON List of zone attributes
zone-list : [
]
zone attributes¶
interface
Description: interface is a JSON Block. Please see below for interface
Type: Object
Reference Object: /axapi/v3/zone/{name}/interface
local-zone-cfg
Description: local-zone-cfg is a JSON Block. Please see below for local-zone-cfg
Type: Object
Reference Object: /axapi/v3/zone/{name}/local-zone-cfg
name
Description name of zone object
Type: string
Maximum Length: 128 characters
Maximum Length: 1 characters
Default: any
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
vlan
Description: vlan is a JSON Block. Please see below for vlan
Type: Object
Reference Object: /axapi/v3/zone/{name}/vlan
local-zone-cfg¶
Specification
Value
Type
object
local-type
Description Set to local zone
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
vlan¶
Specification
Value
Type
object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
vlan-list
Type: List
vlan_vlan-list¶
Specification
Value
Type
list
Block object keys
vlan-end
vlan-start
interface¶
Specification
Value
Type
object
ethernet-list
Type: List
lif-list
Type: List
trunk-list
Type: List
tunnel-list
Type: List
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
ve-list
Type: List
interface_ethernet-list¶
Specification
Value
Type
list
Block object keys
interface-ethernet-end
interface-ethernet-start
interface_trunk-list¶
Specification
Value
Type
list
Block object keys
interface-trunk-end
interface-trunk-start
interface_ve-list¶
Specification
Value
Type
list
Block object keys
interface-ve-end
interface-ve-start
interface_lif-list¶
Specification
Value
Type
list
Block object keys
interface-lif-end
interface-lif-start
interface_tunnel-list¶
Specification
Value
Type
list
Block object keys
interface-tunnel-end
interface-tunnel-start