interface.ip_in_use

Get all IPv4 / Ipv6 from all valid interfaces, excluding tap and epair.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: options

options

Type: object
No Additional Properties

ipv4

Ipv4

Type: boolean Default: true

ipv6

Ipv6

Type: boolean Default: true

ipv6_link_local

Ipv6 Link Local

Type: boolean Default: false

loopback

Loopback

Type: boolean Default: false

Return loopback interface addresses.

any

Any

Type: boolean Default: false

Return wildcard addresses (0.0.0.0 and ::).

static

Static

Type: boolean Default: false

Only return configured static IPs.

Return value

Result

Type: array of object
No Additional Items

Each item of this array must be:

InterfaceIPInUseItem

Type: object
No Additional Properties

type Required

Type

Type: string

address Required

Address

Any of

• Option 1
• Option 2

Type: const

Must be one of:

• ""

Specific value: ""

Type: string

netmask Required

Netmask

Type: integer

broadcast

Broadcast

Type: string

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