vpn oper¶

Operational Status for the object vpn

vpn Specification¶

Parameter Value

Type Configuration Resource

Element Name vpn

Element URI /axapi/v3/vpn/oper

Element Attributes vpn_attributes

Partition Visibility None

Schema vpn schema

Operations Allowed:

Operation	Method	URI	Payload
Create Object	POST	/axapi/v3/vpn/oper	vpn attributes
Get Object	GET	/axapi/v3/vpn/oper	vpn attributes
Modify Object	POST	/axapi/v3/vpn/oper	vpn attributes
Replace Object	PUT	/axapi/v3/vpn/oper	vpn attributes
Delete Object	DELETE	/axapi/v3/vpn/oper	vpn attributes

vpn attributes¶

crl

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

Type: Object

Reference Object: /axapi/v3/vpn/errordump/default/log/ike-gateway/{name}/group-list/crl

default

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

Type: Object

Reference Object: /axapi/v3/vpn/errordump/default

errordump

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

Type: Object

Reference Object: /axapi/v3/vpn/errordump

group-list

Description: group-list is a JSON Block. Please see below for group-list

Type: Object

Reference Object: /axapi/v3/vpn/errordump/default/log/ike-gateway/{name}/group-list

ike-gateway-list

Type: List

Reference Object: /axapi/v3/vpn/errordump/default/log/ike-gateway/{name}

ike-sa

Description: ike-sa is a JSON Block. Please see below for ike-sa

Type: Object

Reference Object: /axapi/v3/vpn/errordump/default/log/ike-gateway/{name}/group-list/crl/ocsp/ipsec-sa-by-gw/ike-sa

ike-sa-brief

Description: ike-sa-brief is a JSON Block. Please see below for ike-sa-brief

Type: Object

Reference Object: /axapi/v3/vpn/errordump/default/log/ike-gateway/{name}/group-list/crl/ocsp/ipsec-sa-by-gw/ike-sa/ipsec-sa/ike-sa-brief

ike-sa-clients

Description: ike-sa-clients is a JSON Block. Please see below for ike-sa-clients

Type: Object

Reference Object: /axapi/v3/vpn/errordump/default/log/ike-gateway/{name}/group-list/crl/ocsp/ipsec-sa-by-gw/ike-sa/ipsec-sa/ike-sa-brief/ike-sa-clients

ike-stats-by-gw

Description: ike-stats-by-gw is a JSON Block. Please see below for ike-stats-by-gw

Type: Object

Reference Object: /axapi/v3/vpn/errordump/default/log/ike-gateway/{name}/group-list/crl/ocsp/ipsec-sa-by-gw/ike-sa/ipsec-sa/ike-sa-brief/ike-sa-clients/ipsec-sa-clients/ike-stats-by-gw

ipsec-list

Type: List

Reference Object: /axapi/v3/vpn/errordump/default/log/ike-gateway/{name}/ipsec/{name}

ipsec-sa

Description: ipsec-sa is a JSON Block. Please see below for ipsec-sa

Type: Object

Reference Object: /axapi/v3/vpn/errordump/default/log/ike-gateway/{name}/group-list/crl/ocsp/ipsec-sa-by-gw/ike-sa/ipsec-sa

ipsec-sa-by-gw

Description: ipsec-sa-by-gw is a JSON Block. Please see below for ipsec-sa-by-gw

Type: Object

Reference Object: /axapi/v3/vpn/errordump/default/log/ike-gateway/{name}/group-list/crl/ocsp/ipsec-sa-by-gw

ipsec-sa-clients

Description: ipsec-sa-clients is a JSON Block. Please see below for ipsec-sa-clients

Type: Object

Reference Object: /axapi/v3/vpn/errordump/default/log/ike-gateway/{name}/group-list/crl/ocsp/ipsec-sa-by-gw/ike-sa/ipsec-sa/ike-sa-brief/ike-sa-clients/ipsec-sa-clients

log

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

Type: Object

Reference Object: /axapi/v3/vpn/errordump/default/log

ocsp

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

Type: Object

Reference Object: /axapi/v3/vpn/errordump/default/log/ike-gateway/{name}/group-list/crl/ocsp

oper

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

Type: Object

oper¶

Specification Value

Type object

Crypto-cores-assigned-to-IPsec

Description

Type: number

Crypto-cores-total

