Avi InventoryFaultConfig Object API
CLI ``` - configure inventoryfaultconfig - show inventoryfaultconfig ```
Contact Info: support@avinetworks.com
Version: 20.1.9
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /inventoryfaultconfig
post /inventoryfaultconfig
delete /inventoryfaultconfig/{uuid}
get /inventoryfaultconfig/{uuid}
patch /inventoryfaultconfig/{uuid}
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
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
},
"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 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
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
},
"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 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 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
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
},
"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 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
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
},
"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 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
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
},
"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 request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
InventoryFaultConfig
401
log in failed
[ Jump to Methods ]
Table of Contents
ControllerFaults
InventoryFaultConfig
InventoryFaultConfigApiResponse
ServiceengineFaults
VirtualserviceFaults
backup_scheduler_faults (optional)
Boolean Enable backup scheduler faults. Field introduced in 20.1.6.
cluster_faults (optional)
Boolean Enable cluster faults. Field introduced in 20.1.6.
deprecated_api_version_faults (optional)
Boolean Enable deprecated api version faults. Field introduced in 20.1.6.
license_faults (optional)
Boolean Enable license faults. Field introduced in 20.1.6.
migration_faults (optional)
Boolean Enable DB migration faults. Field introduced in 20.1.6.
sslprofile_faults (optional)
Boolean Enable SSL Profile faults. Field introduced in 20.1.6.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
controller_faults (optional)
name (optional)
String Name. Field introduced in 20.1.6.
serviceengine_faults (optional)
tenant_ref (optional)
String Tenant. It is a reference to an object of type Tenant. Field introduced in 20.1.6.
url (optional)
uuid (optional)
String UUID Auto generated. Field introduced in 20.1.6.
virtualservice_faults (optional)
count
results
next (optional)
debug_faults (optional)
Boolean Enable debug faults. Field introduced in 20.1.6.
debug_faults (optional)
Boolean Enable debug faults. Field introduced in 20.1.6.
pool_server_faults (optional)
Boolean Enable pool server faults. Field introduced in 20.1.6.
scaleout_faults (optional)
Boolean Enable VS scaleout and scalein faults. Field introduced in 20.1.6.
shared_vip_faults (optional)
Boolean Enable shared vip faults. Field introduced in 20.1.6.
ssl_cert_expiry_faults (optional)
Boolean Enable SSL certificate expiry faults. Field introduced in 20.1.6.
ssl_cert_status_faults (optional)
Boolean Enable SSL certificate status faults. Field introduced in 20.1.6.