cgnv6 template pcp

Port Control Protocol Template

pcp Specification

   
Type Collection
Object Key(s) name
Collection Name pcp-list
Collection URI /axapi/v3/cgnv6/template/pcp
Element Name pcp
Element URI /axapi/v3/cgnv6/template/pcp/{name}
Element Attributes pcp_attributes
Schema pcp schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/cgnv6/template/pcp

pcp attributes

Create List

POST

/axapi/v3/cgnv6/template/pcp

pcp attributes

Get Object

GET

/axapi/v3/cgnv6/template/pcp/{name}

pcp attributes

Get List

GET

/axapi/v3/cgnv6/template/pcp

pcp-list

Modify Object

POST

/axapi/v3/cgnv6/template/pcp/{name}

pcp attributes

Replace Object

PUT

/axapi/v3/cgnv6/template/pcp/{name}

pcp attributes

Replace List

PUT

/axapi/v3/cgnv6/template/pcp

pcp-list

Delete Object

DELETE

/axapi/v3/cgnv6/template/pcp/{name}

pcp attributes

pcp-list

pcp-list is JSON List of pcp attributes

pcp-list : [

]

pcp attributes

allow-third-party-from-lan

Description Allow third party request coming from LAN (default is disabled)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

allow-third-party-from-wan

Description Allow third party request coming from WAN (default is disabled)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

announce

Description PCP ANNOUNCE Opcode (default is enabled)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

check-client-nonce

Description To validate NONCE value in PCP request (default: disabled)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

disable-map-filter

Description To disable processing of FILTER options in MAP request

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

map

Description PCP MAP Opcode (default is enabled)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

maximum

Description To set maximum lifetime of PCP mappings (default 1440 minutes)

Type: number

Range: 2-1440

Default: 1440

minimum

Description To set minimum lifetime of PCP mappings (default 2 minutes)

Type: number

Range: 2-1440

Default: 2

name

Description PCP Template name

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

pcp-server-port

Description PCP server listening port (default 5351) (PCP UDP destination port)

Type: number

Range: 1024-65535

Default: 5351

peer

Description PCP PEER Opcode (default is enabled)

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

source-ip

Description Specify source IP address for IPv4 ANNOUNCE message

Type: string

Format: ipv4-address

source-ipv6

Description Specify source IPv6 address for IPv6 ANNOUNCE message

Type: string

Format: ipv6-address

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