22.16.123. salt.modules.network

Module for gathering and managing network information

salt.modules.network.active_tcp()

Return a dict containing information on all of the running TCP connections

CLI Example:

salt '*' network.active_tcp
salt.modules.network.arp()

Return the arp table from the minion

CLI Example:

salt '*' network.arp
salt.modules.network.connect(host, port=None, **kwargs)

Test connectivity to a host using a particular port from the minion.

New in version 2014.7.

CLI Example:

salt '*' network.connect archlinux.org 80

salt '*' network.connect archlinux.org 80 timeout=3

salt '*' network.connect archlinux.org 80 timeout=3 family=ipv4

salt '*' network.connect google-public-dns-a.google.com port=53 proto=udp timeout=3
salt.modules.network.dig(host)

Performs a DNS lookup with dig

CLI Example:

salt '*' network.dig archlinux.org
salt.modules.network.get_hostname()

Get hostname

CLI Example:

salt '*' network.get_hostname
salt.modules.network.hw_addr(iface)

Return the hardware address (a.k.a. MAC address) for a given interface

CLI Example:

salt '*' network.hw_addr eth0
salt.modules.network.hwaddr(iface)

Return the hardware address (a.k.a. MAC address) for a given interface

CLI Example:

salt '*' network.hw_addr eth0
salt.modules.network.in_subnet(cidr)

Returns True if host is within specified subnet, otherwise False.

CLI Example:

salt '*' network.in_subnet 10.0.0.0/16
salt.modules.network.interface(iface)

Return the inet address for a given interface

New in version 2014.7.

CLI Example:

salt '*' network.interface eth0
salt.modules.network.interface_ip(iface)

Return the inet address for a given interface

New in version 2014.7.

CLI Example:

salt '*' network.interface_ip eth0
salt.modules.network.interfaces()

Return a dictionary of information about all the interfaces on the minion

CLI Example:

salt '*' network.interfaces
salt.modules.network.ip_addrs(interface=None, include_loopback=False, cidr=None)

Returns a list of IPv4 addresses assigned to the host. 127.0.0.1 is ignored, unless 'include_loopback=True' is indicated. If 'interface' is provided, then only IP addresses from that interface will be returned. Providing a CIDR via 'cidr="10.0.0.0/8"' will return only the addresses which are within that subnet.

CLI Example:

salt '*' network.ip_addrs
salt.modules.network.ip_addrs6(interface=None, include_loopback=False)

Returns a list of IPv6 addresses assigned to the host. ::1 is ignored, unless 'include_loopback=True' is indicated. If 'interface' is provided, then only IP addresses from that interface will be returned.

CLI Example:

salt '*' network.ip_addrs6
salt.modules.network.ipaddrs(interface=None, include_loopback=False, cidr=None)

Returns a list of IPv4 addresses assigned to the host. 127.0.0.1 is ignored, unless 'include_loopback=True' is indicated. If 'interface' is provided, then only IP addresses from that interface will be returned. Providing a CIDR via 'cidr="10.0.0.0/8"' will return only the addresses which are within that subnet.

CLI Example:

salt '*' network.ip_addrs
salt.modules.network.ipaddrs6(interface=None, include_loopback=False)

Returns a list of IPv6 addresses assigned to the host. ::1 is ignored, unless 'include_loopback=True' is indicated. If 'interface' is provided, then only IP addresses from that interface will be returned.

CLI Example:

salt '*' network.ip_addrs6
salt.modules.network.is_loopback(ip_addr)

Check if the given IP address is a loopback address

New in version 2014.7.0.

CLI Example:

salt '*' network.is_loopback 127.0.0.1
salt.modules.network.is_private(ip_addr)

Check if the given IP address is a private address

New in version 2014.7.0.

CLI Example:

salt '*' network.is_private 10.0.0.3
salt.modules.network.mod_hostname(hostname)

Modify hostname

CLI Example:

salt '*' network.mod_hostname   master.saltstack.com
salt.modules.network.netstat()

Return information on open ports and states

Note

On BSD minions, the output contains PID info (where available) for each netstat entry, fetched from sockstat/fstat output.

Changed in version 2014.1.4: Added support for OpenBSD, FreeBSD, and NetBSD

CLI Example:

salt '*' network.netstat
salt.modules.network.ping(host)

Performs a ping to a host

CLI Example:

salt '*' network.ping archlinux.org
salt.modules.network.subnets()

Returns a list of subnets to which the host belongs

CLI Example:

salt '*' network.subnets
salt.modules.network.traceroute(host)

Performs a traceroute to a 3rd party host

CLI Example:

salt '*' network.traceroute archlinux.org

Docs for previous releases are available on salt.rtfd.org.

Latest Salt release: 2014.1.13

Try the shiny new release candidate of Salt, v2014.7.0rc6! More info here.

Previous topic

22.16.122. salt.modules.netbsdservice

Next topic

22.16.124. salt.modules.nfs3

SaltStack News

Upcoming SaltStack events, webinars and local meet ups and user groups.