object network¶

Configure Network Object

network Specification¶

Parameter Value

Type Collection

Object Key(s) net-name

Collection Name network-list

Collection URI /axapi/v3/object/network

Element Name network

Element URI /axapi/v3/object/network/{net-name}

Element Attributes network_attributes

Partition Visibility shared

Schema network schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/object/network	network attributes
POST /axapi/v3/object/network/ Payload: { "network": { "net-name": "a", "user-tag": "a" } }
Create List	POST	/axapi/v3/object/network	network attributes
Get Object	GET	/axapi/v3/object/network/{net-name}	network attributes
GET /axapi/v3/object/network/a Reponse: { "network": { "net-name": "a", "uuid": "2e9acfba-503a-11ee-b31e-61a3d9cb4d7f", "user-tag": "a", "a10-url": "/axapi/v3/object/network/a" } }
Get List	GET	/axapi/v3/object/network	network-list
Modify Object	POST	/axapi/v3/object/network/{net-name}	network attributes
Replace Object	PUT	/axapi/v3/object/network/{net-name}	network attributes
PUT /axapi/v3/object/network/a Payload: { "network": { "net-name": "a", "user-tag": "abcd" } }
Replace List	PUT	/axapi/v3/object/network	network-list
Delete Object	DELETE	/axapi/v3/object/network/{net-name}	network attributes
DELETE /axapi/v3/object/network/a Reponse: { "response": { "http-status": 200, "status": "OK", "msg": "Success" } }

network-list¶

network-list is JSON List of network attributes

network-list : [

{ network attributes },

{ network attributes },

…

]

network attributes¶

description

Description Description of the object instance

Type: string

Format: string-rlx

Maximum Length: 128 characters

Maximum Length: 1 characters

ip-range-end

Description IPV4 Host address end

Type: string

Format: ipv4-address

ip-range-start

Description IPv4 Host Address start

Type: string

Format: ipv4-address

Mutual Exclusion: ip-range-start,ipv6-range-start, subnet, and ipv6-subnet are mutually exclusive

ipv6-range-end

Description IPV6 Host address end

Type: string

Format: ipv6-address

ipv6-range-start

Description IPv6 Host Address start

Type: string

Format: ipv6-address

Mutual Exclusion: ipv6-range-start,ip-range-start, subnet, and ipv6-subnet are mutually exclusive

ipv6-subnet

Description IPv6 Network Address

Type: string

Format: ipv6-address-plen

Mutual Exclusion: ipv6-subnet,ip-range-start, ipv6-range-start, and subnet are mutually exclusive

net-name

Description Network Object Name

Type: string

Maximum Length: 63 characters

Maximum Length: 1 characters

subnet

Description IPv4 Network Address

Type: string

Format: ipv4-cidr

Mutual Exclusion: subnet,ip-range-start, ipv6-range-start, and ipv6-subnet are mutually exclusive

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