ACOS
  • Start Here
  • How to Use this Reference
  • Resources
  • Operations
  • Example API Configuration
  • Filters
  • Batching Requests
  • Status Codes
  • aam
  • access-list
  • accounting
  • active-partition
  • admin
  • admin-lockout
  • application-type
  • audit
  • authentication
  • authorization
  • backup-periodic
  • banner
  • bgp
  • bios-prog
  • cgnv6
  • class-list
  • cloud-services
  • counter
  • delete
  • disable-management
  • dnssec
  • enable-core
  • enable-management
  • environment
  • event
  • export-periodic
  • fail-safe
  • fan-speed
  • fw
  • glid
  • glm
  • gslb
  • hd-monitor
  • health
  • hostname
  • hsm
  • import-periodic
  • interface
  • ip
  • ip-list
  • ipmi-service
  • ipv4-in-ipv6
  • ipv6
  • ipv6-in-ipv4
  • key
  • ldap-server
  • license-manager
  • locale
  • logging
  • maximum-paths
  • merge-mode-add
  • mirror-port
  • monitor
  • multi-config
  • netflow
  • network
  • ntp
  • object
  • object-group
  • overlay-mgmt-info
  • overlay-tunnel
  • partition
  • partition-group
  • pki
  • radius-server
  • rate-limit
  • rba
  • remove-upgrade-lock
  • report
  • route-map
  • router
  • rule-set
  • running-config
  • scaleout
  • session-filter
  • sflow
  • slb
    • slb
    • slb aflow
    • slb common
    • slb common conn-rate-limit
    • slb common conn-rate-limit src-ip
    • slb connection-reuse
    • slb crl-srcip
    • slb dns
    • slb dns-cache
    • slb fast-http-proxy
    • slb fix
    • slb ftp-ctl
    • slb ftp-data
    • slb ftp-proxy
    • slb generic-proxy
    • slb health-gateway
    • slb health-stat
    • slb http-proxy
    • slb hw-compress
    • slb icap
    • slb icap_http
    • slb imap-proxy
    • slb l4
    • slb mssql
    • slb mysql
    • slb passthrough
    • slb perf
    • slb persist
    • slb pop3-proxy
    • slb proxy
    • slb rate-limit-log
    • slb rc-cache-global
    • slb resource-usage
    • slb server
    • slb server port
    • slb service-group
    • slb service-group member
    • slb sip
    • slb smpp
    • slb smtp
    • slb spdy-proxy
    • slb ssl-cert-revoke
    • slb ssl-expire-check
    • slb ssl-forward-proxy
    • slb svm-source-nat
    • slb switch
    • slb template
    • slb template cache
    • slb template cipher
    • slb template client-ssh
    • slb template client-ssl
    • slb template connection-reuse
    • slb template dblb
    • slb template diameter
    • slb template dns
    • slb template dns class-list
    • slb template dns class-list lid
    • slb template dynamic-service
    • slb template external-service
    • slb template fix
    • slb template ftp
    • slb template http
    • slb template http-policy
    • slb template imap-pop3
    • slb template logging
    • slb template monitor
    • slb template persist
    • slb template persist cookie
      • cookie Specification
      • cookie-list
      • cookie attributes
    • slb template persist destination-ip
    • slb template persist source-ip
    • slb template persist ssl-sid
    • slb template policy
    • slb template policy class-list
    • slb template policy class-list lid
    • slb template policy forward-policy
    • slb template policy forward-policy action
    • slb template policy forward-policy source
    • slb template policy forward-policy source destination
    • slb template policy forward-policy source destination any
    • slb template policy forward-policy source destination class-list
    • slb template policy forward-policy source destination web-category-list
    • slb template port
    • slb template reqmod-icap
    • slb template respmod-icap
    • slb template server
    • slb template server-ssh
    • slb template server-ssl
    • slb template sip
    • slb template smpp
    • slb template smtp
    • slb template ssli
    • slb template tcp
    • slb template tcp-proxy
    • slb template udp
    • slb template virtual-port
    • slb template virtual-server
    • slb transparent-acl-template
    • slb transparent-tcp-template
    • slb virtual-server
    • slb virtual-server port
  • smtp
  • snmp-server
  • so-counters
  • syn-cookie
  • system
  • system-4x10g-mode
  • system-buff-debug
  • system-jumbo-global
  • system-view
  • tacacs-server
  • techreport
  • techsupport
  • terminal
  • tftp
  • timezone
  • vcs
  • vcs-vblades
  • vpn
  • vrrp-a
  • waf
  • web-category
  • web-service
  • zone
  • aam
  • admin-session
  • backup
  • boot-block-fix
  • bootimage
  • cgnv6
  • clock
  • configure
  • copy
  • delete
  • device-context
  • dnssec
  • enable-password
  • erase
  • export
  • file
  • fw
  • glm
  • hsm
  • import
  • link
  • locale
  • logging
  • multi-ctrl-cpu
  • pki
  • poap
  • reboot
  • reload
  • report
  • restore
  • rule-set
  • set-product-id
  • shutdown
  • slb
  • sshd
  • system
  • system-big-buff-pool
  • system-io-buff
  • system-poll-mode
  • system-reset
  • upgrade
  • vcs
  • vrrp-a
  • web-service
  • write
