VirtualizationFaults

Fetch a list of all virtualization faults

SecurityApiKeyAuth
Request
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

sort
string or null

The field to sort results by. A property name with a prepended '-' signifies descending order.

Enum: "id" "-id" "engine_id" "-engine_id" "bundle_id" "-bundle_id" "target_name" "-target_name" "target_object_type" "-target_object_type" "target_object_id" "-target_object_id" "title" "-title" "description" "-description" "fault_action" "-fault_action" "response" "-response" "severity" "-severity" "status" "-status" "date_diagnosed" "-date_diagnosed" "date_resolved" "-date_resolved" "resolution_comments" "-resolution_comments"
Example: sort=id
Responses
200

OK

get/virtualization-faults/history
Response samples
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Search virtualization faults

SecurityApiKeyAuth
Request
query Parameters
limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of objects to return per query. The value must be between 1 and 1000. Default is 100.

Example: limit=50
cursor
string [ 1 .. 4096 ] characters

Cursor to fetch the next or previous page of results. The value of this property must be extracted from the 'prev_cursor' or 'next_cursor' property of a PaginatedResponseMetadata which is contained in the response of list and search API endpoints.

sort
string or null

The field to sort results by. A property name with a prepended '-' signifies descending order.

Enum: "id" "-id" "engine_id" "-engine_id" "bundle_id" "-bundle_id" "target_name" "-target_name" "target_object_type" "-target_object_type" "target_object_id" "-target_object_id" "title" "-title" "description" "-description" "fault_action" "-fault_action" "response" "-response" "severity" "-severity" "status" "-status" "date_diagnosed" "-date_diagnosed" "date_resolved" "-date_resolved" "resolution_comments" "-resolution_comments"
Example: sort=id
Request Body schema: application/json

A request body containing a filter expression. This enables searching for items matching arbitrarily complex conditions. The list of attributes which can be used in filter expressions is available in the x-filterable vendor extension.

Filter Expression Overview

Note: All keywords are case-insensitive

Comparison Operators

Operator Description Example
CONTAINS Substring or membership testing for string and list attributes respectively. field3 CONTAINS 'foobar', field4 CONTAINS TRUE
IN Tests if field is a member of a list literal. List can contain a maximum of 100 values field2 IN ['Goku', 'Vegeta']
GE Tests if a field is greater than or equal to a literal value field1 GE 1.2e-2
GT Tests if a field is greater than a literal value field1 GT 1.2e-2
LE Tests if a field is less than or equal to a literal value field1 LE 9000
LT Tests if a field is less than a literal value field1 LT 9.02
NE Tests if a field is not equal to a literal value field1 NE 42
EQ Tests if a field is equal to a literal value field1 EQ 42

Search Operator

The SEARCH operator filters for items which have any filterable attribute that contains the input string as a substring, comparison is done case-insensitively. This is not restricted to attributes with string values. Specifically SEARCH '12' would match an item with an attribute with an integer value of 123.

Logical Operators

Ordered by precedence.

Operator Description Example
NOT Logical NOT (Right associative) NOT field1 LE 9000
AND Logical AND (Left Associative) field1 GT 9000 AND field2 EQ 'Goku'
OR Logical OR (Left Associative) field1 GT 9000 OR field2 EQ 'Goku'

Grouping

Parenthesis () can be used to override operator precedence.

For example: NOT (field1 LT 1234 AND field2 CONTAINS 'foo')

Literal Values

Literal Description Examples
Nil Represents the absence of a value nil, Nil, nIl, NIL
Boolean true/false boolean true, false, True, False, TRUE, FALSE
Number Signed integer and floating point numbers. Also supports scientific notation. 0, 1, -1, 1.2, 0.35, 1.2e-2, -1.2e+2
String Single or double quoted "foo", "bar", "foo bar", 'foo', 'bar', 'foo bar'
Datetime Formatted according to RFC3339 2018-04-27T18:39:26.397237+00:00
List Comma-separated literals wrapped in square brackets [0], [0, 1], ['foo', "bar"]

Limitations

  • A maximum of 8 unique identifiers may be used inside a filter expression.
filter_expression
string [ 5 .. 2000 ] characters
Responses
200

OK

post/virtualization-faults/history/search
Request samples
application/json

An example of a nested Object comparison testing that at least one repository has a version which is equal to 19.0.0.

{
  • "filter_expression": "repositories CONTAINS {version eq '19.0.0'}"
}
Response samples
{
  • "items": [
    ],
  • "response_metadata": {
    }
}

Marks selected faults as resolved or ignored.

SecurityApiKeyAuth
Request
Request Body schema: application/json
engine_id
string

The ID of the engine that the faults belong to.

ignore
boolean
Default: false

Flag indicating whether to ignore the selected faults if they are detected on the same objects in the future.

fault_ids
Array of strings

The IDs of the faults to resolve or ignore.

Responses
200

OK

post/virtualization-faults/resolveOrIgnore
Request samples
application/json
{
  • "engine_id": "string",
  • "ignore": false,
  • "fault_ids": [
    ]
}
Response samples
application/json
{
  • "job": {
    }
}

Marks all active faults of an engine that the user has permissions over as resolved.

SecurityApiKeyAuth
Request
path Parameters
engineId
required
string

The ID of the registered engine.

Responses
200

OK

post/virtualization-faults/{engineId}/resolveAll
Response samples
application/json
{
  • "job": {
    }
}

Marks the fault as resolved. The Delphix engine will attempt to automatically detect cases where the fault has been resolved; but this is not always possible and may only occur on periodic intervals. In these cases, the user can proactively mark the fault resolved. This does not change the underlying disposition of the fault - if the problem is still present the system may immediately diagnose the same problem again. This should only be used to notify the system of resolution after the underlying problem has been resolved.

SecurityApiKeyAuth
Request
path Parameters
faultId
required
string non-empty

The ID of the Virtualization Fault.

Request Body schema: application/json
ignore
boolean
Default: false

Flag indicating whether to ignore this fault if it is detected on the same object in the future.

resolution_comments
string

The comments describing the steps taken to resolve a fault.

Responses
200

OK

post/virtualization-fault/{faultId}/resolve
Request samples
application/json
{
  • "ignore": false,
  • "resolution_comments": "string"
}
Response samples
application/json
{
  • "job": {
    }
}
➔ Next to Jobs