salt.modules.nilrt_ip module

The networking module for NI Linux Real-Time distro

salt.modules.nilrt_ip.apply_network_settings(**settings)

Apply global network configuration.

CLI Example: .. code-block:: bash

salt '*' ip.apply_network_settings
salt.modules.nilrt_ip.build_interface(iface, iface_type, enable, **settings)

Build an interface script for a network interface.

CLI Example: .. code-block:: bash

salt '*' ip.build_interface eth0 eth <settings>
salt.modules.nilrt_ip.build_network_settings(**settings)

Build the global network script.

CLI Example: .. code-block:: bash

salt '*' ip.build_network_settings <settings>
salt.modules.nilrt_ip.disable(interface)

Disable the specified interface

Parameters:interface (str) -- interface label
Returns:True if the service was disabled, otherwise an exception will be thrown.
Return type:bool

CLI Example:

salt '*' ip.disable interface-label
salt.modules.nilrt_ip.down(interface, iface_type=None)

Disable the specified interface

Parameters:interface (str) -- interface label
Returns:True if the service was disabled, otherwise an exception will be thrown.
Return type:bool

CLI Example:

salt '*' ip.down interface-label
salt.modules.nilrt_ip.enable(interface)

Enable the specified interface

Parameters:interface (str) -- interface label
Returns:True if the service was enabled, otherwise an exception will be thrown.
Return type:bool

CLI Example:

salt '*' ip.enable interface-label
salt.modules.nilrt_ip.get_interface(iface)

Returns details about given interface.

CLI Example:

salt '*' ip.get_interface eth0
salt.modules.nilrt_ip.get_interfaces_details()

Get details about all the interfaces on the minion

Returns:information about all connmans interfaces
Return type:dictionary

CLI Example:

salt '*' ip.get_interfaces_details
salt.modules.nilrt_ip.get_network_settings()

Return the contents of the global network script.

CLI Example: .. code-block:: bash

salt '*' ip.get_network_settings
salt.modules.nilrt_ip.set_dhcp_linklocal_all(interface)

Configure specified adapter to use DHCP with linklocal fallback

Parameters:interface (str) -- interface label
Returns:True if the settings ware applied, otherwise an exception will be thrown.
Return type:bool

CLI Example:

salt '*' ip.dhcp_linklocal_all interface-label
salt.modules.nilrt_ip.set_static_all(interface, address, netmask, gateway, domains)

Configure specified adapter to use ipv4 manual settings

Parameters:
  • interface (str) -- interface label
  • address (str) -- ipv4 address
  • netmask (str) -- ipv4 netmask
  • gateway (str) -- ipv4 gateway
  • domains (str) -- list of domains servers separated by spaces
Returns:

True if the settings were applied, otherwise an exception will be thrown.

Return type:

bool

CLI Example:

salt '*' ip.dhcp_linklocal_all interface-label address netmask gateway domains
salt.modules.nilrt_ip.up(interface, iface_type=None)

Enable the specified interface

Parameters:interface (str) -- interface label
Returns:True if the service was enabled, otherwise an exception will be thrown.
Return type:bool

CLI Example:

salt '*' ip.up interface-label