ACOS
  • Docs »
  • slb »
  • slb template persist cookie
  • View page source

slb template persist cookie¶

Cookie persistence

cookie Specification¶

   
Type Collection
Object Key(s) name
Collection Name cookie-list
Collection URI /axapi/v3/slb/template/persist/cookie
Element Name cookie
Element URI /axapi/v3/slb/template/persist/cookie/{name}
Element Attributes cookie_attributes
Schema cookie schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/slb/template/persist/cookie

cookie attributes


POST /axapi/v3/slb/template/persist/cookie/
Payload:
{
    "cookie": {
        "name": "a", 
        "domain": "a"
    }
}

Create List

POST

/axapi/v3/slb/template/persist/cookie

cookie attributes

Get Object

GET

/axapi/v3/slb/template/persist/cookie/{name}

cookie attributes


GET /axapi/v3/slb/template/persist/cookie/a
Reponse:
{
    "cookie": {
        "name": "a", 
        "domain": "a", 
        "dont-honor-conn-rules": 0, 
        "insert-always": 0, 
        "cookie-name": "sto-id", 
        "path": "/", 
        "pass-thru": 0, 
        "secure": 0, 
        "httponly": 0, 
        "match-type": 0, 
        "uuid": "b2bb0876-8483-11e6-b14c-001fa013991c"
    }
}

Get List

GET

/axapi/v3/slb/template/persist/cookie

cookie-list

Modify Object

POST

/axapi/v3/slb/template/persist/cookie/{name}

cookie attributes

Replace Object

PUT

/axapi/v3/slb/template/persist/cookie/{name}

cookie attributes


PUT /axapi/v3/slb/template/persist/cookie/a
Payload:
{
    "cookie": {
        "name": "a", 
        "domain": "abcd"
    }
}

Replace List

PUT

/axapi/v3/slb/template/persist/cookie

cookie-list

Delete Object

DELETE

/axapi/v3/slb/template/persist/cookie/{name}

cookie attributes


DELETE /axapi/v3/slb/template/persist/cookie/a
Reponse:
{
    "response": {
        "status": "OK"
    }
}

cookie-list¶

cookie-list is JSON List of cookie attributes

cookie-list : [

{ cookie attributes },

{ cookie attributes },

…

]

cookie attributes¶

cookie-name

Description Set cookie name (Cookie name, default “sto-id”)

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

Default: sto-id

domain

Description Set cookie domain

Type: string

Maximum Length: 31 characters

Maximum Length: 1 characters

dont-honor-conn-rules

Description Do not observe connection rate rules

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

encrypt-level

Description Encryption level for cookie name / value

Type: number

Range: 0-1

Default: 1

encrypted

Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED password string)

expire

Description Set cookie expiration time (Expiration in seconds)

Type: number

Range: 0-31536000

httponly

Description Enable HttpOnly attribute

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

insert-always

Description Insert persist cookie to every reponse

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

match-type

Description Persist for server, default is port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

name

Description Cookie persistence (Cookie persistence template name)

Type: string

Format: string-rlx

Maximum Length: 63 characters

Maximum Length: 1 characters

pass-phrase

Description Set passphrase for encryption

Type: string

Format: password

Maximum Length: 8 characters

Maximum Length: 8 characters

Default: ACOS4KEY

pass-thru

Description Pass thru mode - Server sends the persist cookie

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

path

Description Set cookie path (Cookie path, default is “/”)

Type: string

Format: string-rlx

Maximum Length: 31 characters

Maximum Length: 1 characters

Default: /

scan-all-members

Description Persist within the same server SCAN

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

secure

Description Enable secure attribute

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

server

Description Persist to the same server, default is port

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: server and service-group are mutually exclusive

server-service-group

Description Persist to the same server and within the same service group

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

service-group

Description Persist within the same service group

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: service-group and server are mutually exclusive

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

Next Previous

© Copyright 2014-2016, a10.

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