fw server oper¶

Operational Status for the object server

server Specification¶

Parameter Value

Type Collection

Collection Name server-list

Collection URI /axapi/v3/fw/server/{name}

Element Name server

Element URI /axapi/v3/fw/server/{name}/oper

Element Attributes server_attributes

Partition Visibility None

Schema server schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/fw/server/{name}	server attributes
Create List	POST	/axapi/v3/fw/server/{name}	server attributes
Get Object	GET	/axapi/v3/fw/server/{name}/oper	server attributes
Get List	GET	/axapi/v3/fw/server/{name}	server-list
Modify Object	POST	/axapi/v3/fw/server/{name}/oper	server attributes
Replace Object	PUT	/axapi/v3/fw/server/{name}/oper	server attributes
Replace List	PUT	/axapi/v3/fw/server/{name}	server-list
Delete Object	DELETE	/axapi/v3/fw/server/{name}/oper	server attributes

server-list¶

server-list is JSON List of server attributes

server-list : [

{ server attributes },

{ server attributes },

…

]

server attributes¶

name

Description Server Name

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

oper

Description: oper is a JSON Block. Please see below for oper

Type: Object

port-list

Type: List

Reference Object: /axapi/v3/fw/server/{name}/port/{port-number}+{protocol}

oper¶

Specification Value

Type object

state

Description

Type: string

Supported Values: UP, DOWN, DELETE, DISABLED, MAINTENANCE

port-list¶

Specification Value

Type list

Block object keys

oper

Description: oper is a JSON Block. Please see below for port-list_oper

Type: Object

port-number

Description Port Number

Type: number

Range: 1-65534

protocol

Description ‘tcp’: TCP Port; ‘udp’: UDP Port;

Type: string

Supported Values: tcp, udp

port-list_oper¶

Specification Value

Type object

alloc_failed

Description

Type: number

ha_group_id

Description

Type: number

ip

Description

Type: string

Format: ipv4-address

ipv6

Description

Type: string

Format: ipv6-address

ports_consumed

Description

Type: number

ports_consumed_total

Description

Type: number

ports_freed_total

Description

Type: number

state

Description

Type: string

Supported Values: UP, DOWN, DELETE, DISABLED, MAINTENANCE

vrid

Description

Type: number