Interface AddressShowOptions

Address show options.

Hierarchy

  • AddressShowOptions

Properties

-dadfailed? -deprecated? -dynamic? -permanent? -primary? -secondary? -temporary? -tentative? autojoin? dadfailed? deprecated? dev? dynamic? home? label? master? mngtmpaddr? nodad? noprefixroute? optimistic? permanent? primary? scope? secondary? temporary? tentative? to? type? up? vrf?

Properties

Optional -dadfailed

-dadfailed?: true

(IPv6 only) only list addresses which have not failed duplicate address detection.

Optional -deprecated

-deprecated?: true

(IPv6 only) only list addresses not being deprecated.

Optional -dynamic

-dynamic?: true

See

permanent

Optional -permanent

-permanent?: true

See

permanent

Optional -primary

-primary?: true

This is an alias for temporary or secondary.

See

temporary

Optional -secondary

-secondary?: true

Aliases for primary.

See

primary

Optional -temporary

-temporary?: true

See

temporary

Optional -tentative

-tentative?: true

Aliases for primary.

See

primary

Optional autojoin

autojoin?: true

See

AddressAddOptions.autojoin

Optional dadfailed

dadfailed?: true

(IPv6 only) only list addresses which have failed duplicate address detection.

Optional deprecated

deprecated?: true

(IPv6 only) only list deprecated addresses.

Optional dev

dev?: string

The name of the device to filter and show its addresses.

Optional dynamic

dynamic?: true

See

permanent

Optional home

home?: true

See

AddressAddOptions.home

Optional label

label?: string

Only list addresses with labels matching the PATTERN. PATTERN is a usual shell style pattern.

Optional master

master?: string

Only list interfaces enslaved to this master device.

Optional mngtmpaddr

mngtmpaddr?: true

See

AddressAddOptions.mngtmpaddr

Optional nodad

nodad?: true

See

AddressAddOptions.nodad

Optional noprefixroute

noprefixroute?: true

See

AddressAddOptions.noprefixroute

Optional optimistic

optimistic?: true

See

AddressAddOptions.optimistic

Optional permanent

permanent?: true

(IPv6 only) only list addresses installed due to stateless address configuration or only list permanent (not dynamic) addresses.

These two flags are inverses of each other, so -dynamic is equal to permanent and -permanent is equal to dynamic.

Optional primary

primary?: true

List only primary addresses, in IPv6 exclude temporary ones. This flag is the inverse of temporary and secondary.

Optional scope

scope?: number | AddressScopes

Only list addresses with this scope.

Optional secondary

secondary?: true

See

temporary

Optional temporary

temporary?: true

List temporary IPv6 or secondary IPv4 addresses only. The Linux kernel shares a single bit for those, so they are actually aliases for each other although the meaning differs depending on address family.

Optional tentative

tentative?: true

(IPv6 only) only list addresses which have not yet passed duplicate address detection.

Optional to

to?: string

Only show addresses matching this prefix.

Optional type

type?: LinkTypes

Only list interfaces of the given type.

Note that the type name is not checked against the list of supported types - instead it is sent as-is to the kernel. Later it is used to filter the returned interface list by comparing it with the relevant attribute in case the kernel didn't filter already.

Therefore any string is accepted, but may lead to empty output.

Optional up

up?: true

Only list running interfaces.

Optional vrf

vrf?: string

Only list interfaces enslaved to this vrf.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc