ACOS
  • Start Here
  • How to Use this Reference
  • Resources
  • Operations
  • Example API Configuration
  • Filters
  • Batching Requests
  • Status Codes
  • aam
  • access-list
  • accounting
  • acos-events
  • admin
  • admin-lockout
  • allow-slb-cfg
  • application-type
  • audit
  • authentication
  • authorization
  • automatic-update
  • axdebug
  • backup-periodic
  • banner
  • bgp
  • bios-prog
  • cgnv6
  • class-list
  • cloud-services
  • delete
  • disable-management
  • dnssec
  • domain-list
  • enable-core
  • enable-management
  • environment
  • event
  • event-notification
  • fail-safe
  • fan-speed
  • file-inspection
  • fw
  • glid
  • glm
  • gslb
  • harmony-controller
  • hd-monitor
  • health
  • hostname
  • hsm
  • import-periodic
  • interface
  • ip
  • ip-list
  • ipv4-in-ipv6
  • ipv6
  • ipv6-in-ipv4
  • key
  • ldap-server
  • license-manager
  • locale
  • logging
  • maximum-paths
  • merge-mode-add
  • mirror-port
  • misc
  • monitor
  • multi-config
  • net-mgmt
  • netflow
  • network
  • ntp
  • object
  • object-group
  • overlay-mgmt-info
  • overlay-tunnel
  • partition
  • partition-group
  • pki
  • radius-server
  • rate-limit
  • rba
  • remove-upgrade-lock
  • report
  • resource-track
  • route-map
  • router
  • rule-set
  • running-config
  • scaleout
  • scaleout-cgn
  • sctp
  • service-partition
  • session-filter
  • sflow
  • single-board-mode
  • slb
  • smtp
  • snmp-server
  • so-counters
  • ssh-login-grace-time
  • syn-cookie
  • sys-ut
  • system
  • system-2x40g-mode
  • system-4x10g-mode
  • system-buff-debug
  • system-jumbo-global
  • system-view
  • tacacs-server
  • techreport
  • techsupport
  • template
  • terminal
  • tftp
  • threat-intel
  • timezone
  • vcs
  • vcs-vblades
  • visibility
  • vpn
  • vrrp-a
  • waf
  • web-category
  • web-service
  • zone
  • aam
  • access-list
  • active-partition
  • admin
  • admin-detail
  • admin-session
  • automatic-update
  • axdebug
  • backup
  • boot-block-fix
  • bootimage
  • cgnv6
  • chassis-info
  • chassis-infra
  • clock
  • cmcov
  • config-filter
  • config-sync-status
  • configure
  • copy
  • debug
  • delete
  • device-context
  • dnssec
  • enable-password
  • erase
  • export
  • file
  • file-inspection
  • fw
  • glm
  • gslb
  • harmony-controller
  • health
  • import
  • interface
  • link
  • locale
  • logging
  • miscellenious-alb
  • multi-ctrl-cpu
  • network
  • ntp-status
  • partition-all
  • partition-available-id
  • pki
  • plat-cpu-drop
  • plat-cpu-packet
  • poap
  • reboot
  • reload
  • rename
  • report
  • restore
  • rrd
  • rule-set
  • scaleout
  • scm
  • sessions
  • set-product-id
  • shutdown
  • slb
  • sshd
  • ssl
  • sys-audit-log
  • sys-ut
  • syslog
  • system
  • system-big-buff-pool
  • system-cpu
  • system-reset
  • system-view
  • threat-intel
  • upgrade
  • vcs
  • vcs-chassis
  • version
  • visibility
  • vpn
  • vrrp-a
  • web-service
  • write
ACOS
  • Docs »
  • slb template link-probe
  • View page source

slb template link-probe¶

Link probe template

link-probe Specification¶

   
Type Collection
Object Key(s) name
Collection Name link-probe-list
Collection URI /axapi/v3/slb/template/link-probe
Element Name link-probe
Element URI /axapi/v3/slb/template/link-probe/{name}
Element Attributes link-probe_attributes
Schema link-probe schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/slb/template/link-probe

link-probe attributes

Create List

POST

/axapi/v3/slb/template/link-probe

link-probe attributes

Get Object

GET

/axapi/v3/slb/template/link-probe/{name}

link-probe attributes

Get List

GET

/axapi/v3/slb/template/link-probe

link-probe-list

Modify Object

POST

/axapi/v3/slb/template/link-probe/{name}

link-probe attributes

Replace Object

PUT

/axapi/v3/slb/template/link-probe/{name}

link-probe attributes

Replace List

PUT

/axapi/v3/slb/template/link-probe

link-probe-list

Delete Object

DELETE

/axapi/v3/slb/template/link-probe/{name}

link-probe attributes

link-probe-list¶

link-probe-list is JSON List of link-probe attributes

link-probe-list : [

{ link-probe attributes },

{ link-probe attributes },

…

]

link-probe attributes¶

destination

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

Type: Object

Refernce Object: /axapi/v3/slb/template/link-probe/{name}/destination

disable

Description Disable Probe template

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

expected-status-code

Description Specify response code range (e.g. 200,400-430), default is 200 (Format is xx,xx-xx (xx between [100, 899]), default is 200)

Type: string

Format: string-rlx

Maximum Length: 31 characters

Maximum Length: 1 characters

Default: 200

name

Description probe template Name

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

probe-interval

Description Time between each probe that needs to be sent out (in seconds, default is 5)

Type: number

Range: 1-2147483647

Default: 5

probes-per-test

Description Total number of probes to be sent out for each test

Type: number

Range: 1-10

Default: 5

rtt-method

Description ‘http-rtt’: Calculate Round Trip Time between HTTP request and response; ‘tcp-srtt’: Use TCP Smoothed round trip time in the HTTP connection;

Type: string

Supported Values: http-rtt, tcp-srtt

Default: http-rtt

test-interval

Description time interval between subsequent tests (in seconds, default is 60)

Type: number

Range: 1-2147483647

Default: 60

url

Description Specify URL to which probes should be sent out. Default is /

Type: string

Format: string-rlx

Maximum Length: 1023 characters

Maximum Length: 1 characters

Default: /

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

destination¶

Specification  
Type object

hostname

Description Target Hostname

Type: string

Format: string-rlx

Maximum Length: 127 characters

Maximum Length: 1 characters

resolve-as

Description ‘resolve-to-ipv4’: Use A Query only to resolve the configured hostname; ‘resolve-to-ipv6’: Use AAAA Query only to resolve the configured hostname;

Type: string

Supported Values: resolve-to-ipv4, resolve-to-ipv6

Mutual Exclusion: resolve-as static-ipv4-addr and static-ipv6-addr are mutually exclusive

static-ipv4-addr

Description Target IPv4 Address

Type: string

Format: ipv4-address

Mutual Exclusion: static-ipv4-addr resolve-as and static-ipv6-addr are mutually exclusive

static-ipv6-addr

Description Target IPv6 Address

Type: string

Format: ipv6-address

Mutual Exclusion: static-ipv6-addr resolve-as and static-ipv4-addr are mutually exclusive

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters


© Copyright 2022, A10 Networks

Built with Sphinx using a theme provided by Read the Docs.