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.connect(host, port=None, **kwargs) Test connectivity to a host using a particular port from the minion.
New in version 2014.7.0.
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.default_route(family=None) Return default route(s) from routing table
CLI Example:
salt '*' network.default_route
-
salt.modules.network.dig(host) Performs a DNS lookup with dig
CLI Example:
salt '*' network.dig archlinux.org
-
salt.modules.network.get_bufsize(iface) Return network buffer sizes as a dict
CLI Example:
salt '*' network.get_bufsize eth0
-
salt.modules.network.get_route(ip) Return routing information for given destination ip
New in version 2015.5.3.
CLI Example:
salt '*' network.get_route 10.10.10.10
-
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.0.
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.0.
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.ip_in_subnet(ip_addr, cidr) Returns True if given IP is within specified subnet, otherwise False.
CLI Example:
salt '*' network.ip_in_subnet 172.17.0.4 172.16.0.0/12
-
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_bufsize(iface, *args, **kwargs) Modify network interface buffers (currently linux only)
CLI Example:
salt '*' network.getBuffers
-
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, timeout=False, return_boolean=False) Performs an ICMP ping to a host
CLI Example:
salt '*' network.ping archlinux.orgNew in version 2015.5.0.
Return a True or False instead of ping output.
salt '*' network.ping archlinux.org return_boolean=True
Set the time to wait for a response in seconds.
salt '*' network.ping archlinux.org timeout=3
-
salt.modules.network.reverse_ip(ip_addr) Returns the reversed IP address
CLI Example:
salt '*' network.reverse_ip 172.17.0.4
-
salt.modules.network.routes(family=None) Return currently configured routes from routing table
CLI Example:
salt '*' network.routes
-
salt.modules.network.subnets() Returns a list of subnets to which the host belongs
CLI Example:
salt '*' network.subnets
