Avi InventoryFaultConfig Object API

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

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

InventoryFaultConfigApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "virtualservice_faults" : {
      "debug_faults" : true,
      "scaleout_faults" : true,
      "pool_server_faults" : true,
      "shared_vip_faults" : true,
      "ssl_cert_expiry_faults" : true,
      "ssl_cert_status_faults" : true
    },
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "serviceengine_faults" : {
      "debug_faults" : true
    },
    "configpb_attributes" : {
      "version" : 123
    },
    "controller_faults" : {
      "backup_scheduler_faults" : true,
      "deprecated_api_version_faults" : true,
      "license_faults" : true,
      "cluster_faults" : true,
      "migration_faults" : true,
      "sslprofile_faults" : true
    },
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "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 InventoryFaultConfigApiResponse

401

log in failed

Up
post /inventoryfaultconfig
(inventoryfaultconfigPost)

Consumes

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

Request body

body (required)
Body Parameter — InventoryFaultConfig object creation

Return type

InventoryFaultConfig

Example data

Content-Type: application/json
{
  "virtualservice_faults" : {
    "debug_faults" : true,
    "scaleout_faults" : true,
    "pool_server_faults" : true,
    "shared_vip_faults" : true,
    "ssl_cert_expiry_faults" : true,
    "ssl_cert_status_faults" : true
  },
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "serviceengine_faults" : {
    "debug_faults" : true
  },
  "configpb_attributes" : {
    "version" : 123
  },
  "controller_faults" : {
    "backup_scheduler_faults" : true,
    "deprecated_api_version_faults" : true,
    "license_faults" : true,
    "cluster_faults" : true,
    "migration_faults" : true,
    "sslprofile_faults" : true
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "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 InventoryFaultConfig

401

log in failed

Up
delete /inventoryfaultconfig/{uuid}
(inventoryfaultconfigUuidDelete)

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 /inventoryfaultconfig/{uuid}
(inventoryfaultconfigUuidGet)

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

InventoryFaultConfig

Example data

Content-Type: application/json
{
  "virtualservice_faults" : {
    "debug_faults" : true,
    "scaleout_faults" : true,
    "pool_server_faults" : true,
    "shared_vip_faults" : true,
    "ssl_cert_expiry_faults" : true,
    "ssl_cert_status_faults" : true
  },
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "serviceengine_faults" : {
    "debug_faults" : true
  },
  "configpb_attributes" : {
    "version" : 123
  },
  "controller_faults" : {
    "backup_scheduler_faults" : true,
    "deprecated_api_version_faults" : true,
    "license_faults" : true,
    "cluster_faults" : true,
    "migration_faults" : true,
    "sslprofile_faults" : true
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "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 InventoryFaultConfig

401

log in failed

Up
patch /inventoryfaultconfig/{uuid}
(inventoryfaultconfigUuidPatch)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

InventoryFaultConfig

Example data

Content-Type: application/json
{
  "virtualservice_faults" : {
    "debug_faults" : true,
    "scaleout_faults" : true,
    "pool_server_faults" : true,
    "shared_vip_faults" : true,
    "ssl_cert_expiry_faults" : true,
    "ssl_cert_status_faults" : true
  },
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "serviceengine_faults" : {
    "debug_faults" : true
  },
  "configpb_attributes" : {
    "version" : 123
  },
  "controller_faults" : {
    "backup_scheduler_faults" : true,
    "deprecated_api_version_faults" : true,
    "license_faults" : true,
    "cluster_faults" : true,
    "migration_faults" : true,
    "sslprofile_faults" : true
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "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 InventoryFaultConfig

401

log in failed

Up
put /inventoryfaultconfig/{uuid}
(inventoryfaultconfigUuidPut)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

InventoryFaultConfig

Example data

Content-Type: application/json
{
  "virtualservice_faults" : {
    "debug_faults" : true,
    "scaleout_faults" : true,
    "pool_server_faults" : true,
    "shared_vip_faults" : true,
    "ssl_cert_expiry_faults" : true,
    "ssl_cert_status_faults" : true
  },
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "serviceengine_faults" : {
    "debug_faults" : true
  },
  "configpb_attributes" : {
    "version" : 123
  },
  "controller_faults" : {
    "backup_scheduler_faults" : true,
    "deprecated_api_version_faults" : true,
    "license_faults" : true,
    "cluster_faults" : true,
    "migration_faults" : true,
    "sslprofile_faults" : true
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "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 InventoryFaultConfig

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. ConfigPbAttributes
  2. ControllerFaults
  3. InventoryFaultConfig
  4. InventoryFaultConfigApiResponse
  5. ServiceengineFaults
  6. VirtualserviceFaults

ConfigPbAttributes Up

version (optional)
Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32

ControllerFaults Up

backup_scheduler_faults (optional)
Boolean Enable backup scheduler faults. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
cluster_faults (optional)
Boolean Enable cluster faults. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
deprecated_api_version_faults (optional)
Boolean Enable deprecated api version faults. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
license_faults (optional)
Boolean Enable license faults. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
migration_faults (optional)
Boolean Enable DB migration faults. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
sslprofile_faults (optional)
Boolean Enable SSL Profile faults. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

InventoryFaultConfig Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
configpb_attributes (optional)
ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
controller_faults (optional)
ControllerFaults Configure controller faults. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
name (optional)
String Name. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
serviceengine_faults (optional)
ServiceengineFaults Configure serviceengine faults. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
tenant_ref (optional)
String Tenant. It is a reference to an object of type Tenant. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
url (optional)
String url
uuid (optional)
String UUID Auto generated. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
virtualservice_faults (optional)
VirtualserviceFaults Configure VirtualService faults. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

InventoryFaultConfigApiResponse Up

count
Integer format: int32
results
next (optional)

ServiceengineFaults Up

debug_faults (optional)
Boolean Enable debug faults. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

VirtualserviceFaults Up

debug_faults (optional)
Boolean Enable debug faults. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
pool_server_faults (optional)
Boolean Enable pool server faults. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
scaleout_faults (optional)
Boolean Enable VS scaleout and scalein faults. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
shared_vip_faults (optional)
Boolean Enable shared vip faults. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ssl_cert_expiry_faults (optional)
Boolean Enable SSL certificate expiry faults. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
ssl_cert_status_faults (optional)
Boolean Enable SSL certificate status faults. Field introduced in 20.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.