Avi PingAccessAgent Object API

CLI ``` - configure pingaccessagent - show pingaccessagent ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 20.1.2
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 /pingaccessagent
  2. post /pingaccessagent
  3. delete /pingaccessagent/{uuid}
  4. get /pingaccessagent/{uuid}
  5. patch /pingaccessagent/{uuid}
  6. put /pingaccessagent/{uuid}
Up
get /pingaccessagent
(pingaccessagentGet)

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

PingAccessAgentApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "properties_file_data" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "description" : "aeiou",
    "primary_server" : {
      "hostname" : "aeiou",
      "port" : 123,
      "ip" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      }
    },
    "uuid" : "aeiou",
    "pingaccess_pool_ref" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou",
    "labels" : [ {
      "value" : "aeiou",
      "key" : "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 PingAccessAgentApiResponse

401

log in failed

Up
post /pingaccessagent
(pingaccessagentPost)

Consumes

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

Request body

body (required)
Body Parameter — PingAccessAgent object creation

Return type

PingAccessAgent

Example data

Content-Type: application/json
{
  "properties_file_data" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "primary_server" : {
    "hostname" : "aeiou",
    "port" : 123,
    "ip" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    }
  },
  "uuid" : "aeiou",
  "pingaccess_pool_ref" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "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 PingAccessAgent

401

log in failed

Up
delete /pingaccessagent/{uuid}
(pingaccessagentUuidDelete)

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 /pingaccessagent/{uuid}
(pingaccessagentUuidGet)

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

PingAccessAgent

Example data

Content-Type: application/json
{
  "properties_file_data" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "primary_server" : {
    "hostname" : "aeiou",
    "port" : 123,
    "ip" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    }
  },
  "uuid" : "aeiou",
  "pingaccess_pool_ref" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "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 PingAccessAgent

401

log in failed

Up
patch /pingaccessagent/{uuid}
(pingaccessagentUuidPatch)

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 — PingAccessAgent object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

PingAccessAgent

Example data

Content-Type: application/json
{
  "properties_file_data" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "primary_server" : {
    "hostname" : "aeiou",
    "port" : 123,
    "ip" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    }
  },
  "uuid" : "aeiou",
  "pingaccess_pool_ref" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "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 PingAccessAgent

401

log in failed

Up
put /pingaccessagent/{uuid}
(pingaccessagentUuidPut)

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 — PingAccessAgent object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

PingAccessAgent

Example data

Content-Type: application/json
{
  "properties_file_data" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "primary_server" : {
    "hostname" : "aeiou",
    "port" : 123,
    "ip" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    }
  },
  "uuid" : "aeiou",
  "pingaccess_pool_ref" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "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 PingAccessAgent

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. IpAddr
  2. KeyValue
  3. PingAccessAgent
  4. PingAccessAgentApiResponse
  5. PoolServer

IpAddr Up

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

KeyValue Up

key
String Key.
value (optional)
String Value.

PingAccessAgent Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
description (optional)
String Field introduced in 18.2.3.
labels (optional)
array[KeyValue] Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2.
name
String Name of the PingAccess Agent. Field introduced in 18.2.3.
pingaccess_pool_ref
String Pool containing a primary PingAccess Server, as well as any failover servers included in the agent.properties file. It is a reference to an object of type Pool. Field introduced in 18.2.3.
primary_server
PoolServer The ip and port of the primary PingAccess Server. Field introduced in 18.2.3.
properties_file_data
String PingAccessAgent's agent.properties file generated by PingAccess server. Field introduced in 18.2.3.
tenant_ref (optional)
String It is a reference to an object of type Tenant. Field introduced in 18.2.3.
url (optional)
String url
uuid (optional)
String UUID of the PingAccess Agent. Field introduced in 18.2.3.

PingAccessAgentApiResponse Up

count
Integer format: int32
results
next (optional)

PoolServer Up

hostname (optional)
String DNS resolvable name of the server. May be used in place of the IP address.
ip
IpAddr IP address of the server in the poool.
port (optional)
Integer Port of the pool server listening for HTTP/HTTPS. Default value is the default port in the pool. Allowed values are 1-65535. format: int32