object network

Configure Network Object.

network Specification

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
Schema network schema

Operations Allowed:

Operation Method URI Payload

Create Object

POST

/axapi/v3/object/network/

network Attributes

Create List

POST

/axapi/v3/object/network/

network Attributes

Get Object

GET

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

network Attributes

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

Replace List

PUT

/axapi/v3/object/network/

network-list

Delete Object

DELETE

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

network Attributes

network-list

network-list is JSON List of network Attributes

network-list : [

network Attributes

description

Description: Description of the object instance

Type: string

Format: string-rlx

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

Required: Yes

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

uuid

Description: uuid of the object

Type: string