The networking module for NI Linux Real-Time distro
Apply global network configuration.
CLI Example:
salt '*' ip.apply_network_settings
Build an interface script for a network interface.
CLI Example:
salt '*' ip.build_interface eth0 eth <settings>
Build the global network script.
CLI Example:
salt '*' ip.build_network_settings <settings>
Disable the specified interface
Change adapter mode to Disabled. If previous adapter mode was EtherCAT, the target will need reboot.
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
Disable the specified interface
Change adapter mode to Disabled. If previous adapter mode was EtherCAT, the target will need reboot.
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
Enable the specified interface
Change adapter mode to TCP/IP. If previous adapter mode was EtherCAT, the target will need reboot.
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
Returns details about given interface.
CLI Example:
salt '*' ip.get_interface eth0
Get details about all the interfaces on the minion
Returns: | information about all interfaces omitting loopback |
---|---|
Return type: | dictionary |
CLI Example:
salt '*' ip.get_interfaces_details
Return the contents of the global network script.
CLI Example:
salt '*' ip.get_network_settings
Configure specified adapter to use DHCP with linklocal fallback
Change adapter mode to TCP/IP. If previous adapter mode was EtherCAT, the target will need reboot.
Parameters: | interface (str) -- interface label |
---|---|
Returns: | True if the settings were applied, otherwise an exception will be thrown. |
Return type: | bool |
CLI Example:
salt '*' ip.set_dhcp_linklocal_all interface-label
Configure specified adapter to use DHCP only
Change adapter mode to TCP/IP. If previous adapter mode was EtherCAT, the target will need reboot.
Parameters: | interface (str) -- interface label |
---|---|
Returns: | True if the settings were applied, otherwise an exception will be thrown. |
Return type: | bool |
CLI Example:
salt '*' ip.dhcp_only_all interface-label
Configure specified adapter to use EtherCAT adapter mode. If successful, the target will need reboot if it doesn't already use EtherCAT adapter mode, otherwise will return true.
Parameters: |
|
---|---|
Returns: |
True if the settings were applied, otherwise an exception will be thrown. |
CLI Example:
salt '*' ip.set_ethercat interface-label master-id
Configure specified adapter to use linklocal only
Change adapter mode to TCP/IP. If previous adapter mode was EtherCAT, the target will need reboot.
Parameters: | interface (str) -- interface label |
---|---|
Returns: | True if the settings were applied, otherwise an exception will be thrown. |
Return type: | bool |
CLI Example:
salt '*' ip.linklocal_only_all interface-label
Configure specified adapter to use ipv4 manual settings
Change adapter mode to TCP/IP. If previous adapter mode was EtherCAT, the target will need reboot.
Parameters: | |
---|---|
Returns: |
True if the settings were applied, otherwise an exception will be thrown. |
Return type: |
CLI Example:
salt '*' ip.set_static_all interface-label address netmask gateway nameservers
Enable the specified interface
Change adapter mode to TCP/IP. If previous adapter mode was EtherCAT, the target will need reboot.
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
© 2019 SaltStack.
Licensed under the Apache License, Version 2.0.
https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.nilrt_ip.html