interface.ip_in_use =================== Get all IPv4 / Ipv6 from all valid interfaces, excluding tap and epair. .. raw:: html
Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: options

options

Type: object

Options for filtering IP addresses in use.

 No Additional Properties

Ipv4

Type: boolean Default: true

Include IPv4 addresses in the results.

Ipv6

Type: boolean Default: true

Include IPv6 addresses in the results.

Loopback

Type: boolean Default: false

Return loopback interface addresses.

Any

Type: boolean Default: false

Return wildcard addresses (0.0.0.0 and ::).

Static

Type: boolean Default: false

Only return configured static IPs.

Interfaces

Type: array of string

Only return IPs from specified interfaces. If empty, returns IPs from all interfaces.

 No Additional Items
Each item of this array must be:
Type: string

Must be at least 1 characters long

Result

Type: array of object
No Additional Items
Each item of this array must be:

InterfaceIPInUseItem

Type: object
No Additional Properties

Type

Type: string

The type of IP address (INET for IPv4, INET6 for IPv6).

Address


The IP address that is in use.

Type: const
Specific value: ""
Type: string

Netmask

Type: integer

The network mask in CIDR notation.

Broadcast

Type: string

The broadcast address for IPv4 networks.

Example:

[
        {
            "address": "fe80::5054:ff:fe16:4aac",
            "netmask": 64,
            "type": "INET6"
        },
        {
            "address": "192.168.122.148",
            "broadcast": "192.168.122.255",
            "netmask": 24,
            "type": "INET"
        }
    ]


*Required roles:* NETWORK_INTERFACE_READ