Description

Type: number

Crypto-mem

Description

Type: number

IKE-Gateway-total

Description

Type: number

IKE-SA-total

Description

Type: number

IPsec-SA-total

Description

Type: number

IPsec-mode

Description

Type: string

IPsec-total

Description

Type: number

Num-hardware-devices

Description

Type: number

all-partition-list

Type: List

all-partitions

Description

Type: boolean

Supported Values: true, false, 1, 0

shared

Description

Type: boolean

Supported Values: true, false, 1, 0

specific-partition

Description

Type: string

oper_all-partition-list¶

Specification Value

Type list

Block object keys

Crypto-cores-assigned-to-IPsec

Description

Type: number

Crypto-cores-total

Description

Type: number

Crypto-hw-err

Description

Type: number

Crypto-hw-err-bad-ctx-pointer

Description

Type: number

Crypto-hw-err-bad-pointer

Description

Type: number

Crypto-hw-err-buff-alloc-error

Description

Type: number

Crypto-hw-err-enqueue-fail

Description

Type: number

Crypto-hw-err-req-alloc-fail

Description

Type: number

Crypto-hw-err-req-error

Description

Type: number

Crypto-hw-err-sg-buff-alloc-fail

Description

Type: number

Crypto-hw-err-state

Description

Type: string

Crypto-hw-err-state-error

Description

Type: number

Crypto-hw-err-time-out

Description

Type: number

Crypto-hw-err-time-out-state

Description

Type: number

Crypto-mem

Description

Type: number

IKE-Gateway-total

Description

Type: number

IKE-SA-total

Description

Type: number

IKE-hardware-accelerate

Description

Type: string

IPsec-SA-total

Description

Type: number

IPsec-hardware-type

Description

Type: string

IPsec-mode

Description

Type: string

IPsec-stateless

Description

Type: number

IPsec-total

Description

Type: number

Num-hardware-devices

Description

Type: number

Signed-auth-flag

Description

Type: number

partition-name

Description

Type: string

passthrough-total

Description

Type: number

standby-drop

Description

Type: number

vpn-list

Type: List

oper_all-partition-list_vpn-list¶

Specification Value

Type list

Block object keys

cpu-id

Description

Type: number

passthrough

Description

Type: number

ike-sa-clients¶

Specification Value

Type object

oper

Description: oper is a JSON Block. Please see below for ike-sa-clients_oper

Type: Object

ike-sa-clients_oper¶

Specification Value

Type object

ike-sa-clients-local-ip

Description

Type: string

ike-sa-clients-remote-gw

Type: List

name

Description

Type: string

ike-sa-clients_oper_ike-sa-clients-remote-gw¶

Specification Value

Type list

Block object keys

ike-sa-clients-remote-gw-bytes

Description

Type: string

ike-sa-clients-remote-gw-idle-time

Description

Type: string

ike-sa-clients-remote-gw-ip

Description

Type: string

ike-sa-clients-remote-gw-remote-id

Description

Type: string

ike-sa-clients-remote-gw-session-time

Description

Type: string

ike-sa-clients-remote-gw-user-id

Description

Type: string

log¶

Specification Value

Type object

oper

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

Type: Object

log_oper¶

Specification Value

Type object

follow

Description

Type: boolean

Supported Values: true, false, 1, 0

from-start

Description

Type: boolean

Supported Values: true, false, 1, 0

num-lines

Description

Type: number

vpn-log-list

Type: List

vpn-log-offset

Description

Type: number

vpn-log-over

Description

Type: number

log_oper_vpn-log-list¶

Specification Value

Type list

Block object keys

vpn-log-data

Description

Type: string

ipsec-sa¶

Specification Value

Type object

oper

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

Type: Object

ipsec-sa_oper¶

Specification Value

Type object

ipsec-sa-list

Type: List

ipsec-sa_oper_ipsec-sa-list¶

Specification Value

Type list

Block object keys

encryption

Description

Type: string

hash

Description

Type: string

ike-gateway-name

Description

Type: string

in-spi

Description

Type: string

ipsec-sa-name

Description

Type: string

lifebytes

Description

Type: string

lifetime

Description

Type: number

local-ts

Description

Type: string

mode

Description

Type: string

out-spi

Description

Type: string

protocol

Description

Type: string

remote-ts

Description

Type: string

default¶

Specification Value

Type object

oper

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

Type: Object

default_oper¶

Specification Value

Type object

IPsec-anti-replay-window

Description

Type: number

IPsec-dh-group

Description

Type: string

IPsec-encryption

Description

Type: string

IPsec-hash

Description

Type: string

IPsec-lifebytes

Description

Type: number

IPsec-lifetime

Description

Type: number

IPsec-local-port

Description

Type: number

IPsec-local-protocol

Description

Type: number

IPsec-local-subnet

Description

Type: string

IPsec-mode

Description

Type: string

IPsec-priority

Description

Type: number

IPsec-protocol

Description

Type: string

IPsec-remote-port

Description

Type: number

IPsec-remote-protocol

Description

Type: number

IPsec-remote-subnet

Description

Type: string

IPsec-traffic-selector

Description

Type: string

ike-auth-method

Description

Type: string

ike-dh-group

Description

Type: string

ike-dpd-interval

Description

Type: number

ike-encryption

Description

Type: string

ike-hash

Description

Type: string

ike-lifetime

Description

Type: number

ike-local-address

Description

Type: string

ike-mode

Description

Type: string

ike-nat-traversal

Description

Type: string

ike-priority

Description

Type: number

ike-remote-address

Description

Type: string

ike-version

Description

Type: string

ike-sa-brief¶

Specification Value

Type object

oper

Description: oper is a JSON Block. Please see below for ike-sa-brief_oper

Type: Object

ike-sa-brief_oper¶

Specification Value

Type object

ike-sa-brief-remote-gw

Type: List

local-ip

Description

Type: string

name

Description

Type: string

ike-sa-brief_oper_ike-sa-brief-remote-gw¶

Specification Value

Type list

Block object keys

ike-sa-brief-remote-gw-id

Description

Type: string

ike-sa-brief-remote-gw-ip

Description

Type: string

ike-sa-brief-remote-gw-lifetime

Description

Type: string

ike-sa-brief-remote-gw-status

Description

Type: string

ike-gateway-list¶

Specification Value

Type list

Block object keys

name

Description IKE-gateway name

Type: string

Maximum Length: 31 characters

Maximum Length: 1 characters

oper

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

Type: Object

ike-gateway-list_oper¶

Specification Value

Type object

SA-List

Type: List

brief-filter

Description

Type: string

remote-id-filter

Description

Type: string

remote-ip-filter

Description

Type: string

ike-gateway-list_oper_SA-List¶

Specification Value

Type list

Block object keys

DH-Group

Description

Type: number

Encryption

Description

Type: string

Fragment-message-generated

Description

Type: number

Fragment-message-received

Description

Type: number

Fragment-reassemble-error

Description

Type: number

Fragmentation-error

Description

Type: number

Hash

Description

Type: string

Initiator-SPI

Description

Type: string

Lifetime

Description

Type: number

Local-IP

Description

Type: string

NAT-Traversal

Description

Type: number

Remote-ID

Description

Type: string

Remote-IP

Description

Type: string

Responder-SPI

Description

Type: string

Sign-hash

Description

Type: string

Status

Description

Type: string

ike-stats-by-gw¶

Specification Value

Type object

oper

Description: oper is a JSON Block. Please see below for ike-stats-by-gw_oper

Type: Object

ike-stats-by-gw_oper¶

Specification Value

Type object

display-all-filter

Description

Type: boolean

Supported Values: true, false, 1, 0

gateway-name-filter

Description

Type: string

ike-stats-list

Type: List

remote-id-filter

Description

Type: string

remote-ip-filter

Description

Type: string

ike-stats-by-gw_oper_ike-stats-list¶

Specification Value

Type list

Block object keys

ike-version

Description

Type: string

name

Description

Type: string

remote-id

Description

Type: string

remote-ip

Description

Type: string

v1-child-sa-invalid-spi

Description

Type: number

v1-in-aggressive-req

Description

Type: number

v1-in-aggressive-rsp

Description

Type: number

v1-in-auth-only-req

Description

Type: number

v1-in-auth-only-rsp

Description

Type: number

v1-in-id-prot-req

Description

Type: number

v1-in-id-prot-rsp

Description

Type: number

v1-in-info-v1-req

Description

Type: number

v1-in-info-v1-rsp

Description

Type: number

v1-in-new-group-mode-req

Description

Type: number

v1-in-new-group-mode-rsp

Description

Type: number

v1-in-quick-mode-req

Description

Type: number

v1-in-quick-mode-rsp

Description

Type: number

v1-in-transaction-req

Description

Type: number

v1-in-transaction-rsp

Description

Type: number

v1-out-aggressive-req

Description

Type: number

v1-out-aggressive-rsp

Description

Type: number

v1-out-auth-only-req

Description

Type: number

v1-out-auth-only-rsp

Description

Type: number

v1-out-id-prot-req

Description

Type: number

v1-out-id-prot-rsp

Description

Type: number

v1-out-info-v1-req

Description

Type: number

v1-out-info-v1-rsp

Description

Type: number

v1-out-new-group-mode-req

Description

Type: number

v1-out-new-group-mode-rsp

Description

Type: number

v1-out-quick-mode-req

Description

Type: number

v1-out-quick-mode-rsp

Description

Type: number

v1-out-transaction-req

Description

Type: number

v1-out-transaction-rsp

Description

Type: number

v2-child-sa-invalid-spi

Description

Type: number

v2-child-sa-rekey

Description

Type: number

v2-in-auth-req

Description

Type: number

v2-in-auth-rsp

Description

Type: number

v2-in-create-child-req

Description

Type: number

v2-in-create-child-rsp

Description

Type: number

v2-in-info-req

Description

Type: number

v2-in-info-rsp

Description

Type: number

v2-in-init-req

Description

Type: number

v2-in-init-rsp

Description

Type: number

v2-in-invalid

Description

Type: number

v2-in-invalid-spi

Description

Type: number

v2-init-rekey

Description

Type: number

v2-out-auth-req

Description

Type: number

v2-out-auth-rsp

Description

Type: number

v2-out-create-child-req

Description

Type: number

v2-out-create-child-rsp

Description

Type: number

v2-out-info-req

Description

Type: number

v2-out-info-rsp

Description

Type: number

v2-out-init-req

Description

Type: number

v2-out-init-rsp

Description

Type: number

v2-rsp-rekey

Description

Type: number

ike-sa¶

Specification Value

Type object

oper

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

Type: Object

ike-sa_oper¶

Specification Value

Type object

ike-sa-list

Type: List

ike-sa_oper_ike-sa-list¶

Specification Value

Type list

Block object keys

Encryption

Description

Type: string

Hash

Description

Type: string

Initiator-SPI

Description

Type: string

Lifetime

Description

Type: number

Local-IP

Description

Type: string

NAT-Traversal

Description

Type: number

Name

Description

Type: string

Remote-IP

Description

Type: string

Responder-SPI

Description

Type: string

Status

Description

Type: string

ipsec-sa-clients¶

Specification Value

Type object

oper

Description: oper is a JSON Block. Please see below for ipsec-sa-clients_oper

Type: Object

ipsec-sa-clients_oper¶

Specification Value

Type object

ipsec-clients

Type: List

ipsec-sa-clients_oper_ipsec-clients¶

Specification Value

Type list

Block object keys

ipsec-clients-ip

Description

Type: string

sa-list

Type: List

ipsec-sa-clients_oper_ipsec-clients_sa-list¶

Specification Value

Type list

Block object keys

in-spi

Description

Type: string

lifebytes

Description

Type: string

lifetime

Description

Type: string

local-ts

Description

Type: string

name

Description

Type: string

out-spi

Description

Type: string

errordump¶

Specification Value

Type object

oper

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

Type: Object

errordump_oper¶

Specification Value

Type object

IPsec-error-dump-path

Description

Type: string

group-list¶

Specification Value

Type object

oper

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

Type: Object

group-list_oper¶

Specification Value

Type object

group-list

Type: List

group-name

Description

Type: string

group-list_oper_group-list¶

Specification Value

Type list

Block object keys

Grp-member-count

Description

Type: number

Ike-gateway-name

Description

Type: string

Ipsec-sa-name

Description

Type: string

Is-new-group

Description a value of 1 indicates new group

Type: number

Name

Description

Type: string

Priority

Description

Type: number

Role

Description

Type: string

Status

Description

Type: string

ipsec-sa-by-gw¶

Specification Value

Type object

oper

Description: oper is a JSON Block. Please see below for ipsec-sa-by-gw_oper

