Avi SCPoolServerStateInfo Object API

##CLI## ``` - show poolserverstateinfo ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 17.2.4
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /scpoolserverstateinfo
  2. post /scpoolserverstateinfo
  3. delete /scpoolserverstateinfo/{uuid}
  4. get /scpoolserverstateinfo/{uuid}
  5. patch /scpoolserverstateinfo/{uuid}
  6. put /scpoolserverstateinfo/{uuid}
Up
get /scpoolserverstateinfo
(scpoolserverstateinfoGet)

Consumes

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

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.
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
{
  "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"
  } ]
}

Produces

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

Responses

200

OK SCPoolServerStateInfoApiResponse

401

log in failed

Up
post /scpoolserverstateinfo
(scpoolserverstateinfoPost)

Consumes

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

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"
}

Produces

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

Responses

200

OK SCPoolServerStateInfo

401

log in failed

Up
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:

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found

Up
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:

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.
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"
}

Produces

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

Responses

200

OK SCPoolServerStateInfo

401

log in failed

Up
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:

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"
}

Produces

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

Responses

200

OK SCPoolServerStateInfo

401

log in failed

Up
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:

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"
}

Produces

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

Responses

200

OK SCPoolServerStateInfo

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. IpAddr
  2. OperationalStatus
  3. SCPoolServerStateInfo
  4. SCPoolServerStateInfoApiResponse
  5. SCServerStateInfo
  6. TimeStamp

IpAddr Up

addr
String IP address.
type
String Enum options - V4, DNS.

OperationalStatus Up

last_changed_time (optional)
TimeStamp Placeholder for description of property last_changed_time of obj type OperationalStatus field type str type object
reason (optional)
array[String] reason of OperationalStatus.
reason_code (optional)
Long Number of reason_code. format: int64
reason_code_string (optional)
String reason_code_string of OperationalStatus.
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.

SCPoolServerStateInfo Up

is_server (optional)
Boolean Field introduced in 17.1.1.
oper_status (optional)
OperationalStatus Field introduced in 17.1.1.
pool_id (optional)
String Field introduced in 17.1.1.
server_states (optional)
array[SCServerStateInfo] Field introduced in 17.1.1.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Field introduced in 17.1.1.
url (optional)
String url
uuid (optional)
String Field introduced in 17.1.1.

SCPoolServerStateInfoApiResponse Up

count
Integer format: int32
results

SCServerStateInfo Up

oper_status (optional)
OperationalStatus Field introduced in 17.1.1.
server_ip (optional)
IpAddr Field introduced in 17.1.1.
server_port (optional)
Integer Allowed values are 1-65535. Field introduced in 17.1.1. format: int32

TimeStamp Up

secs
Long Number of secs. format: int64
usecs
Long Number of usecs. format: int64