Avi SCPoolServerStateInfo Object API

CLI ``` - show poolserverstateinfo ```

More information: https://avinetworks.com/contact-us

Contact Info: support@avinetworks.com

Version: 22.1.5

BasePath:/api

http://apache.org/licenses/LICENSE-2.0.html

Access

HTTP Basic Authentication

Methods

[ Jump to Models ]

get /scpoolserverstateinfo
post /scpoolserverstateinfo
delete /scpoolserverstateinfo/{uuid}
get /scpoolserverstateinfo/{uuid}
patch /scpoolserverstateinfo/{uuid}
put /scpoolserverstateinfo/{uuid}

get /scpoolserverstateinfo

(scpoolserverstateinfoGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

name (optional)

Query Parameter — object name

refers_to (optional)

Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid

referred_by (optional)

Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid

fields (optional)

Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

include_name (optional)

Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

skip_default (optional)

Query Parameter — Default values are not set.

join_subresources (optional)

Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

SCPoolServerStateInfoApiResponse

Example data

Content-Type: application/json

{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "is_server" : true,
    "tenant_ref" : "aeiou",
    "server_states" : [ {
      "server_ip" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "server_port" : 123,
      "oper_status" : ""
    } ],
    "pool_id" : "aeiou",
    "oper_status" : {
      "reason_code" : 123456789,
      "reason" : [ "aeiou" ],
      "last_changed_time" : {
        "usecs" : 123456789,
        "secs" : 123456789
      },
      "state" : "aeiou",
      "reason_code_string" : "aeiou"
    },
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK SCPoolServerStateInfoApiResponse

401

post /scpoolserverstateinfo

(scpoolserverstateinfoPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — SCPoolServerStateInfo object creation

Return type

SCPoolServerStateInfo

Example data

Content-Type: application/json

{
  "is_server" : true,
  "tenant_ref" : "aeiou",
  "server_states" : [ {
    "server_ip" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    },
    "server_port" : 123,
    "oper_status" : ""
  } ],
  "pool_id" : "aeiou",
  "oper_status" : {
    "reason_code" : 123456789,
    "reason" : [ "aeiou" ],
    "last_changed_time" : {
      "usecs" : 123456789,
      "secs" : 123456789
    },
    "state" : "aeiou",
    "reason_code_string" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK SCPoolServerStateInfo

401

delete /scpoolserverstateinfo/{uuid}

(scpoolserverstateinfoUuidDelete)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

name (optional)

Query Parameter — object name

Return type

String

Example data

Content-Type: application/json

"aeiou"

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204

object deleted String

404

not found

get /scpoolserverstateinfo/{uuid}

(scpoolserverstateinfoUuidGet)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Query parameters

name (optional)

Query Parameter — object name

fields (optional)

Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

include_name (optional)

Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

skip_default (optional)

Query Parameter — Default values are not set.

join_subresources (optional)

Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

SCPoolServerStateInfo

Example data

Content-Type: application/json

{
  "is_server" : true,
  "tenant_ref" : "aeiou",
  "server_states" : [ {
    "server_ip" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    },
    "server_port" : 123,
    "oper_status" : ""
  } ],
  "pool_id" : "aeiou",
  "oper_status" : {
    "reason_code" : 123456789,
    "reason" : [ "aeiou" ],
    "last_changed_time" : {
      "usecs" : 123456789,
      "secs" : 123456789
    },
    "state" : "aeiou",
    "reason_code_string" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK SCPoolServerStateInfo

401

patch /scpoolserverstateinfo/{uuid}

(scpoolserverstateinfoUuidPatch)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — SCPoolServerStateInfo object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

SCPoolServerStateInfo

Example data

Content-Type: application/json

{
  "is_server" : true,
  "tenant_ref" : "aeiou",
  "server_states" : [ {
    "server_ip" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    },
    "server_port" : 123,
    "oper_status" : ""
  } ],
  "pool_id" : "aeiou",
  "oper_status" : {
    "reason_code" : 123456789,
    "reason" : [ "aeiou" ],
    "last_changed_time" : {
      "usecs" : 123456789,
      "secs" : 123456789
    },
    "state" : "aeiou",
    "reason_code_string" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK SCPoolServerStateInfo

401

put /scpoolserverstateinfo/{uuid}

(scpoolserverstateinfoUuidPut)

Path parameters

uuid (required)

Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

application/json

Request body

body (required)

Body Parameter — SCPoolServerStateInfo object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

SCPoolServerStateInfo

Example data

Content-Type: application/json

{
  "is_server" : true,
  "tenant_ref" : "aeiou",
  "server_states" : [ {
    "server_ip" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    },
    "server_port" : 123,
    "oper_status" : ""
  } ],
  "pool_id" : "aeiou",
  "oper_status" : {
    "reason_code" : 123456789,
    "reason" : [ "aeiou" ],
    "last_changed_time" : {
      "usecs" : 123456789,
      "secs" : 123456789
    },
    "state" : "aeiou",
    "reason_code_string" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

200

OK SCPoolServerStateInfo

401

Models

[ Jump to Methods ]

IpAddr
OperationalStatus
SCPoolServerStateInfo
SCPoolServerStateInfoApiResponse
SCServerStateInfo
TimeStamp

IpAddr Up

addr

String IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

type

String Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

OperationalStatus Up

last_changed_time (optional)

TimeStamp Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

reason (optional)

array[String] Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

reason_code (optional)

Long Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int64

reason_code_string (optional)

String Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

state (optional)

String Enum options - OPER_UP, OPER_DOWN, OPER_CREATING, OPER_RESOURCES, OPER_INACTIVE, OPER_DISABLED, OPER_UNUSED, OPER_UNKNOWN, OPER_PROCESSING, OPER_INITIALIZING, OPER_ERROR_DISABLED, OPER_AWAIT_MANUAL_PLACEMENT, OPER_UPGRADING, OPER_SE_PROCESSING, OPER_PARTITIONED, OPER_DISABLING, OPER_FAILED, OPER_UNAVAIL, OPER_AGGREGATE_DOWN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

SCPoolServerStateInfo Up

_last_modified (optional)

String UNIX time since epoch in microseconds. Units(MICROSECONDS).

is_server (optional)

Boolean Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

oper_status (optional)

OperationalStatus Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

pool_id (optional)

String Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

server_states (optional)

array[SCServerStateInfo] Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

tenant_ref (optional)

String It is a reference to an object of type Tenant. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

url (optional)

String url

uuid (optional)

String Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

SCPoolServerStateInfoApiResponse Up

count

Integer format: int32

results

array[SCPoolServerStateInfo]

next (optional)

String

SCServerStateInfo Up

oper_status (optional)

OperationalStatus Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

server_ip (optional)

IpAddr Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

server_port (optional)

Integer Allowed values are 1-65535. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int32

TimeStamp Up

secs

Long Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int64

usecs

Long Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int64

Avi SCPoolServerStateInfo Object API

Access

Table of Contents

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Consumes

Request body

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

204

404

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Table of Contents