org.opensuse.Network.Interface
Namespace
Properties
- name (string). The kernel name of the interface
- status (builtin-ifflags). The interface status flags. NOTE: These are not the kernel flags
- link-type (builtin-iftype). The link-layer type of this interface
- client-state (dict). This is a dict-based type that provides the following members:
- control (dict). This is a dict-based type that provides the following members:
- persistent (boolean). This is a boolean
- usercontrol (boolean). This is a boolean
- config (dict). This is a dict-based type that provides the following members:
- origin (string). This is a string
- uuid (array). This is an array of byte[16] (notation uuid).
- owner-uid (uint32). This is a uint32
- index (uint32). The interface index. The index is also used in the DBus name of the DBus netif object
- metric (uint32).
- txqlen (uint32).
- mtu (uint32).
- alias (string).
- master (string).
- ipv4 (network-interface:af-info).
- ipv6 (network-interface:af-info).
- addresses (network-interface:assigned-address-list). The list of network addresses currently assigned to the interface
- routes (network-interface:assigned-route-list). The list of network routes currently assigned to the interface
Methods
- callback-info waitDeviceReady()
-
This method allows to wait until an existing device is ready to set up,
e.g. renamed by udev.
If the device is ready, we will return an empty callback-info dict.
Otherwise, a callback-info dict with uuid to wait for is returned
and a deviceReady signal is emitted when the device becomes ready.
- callback-info linkUp(dict request)
-
This method initiaties link negotiation. This may include link-specific activities;
for instance, when bringing up a wireless device, this will start wireless
authentication.
When the link negotiation is complete by the time this method is done,
we will return an empty callback-info dict. If the link negotiation is still
in process, a callback-info dict is returned.
Argument request is mapped to element <link> of the device document.
It is a dict-based type that provides the following members:
- callback-info linkDown()
-
This method takes the link down by clearing its IFF_UP flag.
- void linkAuth()
-
Do not use
- builtin-ifflags networkChange()
-
Do not use
- void installLease(intrinsic-lease-request arg)
-
- void setClientControl(network-interface:client-state-control-type arg)
-
This method can be used by client to set:
* control flags of an interface:
- persistent - allowing/disallowing ifdown operation
- usercontrol - user control permission
- void setClientConfig(network-interface:client-state-config-type arg)
-
This method can be used by clients to record the state of device's
configuration. Both UUID and configuration origin are transfered.
- void linkMonitor()
-
This method sets up the device for monitoring, so that link status
changes (for Ethernet interfaces) or changes in the wireless
neighborhood (for Wireless interfaces) can be reported via
signals.
This method is primarily used by network-nanny.
Signals
- void deviceCreate()
-
This signal is emitted whenever a new device is created or discovered.
- void deviceDelete()
-
This signal is emitted whenever a device is destroyed or otherwise disappeared from the system
(for instance, by hot removal).
- void deviceReady()
-
This signal is emitted whenever a new device is ready to use / configure,
e.g. udev finished its rename work and the name is final.
- void deviceChange()
-
This generic signal is emitted whenever the kernel emits newlink event
without any changes of the IFF_UP state flags of the device.
- void deviceUp()
-
This signal is emitted whenever a device's IFF_UP flag is set.
- void deviceDown()
-
This signal is emitted whenever a device's IFF_UP flag is cleared.
- void linkUp()
-
This signal is emitted whenever a device completes link negotiation (ie when its IFF_UP and
IFF_LOWER_UP flag is set)
- void linkDown()
-
This signal is emitted whenever a device loses its link (ie when its IFF_UP and/or
IFF_LOWER_UP flag is cleared).
- void linkAssociated()
-
Emitted whenever a device (re-)associates with a different access point.
Used by wireless devices.
- void linkAssociationLost()
-
Emitted whenever a device loses its association with an access point.
- void linkScanUpdated()
-
Emitted by wireless devices when a scan completed and the set of visible APs or
networks changed.
- void networkUp()
-
This signal shadows linkUp, and may be removed in the future.
- void networkDown()
-
This signal shadows linkDown, and may be removed in the future.
- void addressAcquired()
-
Emitted whenever an address was acquired through an addrconf service.
Addrconf services like dhcp4 or dhcp6 are unable to grant a requested lease immediately.
In response to a requestLease() call, they will return callback information containing
a uuid, and the event name addressAcquired. Once the address negotiation with the DHCP
server succeeds, wickedd will emit an addressAcquired event with the uuid specified in
the callback info.
If the DHCP supplicant is unable to obtain the requested lease, an addressDeferred is
generated to trigger fallback actions and on final timeout addressLost instead.
- void addressReleased()
-
Emitted whenever an address previously acquired through an addrconf service is released.
Addrconf services like dhcp4 or dhcp6 should release their leases gracefully when the
interface is taken down.
In response to a dropLease() call, they will return callback information containing
a uuid, and the event name addressReleased. Once the we have successfully informed
the DHCP server and released the lease, wickedd will emit an addressReleased event with
the uuid specified in the callback info.
This signal is also emitted spontaneously when an addrconf service released a lease.
For instance, if an interface is taken down manually using "ifconfig down", the DHCP
supplicant will discard the lease it held for this interface, and subsequently,
an addressReleased() event is emitted.
- void addressDeferred()
-
Emitted whenever an addrconf service were unable to acquire lease inside the specified
defer timeout to trigger fallback actions and addressLost on final acquire timeout.
- void addressLost()
-
Emitted whenever an addrconf service failed to renew a previously acquired lease.
Types defined in this scope
Type name |
Kind |
Definition |
callback-info | dict | below |
link-request | dict | below |
addrconf-lease | dict | below |
intrinsic-lease | dict | below |
intrinsic-lease-request | dict | below |
Type callback-info
Methods for network or modem devices that are unable to complete the requestimmediately (for instance, a DHCP supplicant needs to broadcast for a lease, etc),the server will return callback information. This is a list of one or morecallbacks to wait for.
This is a dict-based type that provides the following members:
- callback (dict). This is a dict-based type that provides the following members:
Type link-request
This describes the requested change(s) to the link layer. It is passed to thelinkUp() method.
For keys that are omitted, the existing setting of the network interfaceremains unchanged.
This is a dict-based type that provides the following members:
Type addrconf-lease
This is a dict-based type that provides the following members:
- lease (dict). This is a dict-based type that provides the following members:
Type intrinsic-lease
This is a dict-based type that provides the following members:
Type intrinsic-lease-request
This is a dict-based type that provides the following members: