# salt.modules.win_network

Module for gathering and managing network information

salt.modules.win_network.connect(host, port=None, **kwargs)

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

  Added in version 2016.3.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.win_network.dig(host)

  Performs a DNS lookup with dig

  Note: dig must be installed on the Windows minion

  CLI Example:

      salt '*' network.dig archlinux.org

salt.modules.win_network.get_route(ip)

  Return routing information for given destination ip

  Added in version 2016.11.5.

  CLI Example:

      salt '*' network.get_route 10.10.10.10

salt.modules.win_network.hw_addr(iface)

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

  CLI Example:

      salt '*' network.hw_addr 'Wireless Connection #1'

salt.modules.win_network.hwaddr(iface)

  This function is an alias of `hw_addr`.

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

  > CLI Example:

  >     salt '*' network.hw_addr 'Wireless Connection #1'

salt.modules.win_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.win_network.interfaces()

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

  CLI Example:

      salt '*' network.interfaces

salt.modules.win_network.interfaces_names()

  Return a list of all the interfaces names

  CLI Example:

      salt '*' network.interfaces_names

salt.modules.win_network.ip_addrs(interface=None, include_loopback=False, cidr=None, type=None)

  Returns a list of IPv4 addresses assigned to the host.

  interface

    Only IP addresses from that interface will be returned.

  include_loopbackFalse

    Include loopback 127.0.0.1 IPv4 address.

  cidr

    > Describes subnet using CIDR notation and only IPv4 addresses that belong to this subnet will be returned.

    Changed in version 2019.2.0.

  type

    If option set to 'public' then only public addresses will be returned. Ditto for 'private'.

    Changed in version 2019.2.0.

  CLI Example:

      salt '*' network.ip_addrs
      salt '*' network.ip_addrs cidr=10.0.0.0/8
      salt '*' network.ip_addrs cidr=192.168.0.0/16 type=private

salt.modules.win_network.ip_addrs6(interface=None, include_loopback=False, cidr=None)

  Returns a list of IPv6 addresses assigned to the host.

  interface

    Only IP addresses from that interface will be returned.

  include_loopbackFalse

    Include loopback ::1 IPv6 address.

  cidr

    Describes subnet using CIDR notation and only IPv6 addresses that belong to this subnet will be returned.

    Changed in version 2019.2.0.

  CLI Example:

      salt '*' network.ip_addrs6
      salt '*' network.ip_addrs6 cidr=2000::/3

salt.modules.win_network.ipaddrs(interface=None, include_loopback=False, cidr=None, type=None)

  This function is an alias of `ip_addrs`.

  > Returns a list of IPv4 addresses assigned to the host.

  > interface

  >   Only IP addresses from that interface will be returned.

  > include_loopbackFalse

  >   Include loopback 127.0.0.1 IPv4 address.

  > cidr

  >   > Describes subnet using CIDR notation and only IPv4 addresses that belong to this subnet will be returned.

  >   Changed in version 2019.2.0.

  > type

  >   If option set to 'public' then only public addresses will be returned. Ditto for 'private'.

  >   Changed in version 2019.2.0.

  > CLI Example:

  >     salt '*' network.ip_addrs
  >     salt '*' network.ip_addrs cidr=10.0.0.0/8
  >     salt '*' network.ip_addrs cidr=192.168.0.0/16 type=private

salt.modules.win_network.ipaddrs6(interface=None, include_loopback=False, cidr=None)

  This function is an alias of `ip_addrs6`.

  > Returns a list of IPv6 addresses assigned to the host.

  > interface

  >   Only IP addresses from that interface will be returned.

  > include_loopbackFalse

  >   Include loopback ::1 IPv6 address.

  > cidr

  >   Describes subnet using CIDR notation and only IPv6 addresses that belong to this subnet will be returned.

  >   Changed in version 2019.2.0.

  > CLI Example:

  >     salt '*' network.ip_addrs6
  >     salt '*' network.ip_addrs6 cidr=2000::/3

salt.modules.win_network.is_private(ip_addr)

  Check if the given IP address is a private address

  Added in version 2019.2.0.

  CLI Example:

      salt '*' network.is_private 10.0.0.3

salt.modules.win_network.netstat()

  Return information on open ports and states

  CLI Example:

      salt '*' network.netstat

salt.modules.win_network.nslookup(host)

  Query DNS for information about a domain or ip address

  CLI Example:

      salt '*' network.nslookup archlinux.org

salt.modules.win_network.ping(host, timeout=False, return_boolean=False)

  Performs a ping to a host

  CLI Example:

      salt '*' network.ping archlinux.org

  Added in version 2016.11.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.win_network.subnets()

  Returns a list of subnets to which the host belongs

  CLI Example:

      salt '*' network.subnets

salt.modules.win_network.traceroute(host)

  Performs a traceroute to a 3rd party host

  CLI Example:

      salt '*' network.traceroute archlinux.org