# jbof.query

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: filters

#### filters

Type: array Default: []

List of filters for query results. See API documentation for "Query Methods" for more guidance.

No Additional Items

##### Each item of this array must be:

Type: object
Examples:

    [
        [
            "name",
            "=",
            "bob"
        ]
    ]

    [
        [
            "OR",
            [
                [
                    [
                        "name",
                        "=",
                        "bob"
                    ]
                ],
                [
                    [
                        "name",
                        "=",
                        "larry"
                    ]
                ]
            ]
        ]
    ]

##### Parameter 2: options

#### options

Type: object
Default:
{ "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }

Query options including pagination, ordering, and additional parameters.

No Additional Properties

##

#### Extra

Type: object Default: {}

Extra options are defined on a per-endpoint basis and are described in the documentation for the associated query method.

##

#### Order By

Type: array of string Default: []

An array of field names describing the manner in which query results should be ordered. The field names may also have one of more of the following special prefixes: `-` (reverse sort direction), `nulls_first:` (place any null values at the head of the results list), `nulls_last:` (place any null values at the tail of the results list).

No Additional Items

##### Each item of this array must be:

Type: string
Example:

    [
        "size",
        "-devname",
        "nulls_first:-expiretime"
    ]

##

#### Select

Type: array Default: []

An array of field names specifying the exact fields to include in the query return. The dot character `.` may be used to explicitly select only subkeys of the query result.

No Additional Items

##### Each item of this array must be:

## Any of

Type: string
Type: array
No Additional Items

##### Each item of this array must be:

Type: object
Example:

    [
        "username",
        "Authentication.status"
    ]

##

#### Count

Type: boolean Default: false

Return a numeric value representing the number of items that match the specified `query-filters`.

##

#### Get

Type: boolean Default: false

Return the JSON object of the first result matching the specified `query-filters`. The query fails if there specified `query-filters` return no results.

##

#### Offset

Type: integer Default: 0

This specifies the beginning offset of the results array. When combined with the `limit` query-option it may be used to implement pagination of large results arrays. WARNING: some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.

##

#### Limit

Type: integer Default: 0

This specifies the maximum number of results matching the specified `query-filters` to return. When combined wtih the `offset` query-option it may be used to implement pagination of large results arrays.

WARNING: Some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.

##

#### Force Sql Filters

Type: boolean Default: false

Force use of SQL for result filtering to reduce response time. May not work for all methods.

##

#### Result

## Any of

Type: array of object
No Additional Items

##### Each item of this array must be:

#### JBOFQueryResultItem

Type: object
No Additional Properties

##

#### Id

Type: integer

Unique identifier for the JBOF configuration.

##

#### Description

Type: string

Optional description of the JBOF.

##

#### Mgmt Ip1

IP of first Redfish management interface.

## Any of

Type: const
Specific value: `""`
Type: string

##

#### Mgmt Ip2

Optional IP of second Redfish management interface.

## Any of

Type: const
Specific value: `""`
Type: string

##

#### Mgmt Username

Type: string

Redfish administrative username.

##

#### Mgmt Password

Type: string

Redfish administrative password.

##

#### Index

Type: integer

Index of the JBOF. Used to determine data plane IP addresses.

##

#### Uuid

Type: string

UUID of the JBOF as reported by the enclosure firmware.

#### JBOFQueryResultItem

Type: object
No Additional Properties

##

#### Id

Type: integer

Unique identifier for the JBOF configuration.

##

#### Description

Type: string

Optional description of the JBOF.

##

#### Mgmt Ip1

IP of first Redfish management interface.

## Any of

Type: const
Specific value: `""`
Type: string

##

#### Mgmt Ip2

Optional IP of second Redfish management interface.

## Any of

Type: const
Specific value: `""`
Type: string

##

#### Mgmt Username

Type: string

Redfish administrative username.

##

#### Mgmt Password

Type: string

Redfish administrative password.

##

#### Index

Type: integer

Index of the JBOF. Used to determine data plane IP addresses.

##

#### Uuid

Type: string

UUID of the JBOF as reported by the enclosure firmware.

Type: integer

Required roles: JBOF_READ