Avi StatediffSnapshot Object API
CLI ``` - show statediff ```
Contact Info: support@avinetworks.com
Version: 21.1.6
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /statediffoperationpost /statediffoperationdelete /statediffoperation/{uuid}get /statediffoperation/{uuid}patch /statediffoperation/{uuid}put /statediffoperation/{uuid}
Up
get /statediffoperation
(statediffoperationGet)
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" : [ {
"gslb_uuid" : "aeiou",
"se_group_name" : "aeiou",
"vs_name" : "aeiou",
"pre_snapshot" : {
"poolsnapshot" : "",
"vssnapshot" : "",
"gssnapshot" : "",
"sesnapshot" : ""
},
"se_group_uuid" : "aeiou",
"se_name" : "aeiou",
"uuid" : "aeiou",
"pool_name" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"gslb_name" : "aeiou",
"vs_uuid" : "aeiou",
"statediff_operation_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"snapshot_type" : "aeiou",
"pool_uuid" : "aeiou",
"post_snapshot" : {
"poolsnapshot" : {
"oper_status" : ""
},
"vssnapshot" : {
"oper_status" : ""
},
"gssnapshot" : {
"oper_status" : {
"reason_code" : 123456789,
"reason" : [ "aeiou" ],
"last_changed_time" : {
"usecs" : 123456789,
"secs" : 123456789
},
"state" : "aeiou",
"reason_code_string" : "aeiou"
}
},
"sesnapshot" : {
"oper_status" : ""
}
},
"se_uuid" : "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
StatediffSnapshotApiResponse
401
log in failed
Up
post /statediffoperation
(statediffoperationPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — StatediffSnapshot object creation
Return type
Example data
Content-Type: application/json
{
"gslb_uuid" : "aeiou",
"se_group_name" : "aeiou",
"vs_name" : "aeiou",
"pre_snapshot" : {
"poolsnapshot" : "",
"vssnapshot" : "",
"gssnapshot" : "",
"sesnapshot" : ""
},
"se_group_uuid" : "aeiou",
"se_name" : "aeiou",
"uuid" : "aeiou",
"pool_name" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"gslb_name" : "aeiou",
"vs_uuid" : "aeiou",
"statediff_operation_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"snapshot_type" : "aeiou",
"pool_uuid" : "aeiou",
"post_snapshot" : {
"poolsnapshot" : {
"oper_status" : ""
},
"vssnapshot" : {
"oper_status" : ""
},
"gssnapshot" : {
"oper_status" : {
"reason_code" : 123456789,
"reason" : [ "aeiou" ],
"last_changed_time" : {
"usecs" : 123456789,
"secs" : 123456789
},
"state" : "aeiou",
"reason_code_string" : "aeiou"
}
},
"sesnapshot" : {
"oper_status" : ""
}
},
"se_uuid" : "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
StatediffSnapshot
401
log in failed
Up
delete /statediffoperation/{uuid}
(statediffoperationUuidDelete)
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 /statediffoperation/{uuid}
(statediffoperationUuidGet)
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
{
"gslb_uuid" : "aeiou",
"se_group_name" : "aeiou",
"vs_name" : "aeiou",
"pre_snapshot" : {
"poolsnapshot" : "",
"vssnapshot" : "",
"gssnapshot" : "",
"sesnapshot" : ""
},
"se_group_uuid" : "aeiou",
"se_name" : "aeiou",
"uuid" : "aeiou",
"pool_name" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"gslb_name" : "aeiou",
"vs_uuid" : "aeiou",
"statediff_operation_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"snapshot_type" : "aeiou",
"pool_uuid" : "aeiou",
"post_snapshot" : {
"poolsnapshot" : {
"oper_status" : ""
},
"vssnapshot" : {
"oper_status" : ""
},
"gssnapshot" : {
"oper_status" : {
"reason_code" : 123456789,
"reason" : [ "aeiou" ],
"last_changed_time" : {
"usecs" : 123456789,
"secs" : 123456789
},
"state" : "aeiou",
"reason_code_string" : "aeiou"
}
},
"sesnapshot" : {
"oper_status" : ""
}
},
"se_uuid" : "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
StatediffSnapshot
401
log in failed
Up
patch /statediffoperation/{uuid}
(statediffoperationUuidPatch)
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 — StatediffSnapshot object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"gslb_uuid" : "aeiou",
"se_group_name" : "aeiou",
"vs_name" : "aeiou",
"pre_snapshot" : {
"poolsnapshot" : "",
"vssnapshot" : "",
"gssnapshot" : "",
"sesnapshot" : ""
},
"se_group_uuid" : "aeiou",
"se_name" : "aeiou",
"uuid" : "aeiou",
"pool_name" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"gslb_name" : "aeiou",
"vs_uuid" : "aeiou",
"statediff_operation_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"snapshot_type" : "aeiou",
"pool_uuid" : "aeiou",
"post_snapshot" : {
"poolsnapshot" : {
"oper_status" : ""
},
"vssnapshot" : {
"oper_status" : ""
},
"gssnapshot" : {
"oper_status" : {
"reason_code" : 123456789,
"reason" : [ "aeiou" ],
"last_changed_time" : {
"usecs" : 123456789,
"secs" : 123456789
},
"state" : "aeiou",
"reason_code_string" : "aeiou"
}
},
"sesnapshot" : {
"oper_status" : ""
}
},
"se_uuid" : "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
StatediffSnapshot
401
log in failed
Up
put /statediffoperation/{uuid}
(statediffoperationUuidPut)
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 — StatediffSnapshot object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"gslb_uuid" : "aeiou",
"se_group_name" : "aeiou",
"vs_name" : "aeiou",
"pre_snapshot" : {
"poolsnapshot" : "",
"vssnapshot" : "",
"gssnapshot" : "",
"sesnapshot" : ""
},
"se_group_uuid" : "aeiou",
"se_name" : "aeiou",
"uuid" : "aeiou",
"pool_name" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"gslb_name" : "aeiou",
"vs_uuid" : "aeiou",
"statediff_operation_ref" : "aeiou",
"tenant_ref" : "aeiou",
"name" : "aeiou",
"snapshot_type" : "aeiou",
"pool_uuid" : "aeiou",
"post_snapshot" : {
"poolsnapshot" : {
"oper_status" : ""
},
"vssnapshot" : {
"oper_status" : ""
},
"gssnapshot" : {
"oper_status" : {
"reason_code" : 123456789,
"reason" : [ "aeiou" ],
"last_changed_time" : {
"usecs" : 123456789,
"secs" : 123456789
},
"state" : "aeiou",
"reason_code_string" : "aeiou"
}
},
"sesnapshot" : {
"oper_status" : ""
}
},
"se_uuid" : "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
StatediffSnapshot
401
log in failed
[ Jump to Methods ]
Table of Contents
FbGsInfoFbPoolInfoFbSeInfoFbVsInfoOperationalStatuspostsnapshotpresnapshotStatediffSnapshotStatediffSnapshotApiResponseTimeStamp
oper_status (optional)
OperationalStatus FB snapshot data. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
oper_status (optional)
OperationalStatus FB snapshot data. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
oper_status (optional)
OperationalStatus FB snapshot data. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
oper_status (optional)
OperationalStatus FB snapshot data. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
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. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
gssnapshot (optional)
FbGsInfo FB Gs snapshot data. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
poolsnapshot (optional)
FbPoolInfo FB Pool snapshot data. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
sesnapshot (optional)
FbSeInfo FB SE snapshot data. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
vssnapshot (optional)
FbVsInfo FB VS snapshot data. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
gssnapshot (optional)
FbGsInfo FB Gs snapshot data. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
poolsnapshot (optional)
FbPoolInfo FB Pool snapshot data. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
sesnapshot (optional)
FbSeInfo FB SE snapshot data. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
vssnapshot (optional)
FbVsInfo FB VS snapshot data. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
gslb_name (optional)
String Name of GSLB object. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
gslb_uuid (optional)
String Reference to base gslb object. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
name (optional)
String Name of Statediff operation. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
pool_name (optional)
String Name of POOL object. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
pool_uuid (optional)
String Reference to base pool object. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
post_snapshot (optional)
postsnapshot Post-Upgrade snapshot for VS. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
pre_snapshot (optional)
presnapshot Pre-Upgrade snapshot for VS. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
se_group_name (optional)
String Name of SEG object. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
se_group_uuid (optional)
String Reference to base SEG object. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
se_name (optional)
String Name of SEG object. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
se_uuid (optional)
String Reference to base SE object. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
snapshot_type (optional)
String Type of snapshot eg. VS_SNAPSHOT, SE_SNAPSHOT etc. Enum options - FB_VS_SNAPSHOT, FB_SE_SNAPSHOT, FB_GSLB_SNAPSHOT, FB_POOL_SNAPSHOT. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
statediff_operation_ref (optional)
String Statediff Operation uuid for identifying the operation. It is a reference to an object of type StatediffOperation. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
tenant_ref (optional)
String Tenant that this object belongs to. It is a reference to an object of type Tenant. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
url (optional)
uuid (optional)
String unique identifier for Statediff entry. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
vs_name (optional)
String Name of VS object. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
vs_uuid (optional)
String Reference to base VS object. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
count
results
next (optional)
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