ip app-protocol-port udp

UDP application ports

udp Specification

Parameter Value
Type Intermediate Resource
Element Name udp
Element URI /axapi/v3/ip/app-protocol-port/udp
Element Attributes udp_attributes
Partition Visibility shared
Schema udp schema

Operations Allowed:

OperationMethodURIPayload

Get Object

GET

/axapi/v3/ip/app-protocol-port/udp

udp_attributes

udp attributes

passthrough

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

Type: Object

Reference Object: /axapi/v3/ip/app-protocol-port/udp/passthrough

port

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

Type: Object

Reference Object: /axapi/v3/ip/app-protocol-port/udp/port

passthrough

Specification Value
Type object

disable

Description Disable global port processing

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

enable

Description Enables global port processing

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

port

Specification Value
Type object

add-list

disable-list

port_add-list

Specification Value
Type list
Block object keys  

app-name-list

port

Description Port Number

Type: number

Range: 0-65534

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

port_add-list_app-name-list

Specification Value
Type list
Block object keys  

interface

Description: interface is a JSON Block. Please see below for port_add-list_app-name-list_interface

Type: Object

Reference Object: /axapi/v3/ip/app-protocol-port/udp/port/add/{port}/app-name/{name}/interface

name

Description Application Protocol Port Name

Type: string

Format: string-rlx

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

port_add-list_app-name-list_interface

Specification Value
Type object

eth-cfg

Type: List

management

Description Management Interface

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

ve-cfg

Type: List

port_add-list_app-name-list_interface_ve-cfg

Specification Value
Type list
Block object keys  

ve-end

Description VE port

Type: number

ve-start

Description VE port (VE Interface number)

Type: number

port_add-list_app-name-list_interface_eth-cfg

Specification Value
Type list
Block object keys  

ethernet-end

Description Ethernet port

Type: number

Format: interface

ethernet-start

Description Ethernet port (Ethernet Interface number)

Type: number

Format: interface

port_disable-list

Specification Value
Type list
Block object keys  

interface

Description: interface is a JSON Block. Please see below for port_disable-list_interface

Type: Object

Reference Object: /axapi/v3/ip/app-protocol-port/udp/port/disable/{port}/interface

port

Description Port Number

Type: number

Range: 0-65534

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

port_disable-list_interface

Specification Value
Type object

eth-cfg

Type: List

management

Description Management Interface

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

ve-cfg

Type: List

port_disable-list_interface_ve-cfg

Specification Value
Type list
Block object keys  

ve-end

Description VE port

Type: number

ve-start

Description VE port (VE Interface number)

Type: number

port_disable-list_interface_eth-cfg

Specification Value
Type list
Block object keys  

ethernet-end

Description Ethernet port

Type: number

Format: interface

ethernet-start

Description Ethernet port (Ethernet Interface number)

Type: number

Format: interface