Type: Object

ipsec-sa-by-gw_oper¶

Specification Value

Type object

ike-gateway-name

Description

Type: string

ipsec-sa-list

Type: List

local-ip

Description

Type: string

peer-ip

Description

Type: string

ipsec-sa-by-gw_oper_ipsec-sa-list¶

Specification Value

Type list

Block object keys

encryption

Description

Type: string

hash

Description

Type: string

in-spi

Description

Type: string

ipsec-sa-name

Description

Type: string

lifebytes

Description

Type: string

lifetime

Description

Type: number

local-ts

Description

Type: string

mode

Description

Type: string

out-spi

Description

Type: string

protocol

Description

Type: string

remote-ts

Description

Type: string

ipsec-list¶

Specification Value

Type list

Block object keys

name

Description IPsec name

Type: string

Maximum Length: 31 characters

Maximum Length: 1 characters

oper

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

Type: Object

ipsec-list_oper¶

Specification Value

Type object

SA-List

Type: List

in-spi-filter

Description

Type: string

out-spi-filter

Description

Type: string

remote-ts-filter

Description

Type: string

remote-ts-v6-filter

Description

Type: string

ipsec-list_oper_SA-List¶

Specification Value

Type list

Block object keys

Anti-Replay

Description

Type: string

DH-Group

Description

Type: number

Encryption-Algorithm

Description

Type: string

Hash-Algorithm

Description

Type: string

Lifebytes

Description

Type: string

Lifetime

Description

Type: number

Local-IP

Description

Type: string

Local-Port

Description

Type: number

Local-SPI

Description

Type: string

Mode

Description

Type: string

NAT-Traversal

Description

Type: number

Peer-IP

Description

Type: string

Peer-Port

Description

Type: number

Protocol

Description

Type: string

Remote-SPI

Description

Type: string

SA-Index

Description

Type: number

Status

Description

Type: string

TS-Proto

Description

Type: number

anti-replay-num

Description

Type: number

bytes-decrypted

Description

Type: number

bytes-encrypted

Description

Type: number

cavium-bytes-decrypted

Description

Type: number

cavium-bytes-encrypted

Description

Type: number

cavium-packets-decrypted

Description

Type: number

cavium-packets-encrypted

Description

Type: number

enforce-ts-decap-drop

Description

Type: number

enforce-ts-encap-drop

Description

Type: number

frag-after-encap-frag-packets

Description

Type: number

frag-received

Description

Type: number

invalid-tunnel-id

Description

Type: number

no-next-hop

Description

Type: number

no-tunnel-found

Description

Type: number

packets-decrypted

Description

Type: number

packets-encrypted

Description

Type: number

packets-err-encryption

Description

Type: number

packets-err-icv-check

Description

Type: number

packets-err-inactive

Description

Type: number

packets-err-lifetime-lifebytes

Description

packets-err-nh-check

Description

Type: number

packets-err-pad-check

Description

Type: number

packets-err-pkt-sanity

Description

Type: number

pkt-fail-prep-to-send

Description

Type: number

pkt-fail-to-send

Description

Type: number

prefrag-error

Description

Type: number

prefrag-success

Description

Type: number

qat-bytes-decrypted

Description

Type: number

qat-bytes-encrypted

Description

Type: number

qat-packets-decrypted

Description

Type: number

qat-packets-encrypted

Description

Type: number

rekey-num

Description

Type: number

sequence-num

Description

Type: number

sequence-num-rollover

Description

Type: number

tunnel-intf-down

Description

Type: number

crl¶

Specification Value

Type object

oper

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

Type: Object

crl_oper¶

Specification Value

Type object

crl-list

Type: List

total-crls

Description

Type: number

crl_oper_crl-list¶

Specification Value

Type list

Block object keys

issuer

Description

Type: string

revoked

Description

Type: string

serial

Description

Type: string

storage-type

Description

Type: string

subject

Description

Type: string

updates

Description

Type: string

ocsp¶

Specification Value

Type object

oper

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

Type: Object

ocsp_oper¶

Specification Value

Type object

ocsp-list

Type: List

total-ocsps

Description

Type: number

ocsp_oper_ocsp-list¶

Specification Value

Type list

Block object keys

certificate-status

Description

Type: string

issuer

Description

Type: string

subject

Description

Type: string

validity

Description

Type: string