# ipmi.lan.query

Query available IPMI Channels with query-filters and query-options.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: data

#### data

Type: object

Query parameters for IPMI LAN configuration.

No Additional Properties

##

#### Query-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"
                    ]
                ]
            ]
        ]
    ]

##

#### QueryOptions

Type: object

Query options for sorting and pagination.

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.

##

#### IPMILanQueryOptions

Type: object

IPMI-specific query options.

No Additional Properties

##

#### Query-Remote

Type: boolean Default: false

Whether to query remote IPMI LAN configuration on HA systems.

##

#### Result

## Any of

Type: array of object
No Additional Items

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

#### IPMILanQueryResultItem

Type: object
No Additional Properties

##

#### Channel

Type: integer

IPMI LAN channel number.

##

#### Id

Type: integer

Unique identifier for the IPMI LAN configuration.

##

#### Ip Address Source

Type: string

Source type for IP address assignment (e.g., "DHCP", "Static").

##

#### Ip Address

Type: string

Current IP address assigned to the IPMI interface.

##

#### Mac Address

Type: string

MAC address of the IPMI network interface.

##

#### Subnet Mask

Type: string

Subnet mask for the IPMI network interface.

##

#### Default Gateway Ip Address

Type: string

IP address of the default gateway.

##

#### Default Gateway Mac Address

Type: string

MAC address of the default gateway.

##

#### Backup Gateway Ip Address

Type: string

IP address of the backup gateway.

##

#### Backup Gateway Mac Address

Type: string

MAC address of the backup gateway.

##

#### Vlan Id

VLAN ID number or `null` if VLAN is not configured.

## Any of

Type: integer
Type: null

##

#### Vlan Id Enable

Type: boolean

Whether VLAN tagging is enabled for this interface.

##

#### Vlan Priority

Type: integer

VLAN priority level for tagged packets.

#### IPMILanQueryResultItem

Type: object
No Additional Properties

##

#### Channel

Type: integer

IPMI LAN channel number.

##

#### Id

Type: integer

Unique identifier for the IPMI LAN configuration.

##

#### Ip Address Source

Type: string

Source type for IP address assignment (e.g., "DHCP", "Static").

##

#### Ip Address

Type: string

Current IP address assigned to the IPMI interface.

##

#### Mac Address

Type: string

MAC address of the IPMI network interface.

##

#### Subnet Mask

Type: string

Subnet mask for the IPMI network interface.

##

#### Default Gateway Ip Address

Type: string

IP address of the default gateway.

##

#### Default Gateway Mac Address

Type: string

MAC address of the default gateway.

##

#### Backup Gateway Ip Address

Type: string

IP address of the backup gateway.

##

#### Backup Gateway Mac Address

Type: string

MAC address of the backup gateway.

##

#### Vlan Id

VLAN ID number or `null` if VLAN is not configured.

## Any of

Type: integer
Type: null

##

#### Vlan Id Enable

Type: boolean

Whether VLAN tagging is enabled for this interface.

##

#### Vlan Priority

Type: integer

VLAN priority level for tagged packets.

Type: integer

Required roles: IPMI_READ