#!/usr/bin/python # -*- coding: utf-8 -*- # Copyright: (c) 2015, Chris Long # Copyright: (c) 2017, Ansible Project # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = r''' --- module: nmcli author: - Chris Long (@alcamie101) short_description: Manage Networking requirements: - nmcli description: - 'Manage the network devices. Create, modify and manage various connection and device type e.g., ethernet, teams, bonds, vlans etc.' - 'On CentOS 8 and Fedora >=29 like systems, the requirements can be met by installing the following packages: NetworkManager.' - 'On CentOS 7 and Fedora <=28 like systems, the requirements can be met by installing the following packages: NetworkManager-tui.' - 'On Ubuntu and Debian like systems, the requirements can be met by installing the following packages: network-manager' - 'On openSUSE, the requirements can be met by installing the following packages: NetworkManager.' options: state: description: - Whether the device should exist or not, taking action if the state is different from what is stated. type: str required: true choices: [ absent, present ] autoconnect: description: - Whether the connection should start on boot. - Whether the connection profile can be automatically activated type: bool default: yes conn_name: description: - The name used to call the connection. Pattern is [-][-]. type: str required: true ifname: description: - The interface to bind the connection to. - The connection will only be applicable to this interface name. - A special value of C('*') can be used for interface-independent connections. - The ifname argument is mandatory for all connection types except bond, team, bridge and vlan. - This parameter defaults to C(conn_name) when left unset. type: str type: description: - This is the type of device or network connection that you wish to create or modify. - Type C(dummy) is added in community.general 3.5.0. - Type C(generic) is added in Ansible 2.5. - Type C(infiniband) is added in community.general 2.0.0. - Type C(gsm) is added in community.general 3.7.0. - Type C(wireguard) is added in community.general 4.3.0 type: str choices: [ bond, bond-slave, bridge, bridge-slave, dummy, ethernet, generic, gre, infiniband, ipip, sit, team, team-slave, vlan, vxlan, wifi, gsm, wireguard ] mode: description: - This is the type of device or network connection that you wish to create for a bond or bridge. type: str choices: [ 802.3ad, active-backup, balance-alb, balance-rr, balance-tlb, balance-xor, broadcast ] default: balance-rr master: description: - Master ] STP forwarding delay, in seconds. type: int default: 15 hellotime: description: - This is only used with bridge - [hello-time <1-10>] STP hello time, in seconds. type: int default: 2 maxage: description: - This is only used with bridge - [max-age <6-42>] STP maximum message age, in seconds. type: int default: 20 ageingtime: description: - This is only used with bridge - [ageing-time <0-1000000>] the Ethernet MAC address aging time, in seconds. type: int default: 300 mac: description: - MAC address of the connection. - Note this requires a recent kernel feature, originally introduced in 3.15 upstream kernel. type: str slavepriority: description: - This is only used with 'bridge-slave' - [<0-63>] - STP priority of this slave. type: int default: 32 path_cost: description: - This is only used with 'bridge-slave' - [<1-65535>] - STP port cost for destinations via this slave. type: int default: 100 hairpin: description: - This is only used with 'bridge-slave' - 'hairpin mode' for the slave, which allows frames to be sent back out through the slave the frame was received on. type: bool default: yes runner: description: - This is the type of device or network connection that you wish to create for a team. type: str choices: [ broadcast, roundrobin, activebackup, loadbalance, lacp ] default: roundrobin version_added: 3.4.0 runner_hwaddr_policy: description: - This defines the policy of how hardware addresses of team device and port devices should be set during the team lifetime. type: str choices: [ same_all, by_active, only_active ] version_added: 3.4.0 vlanid: description: - This is only used with VLAN - VLAN ID in range <0-4095>. type: int vlandev: description: - This is only used with VLAN - parent device this VLAN is on, can use ifname. type: str flags: description: - This is only used with VLAN - flags. type: str ingress: description: - This is only used with VLAN - VLAN ingress priority mapping. type: str egress: description: - This is only used with VLAN - VLAN egress priority mapping. type: str vxlan_id: description: - This is only used with VXLAN - VXLAN ID. type: int vxlan_remote: description: - This is only used with VXLAN - VXLAN destination IP address. type: str vxlan_local: description: - This is only used with VXLAN - VXLAN local IP address. type: str ip_tunnel_dev: description: - This is used with GRE/IPIP/SIT - parent device this GRE/IPIP/SIT tunnel, can use ifname. type: str ip_tunnel_remote: description: - This is used with GRE/IPIP/SIT - GRE/IPIP/SIT destination IP address. type: str ip_tunnel_local: description: - This is used with GRE/IPIP/SIT - GRE/IPIP/SIT local IP address. type: str ip_tunnel_input_key: description: - The key used for tunnel input packets. - Only used when I(type=gre). type: str version_added: 3.6.0 ip_tunnel_output_key: description: - The key used for tunnel output packets. - Only used when I(type=gre). type: str version_added: 3.6.0 zone: description: - The trust level of the connection. - When updating this property on a currently activated connection, the change takes effect immediately. type: str version_added: 2.0.0 wifi_sec: description: - The security configuration of the WiFi connection. - Note the list of suboption attributes may vary depending on which version of NetworkManager/nmcli is installed on the host. - 'An up-to-date list of supported attributes can be found here: U(https://networkmanager.dev/docs/api/latest/settings-802-11-wireless-security.html).' - 'For instance to use common WPA-PSK auth with a password: C({key-mgmt: wpa-psk, psk: my_password}).' type: dict suboptions: auth-alg: description: - When WEP is used (that is, if I(key-mgmt) = C(none) or C(ieee8021x)) indicate the 802.11 authentication algorithm required by the AP here. - One of C(open) for Open System, C(shared) for Shared Key, or C(leap) for Cisco LEAP. - When using Cisco LEAP (that is, if I(key-mgmt=ieee8021x) and I(auth-alg=leap)) the I(leap-username) and I(leap-password) properties must be specified. type: str choices: [ open, shared, leap ] fils: description: - Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection. - One of C(0) (use global default value), C(1) (disable FILS), C(2) (enable FILS if the supplicant and the access point support it) or C(3) (enable FILS and fail if not supported). - When set to C(0) and no global default is set, FILS will be optionally enabled. type: int choices: [ 0, 1, 2, 3 ] default: 0 group: description: - A list of group/broadcast encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. - For maximum compatibility leave this property empty. type: list elements: str choices: [ wep40, wep104, tkip, ccmp ] key-mgmt: description: - Key management used for the connection. - One of C(none) (WEP or no password protection), C(ieee8021x) (Dynamic WEP), C(owe) (Opportunistic Wireless Encryption), C(wpa-psk) (WPA2 + WPA3 personal), C(sae) (WPA3 personal only), C(wpa-eap) (WPA2 + WPA3 enterprise) or C(wpa-eap-suite-b-192) (WPA3 enterprise only). - This property must be set for any Wi-Fi connection that uses security. type: str choices: [ none, ieee8021x, owe, wpa-psk, sae, wpa-eap, wpa-eap-suite-b-192 ] leap-password-flags: description: Flags indicating how to handle the I(leap-password) property. type: list elements: int leap-password: description: The login password for legacy LEAP connections (that is, if I(key-mgmt=ieee8021x) and I(auth-alg=leap)). type: str leap-username: description: The login username for legacy LEAP connections (that is, if I(key-mgmt=ieee8021x) and I(auth-alg=leap)). type: str pairwise: description: - A list of pairwise encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. - For maximum compatibility leave this property empty. type: list elements: str choices: [ tkip, ccmp ] pmf: description: - Indicates whether Protected Management Frames (802.11w) must be enabled for the connection. - One of C(0) (use global default value), C(1) (disable PMF), C(2) (enable PMF if the supplicant and the access point support it) or C(3) (enable PMF and fail if not supported). - When set to C(0) and no global default is set, PMF will be optionally enabled. type: int choices: [ 0, 1, 2, 3 ] default: 0 proto: description: - List of strings specifying the allowed WPA protocol versions to use. - Each element may be C(wpa) (allow WPA) or C(rsn) (allow WPA2/RSN). - If not specified, both WPA and RSN connections are allowed. type: list elements: str choices: [ wpa, rsn ] psk-flags: description: Flags indicating how to handle the I(psk) property. type: list elements: int psk: description: - Pre-Shared-Key for WPA networks. - For WPA-PSK, it is either an ASCII passphrase of 8 to 63 characters that is (as specified in the 802.11i standard) hashed to derive the actual key, or the key in form of 64 hexadecimal character. - The WPA3-Personal networks use a passphrase of any length for SAE authentication. type: str wep-key-flags: description: Flags indicating how to handle the I(wep-key0), I(wep-key1), I(wep-key2), and I(wep-key3) properties. type: list elements: int wep-key-type: description: - Controls the interpretation of WEP keys. - Allowed values are C(1), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII password; or C(2), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the actual WEP key. type: int choices: [ 1, 2 ] wep-key0: description: - Index 0 WEP key. This is the WEP key used in most networks. - See the I(wep-key-type) property for a description of how this key is interpreted. type: str wep-key1: description: - Index 1 WEP key. This WEP index is not used by most networks. - See the I(wep-key-type) property for a description of how this key is interpreted. type: str wep-key2: description: - Index 2 WEP key. This WEP index is not used by most networks. - See the I(wep-key-type) property for a description of how this key is interpreted. type: str wep-key3: description: - Index 3 WEP key. This WEP index is not used by most networks. - See the I(wep-key-type) property for a description of how this key is interpreted. type: str wep-tx-keyidx: description: - When static WEP is used (that is, if I(key-mgmt=none)) and a non-default WEP key index is used by the AP, put that WEP key index here. - Valid values are C(0) (default key) through C(3). - Note that some consumer access points (like the Linksys WRT54G) number the keys C(1) - C(4). type: int choices: [ 0, 1, 2, 3 ] default: 0 wps-method: description: - Flags indicating which mode of WPS is to be used if any. - There is little point in changing the default setting as NetworkManager will automatically determine whether it is feasible to start WPS enrollment from the Access Point capabilities. - WPS can be disabled by setting this property to a value of C(1). type: int default: 0 version_added: 3.0.0 ssid: description: - Name of the Wireless router or the access point. type: str version_added: 3.0.0 wifi: description: - The configuration of the WiFi connection. - Note the list of suboption attributes may vary depending on which version of NetworkManager/nmcli is installed on the host. - 'An up-to-date list of supported attributes can be found here: U(https://networkmanager.dev/docs/api/latest/settings-802-11-wireless.html).' - 'For instance to create a hidden AP mode WiFi connection: C({hidden: true, mode: ap}).' type: dict suboptions: ap-isolation: description: - Configures AP isolation, which prevents communication between wireless devices connected to this AP. - This property can be set to a value different from C(-1) only when the interface is configured in AP mode. - If set to C(1), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc. - If set to C(0), devices can talk to each other. - When set to C(-1), the global default is used; in case the global default is unspecified it is assumed to be C(0). type: int choices: [ -1, 0, 1 ] default: -1 assigned-mac-address: description: - The new field for the cloned MAC address. - It can be either a hardware address in ASCII representation, or one of the special values C(preserve), C(permanent), C(random) or C(stable). - This field replaces the deprecated I(cloned-mac-address) on D-Bus, which can only contain explicit hardware addresses. - Note that this property only exists in D-Bus API. libnm and nmcli continue to call this property I(cloned-mac-address). type: str band: description: - 802.11 frequency band of the network. - One of C(a) for 5GHz 802.11a or C(bg) for 2.4GHz 802.11. - This will lock associations to the Wi-Fi network to the specific band, so for example, if C(a) is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. - This setting depends on specific driver capability and may not work with all drivers. type: str choices: [ a, bg ] bssid: description: - If specified, directs the device to only associate with the given access point. - This capability is highly driver dependent and not supported by all devices. - Note this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future. type: str channel: description: - Wireless channel to use for the Wi-Fi connection. - The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. - Because channel numbers overlap between bands, this property also requires the I(band) property to be set. type: int default: 0 cloned-mac-address: description: - This D-Bus field is deprecated in favor of I(assigned-mac-address) which is more flexible and allows specifying special variants like C(random). - For libnm and nmcli, this field is called I(cloned-mac-address). type: str generate-mac-address-mask: description: - With I(cloned-mac-address) setting C(random) or C(stable), by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. - Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. - If the property is C(null), it is eligible to be overwritten by a default connection setting. - If the value is still c(null) or an empty string, the default is to create a locally-administered, unicast MAC address. - If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. - Setting C(FE:FF:FF:00:00:00) means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the C(random) or C(stable) algorithm. - If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. - For example, a value of C(FE:FF:FF:00:00:00 68:F7:28:00:00:00) will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. - A value of C(02:00:00:00:00:00 00:00:00:00:00:00) will create a fully scrambled globally-administered, burned-in MAC address. - If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, C(02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00) will create a fully scrambled MAC address, randomly locally or globally administered. type: str hidden: description: - If C(true), indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode. - In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution. - In AP mode, the created network does not broadcast its SSID. - Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air. type: bool default: false mac-address-blacklist: description: - A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. - Each MAC address should be given in the standard hex-digits-and-colons notation (for example, C(00:11:22:33:44:55)). type: list elements: str mac-address-randomization: description: - One of C(0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), C(1) (never randomize the MAC address), or C(2) (always randomize the MAC address). - This property is deprecated for I(cloned-mac-address). type: int default: 0 choices: [ 0, 1, 2 ] mac-address: description: - If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. - This property does not change the MAC address of the device (for example for MAC spoofing). type: str mode: description: Wi-Fi network mode. If blank, C(infrastructure) is assumed. type: str choices: [ infrastructure, mesh, adhoc, ap ] default: infrastructure mtu: description: If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames. type: int default: 0 powersave: description: - One of C(2) (disable Wi-Fi power saving), C(3) (enable Wi-Fi power saving), C(1) (don't touch currently configure setting) or C(0) (use the globally configured value). - All other values are reserved. type: int default: 0 choices: [ 0, 1, 2, 3 ] rate: description: - If non-zero, directs the device to only use the specified bitrate for communication with the access point. - Units are in Kb/s, so for example C(5500) = 5.5 Mbit/s. - This property is highly driver dependent and not all devices support setting a static bitrate. type: int default: 0 tx-power: description: - If non-zero, directs the device to use the specified transmit power. - Units are dBm. - This property is highly driver dependent and not all devices support setting a static transmit power. type: int default: 0 wake-on-wlan: description: - The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. - May be any combination of C(NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY) (C(0x2)), C(NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT) (C(0x4)), C(NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC) (C(0x8)), C(NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE) (C(0x10)), C(NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST) (C(0x20)), C(NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE) (C(0x40)), C(NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE) (C(0x80)), C(NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP) (C(0x100)) or the special values C(0x1) (to use global settings) and C(0x8000) (to disable management of Wake-on-LAN in NetworkManager). - Note the option values' sum must be specified in order to combine multiple options. type: int default: 1 version_added: 3.5.0 ignore_unsupported_suboptions: description: - Ignore suboptions which are invalid or unsupported by the version of NetworkManager/nmcli installed on the host. - Only I(wifi) and I(wifi_sec) options are currently affected. type: bool default: false version_added: 3.6.0 gsm: description: - The configuration of the GSM connection. - Note the list of suboption attributes may vary depending on which version of NetworkManager/nmcli is installed on the host. - 'An up-to-date list of supported attributes can be found here: U(https://networkmanager.dev/docs/api/latest/settings-gsm.html).' - 'For instance to use apn, pin, username and password: C({apn: provider.apn, pin: 1234, username: apn.username, password: apn.password}).' type: dict version_added: 3.7.0 suboptions: apn: description: - The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. - The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. - The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9. type: str auto-config: description: When C(true), the settings such as I(gsm.apn), I(gsm.username), or I(gsm.password) will default to values that match the network the modem will register to in the Mobile Broadband Provider database. type: bool default: false device-id: description: - The device unique identifier (as given by the C(WWAN) management service) which this connection applies to. - If given, the connection will only apply to the specified device. type: str home-only: description: - When C(true), only connections to the home network will be allowed. - Connections to roaming networks will not be made. type: bool default: false mtu: description: If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames. type: int default: 0 network-id: description: - The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. - If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. - This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible. type: str number: description: Legacy setting that used to help establishing PPP data sessions for GSM-based modems. type: str password: description: - The password used to authenticate with the network, if required. - Many providers do not require a password, or accept any password. - But if a password is required, it is specified here. type: str password-flags: description: - NMSettingSecretFlags indicating how to handle the I(password) property. - 'Following choices are allowed: C(0) B(NONE): The system is responsible for providing and storing this secret (default), C(1) B(AGENT_OWNED): A user secret agent is responsible for providing and storing this secret; when it is required agents will be asked to retrieve it C(2) B(NOT_SAVED): This secret should not be saved, but should be requested from the user each time it is needed C(4) B(NOT_REQUIRED): In situations where it cannot be automatically determined that the secret is required (some VPNs and PPP providers do not require all secrets) this flag indicates that the specific secret is not required.' type: int choices: [ 0, 1, 2 , 4 ] default: 0 pin: description: - If the SIM is locked with a PIN it must be unlocked before any other operations are requested. - Specify the PIN here to allow operation of the device. type: str pin-flags: description: - NMSettingSecretFlags indicating how to handle the I(gsm.pin) property. - See I(gsm.password-flags) for NMSettingSecretFlags choices. type: int choices: [ 0, 1, 2 , 4 ] default: 0 sim-id: description: - The SIM card unique identifier (as given by the C(WWAN) management service) which this connection applies to. - 'If given, the connection will apply to any device also allowed by I(gsm.device-id) which contains a SIM card matching the given identifier.' type: str sim-operator-id: description: - A MCC/MNC string like C(310260) or C(21601I) identifying the specific mobile network operator which this connection applies to. - 'If given, the connection will apply to any device also allowed by I(gsm.device-id) and I(gsm.sim-id) which contains a SIM card provisioned by the given operator.' type: str username: description: - The username used to authenticate with the network, if required. - Many providers do not require a username, or accept any username. - But if a username is required, it is specified here. wireguard: description: - The configuration of the Wireguard connection. - Note the list of suboption attributes may vary depending on which version of NetworkManager/nmcli is installed on the host. - 'An up-to-date list of supported attributes can be found here: U(https://networkmanager.dev/docs/api/latest/settings-wireguard.html).' - 'For instance to configure a listen port: C({listen-port: 12345}).' type: dict version_added: 4.3.0 suboptions: fwmark: description: - The 32-bit fwmark for outgoing packets. - The use of fwmark is optional and is by default off. Setting it to 0 disables it. - Note that I(wireguard.ip4-auto-default-route) or I(wireguard.ip6-auto-default-route) enabled, implies to automatically choose a fwmark. type: int ip4-auto-default-route: description: - Whether to enable special handling of the IPv4 default route. - If enabled, the IPv4 default route from I(wireguard.peer-routes) will be placed to a dedicated routing-table and two policy routing rules will be added. - The fwmark number is also used as routing-table for the default-route, and if fwmark is zero, an unused fwmark/table is chosen automatically. This corresponds to what wg-quick does with Table=auto and what WireGuard calls "Improved Rule-based Routing" type: bool ip6-auto-default-route: description: - Like I(wireguard.ip4-auto-default-route), but for the IPv6 default route. type: bool listen-port: description: The WireGuard connection listen-port. If not specified, the port will be chosen randomly when the interface comes up. type: int mtu: description: - If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments. - If zero a default MTU is used. Note that contrary to wg-quick's MTU setting, this does not take into account the current routes at the time of activation. type: int peer-routes: description: - Whether to automatically add routes for the AllowedIPs ranges of the peers. - If C(true) (the default), NetworkManager will automatically add routes in the routing tables according to C(ipv4.route-table) and C(ipv6.route-table). Usually you want this automatism enabled. - If C(false), no such routes are added automatically. In this case, the user may want to configure static routes in C(ipv4.routes) and C(ipv6.routes), respectively. - Note that if the peer's AllowedIPs is C(0.0.0.0/0) or C(::/0) and the profile's C(ipv4.never-default) or C(ipv6.never-default) setting is enabled, the peer route for this peer won't be added automatically. type: bool private-key: description: The 256 bit private-key in base64 encoding. type: str private-key-flags: description: C(NMSettingSecretFlags) indicating how to handle the I(wireguard.private-key) property. type: int choices: [ 0, 1, 2 ] ''' EXAMPLES = r''' # These examples are using the following inventory: # # ## Directory layout: # # |_/inventory/cloud-hosts # | /group_vars/openstack-stage.yml # | /host_vars/controller-01.openstack.host.com # | /host_vars/controller-02.openstack.host.com # |_/playbook/library/nmcli.py # | /playbook-add.yml # | /playbook-del.yml # ``` # # ## inventory examples # ### groups_vars # ```yml # --- # #devops_os_define_network # storage_gw: "192.0.2.254" # external_gw: "198.51.100.254" # tenant_gw: "203.0.113.254" # # #Team vars # nmcli_team: # - conn_name: tenant # ip4: '{{ tenant_ip }}' # gw4: '{{ tenant_gw }}' # - conn_name: external # ip4: '{{ external_ip }}' # gw4: '{{ external_gw }}' # - conn_name: storage # ip4: '{{ storage_ip }}' # gw4: '{{ storage_gw }}' # nmcli_team_slave: # - conn_name: em1 # ifname: em1 # master: tenant # - conn_name: em2 # ifname: em2 # master: tenant # - conn_name: p2p1 # ifname: p2p1 # master: storage # - conn_name: p2p2 # ifname: p2p2 # master: external # # #bond vars # nmcli_bond: # - conn_name: tenant # ip4: '{{ tenant_ip }}' # gw4: '' # mode: balance-rr # - conn_name: external # ip4: '{{ external_ip }}' # gw4: '' # mode: balance-rr # - conn_name: storage # ip4: '{{ storage_ip }}' # gw4: '{{ storage_gw }}' # mode: balance-rr # nmcli_bond_slave: # - conn_name: em1 # ifname: em1 # master: tenant # - conn_name: em2 # ifname: em2 # master: tenant # - conn_name: p2p1 # ifname: p2p1 # master: storage # - conn_name: p2p2 # ifname: p2p2 # master: external # # #ethernet vars # nmcli_ethernet: # - conn_name: em1 # ifname: em1 # ip4: # - '{{ tenant_ip }}' # - '{{ second_tenant_ip }}' # gw4: '{{ tenant_gw }}' # - conn_name: em2 # ifname: em2 # ip4: '{{ tenant_ip1 }}' # gw4: '{{ tenant_gw }}' # - conn_name: p2p1 # ifname: p2p1 # ip4: '{{ storage_ip }}' # gw4: '{{ storage_gw }}' # - conn_name: p2p2 # ifname: p2p2 # ip4: '{{ external_ip }}' # gw4: '{{ external_gw }}' # ``` # # ### host_vars # ```yml # --- # storage_ip: "192.0.2.91/23" # external_ip: "198.51.100.23/21" # tenant_ip: "203.0.113.77/23" # second_tenant_ip: "204.0.113.77/23" # ``` ## playbook-add.yml example --- - hosts: openstack-stage remote_user: root tasks: - name: Install needed network manager libs ansible.builtin.package: name: - NetworkManager-libnm - nm-connection-editor - libsemanage-python - policycoreutils-python state: present ##### Working with all cloud nodes - Teaming - name: Try nmcli add team - conn_name only & ip4 gw4 community.general.nmcli: type: team conn_name: '{{ item.conn_name }}' ip4: '{{ item.ip4 }}' gw4: '{{ item.gw4 }}' state: present with_items: - '{{ nmcli_team }}' - name: Try nmcli add teams-slave community.general.nmcli: type: team-slave conn_name: '{{ item.conn_name }}' ifname: '{{ item.ifname }}' master: '{{ item.master }}' state: present with_items: - '{{ nmcli_team_slave }}' ###### Working with all cloud nodes - Bonding - name: Try nmcli add bond - conn_name only & ip4 gw4 mode community.general.nmcli: type: bond conn_name: '{{ item.conn_name }}' ip4: '{{ item.ip4 }}' gw4: '{{ item.gw4 }}' mode: '{{ item.mode }}' state: present with_items: - '{{ nmcli_bond }}' - name: Try nmcli add bond-slave community.general.nmcli: type: bond-slave conn_name: '{{ item.conn_name }}' ifname: '{{ item.ifname }}' master: '{{ item.master }}' state: present with_items: - '{{ nmcli_bond_slave }}' ##### Working with all cloud nodes - Ethernet - name: Try nmcli add Ethernet - conn_name only & ip4 gw4 community.general.nmcli: type: ethernet conn_name: '{{ item.conn_name }}' ip4: '{{ item.ip4 }}' gw4: '{{ item.gw4 }}' state: present with_items: - '{{ nmcli_ethernet }}' ## playbook-del.yml example - hosts: openstack-stage remote_user: root tasks: - name: Try nmcli del team - multiple community.general.nmcli: conn_name: '{{ item.conn_name }}' state: absent with_items: - conn_name: em1 - conn_name: em2 - conn_name: p1p1 - conn_name: p1p2 - conn_name: p2p1 - conn_name: p2p2 - conn_name: tenant - conn_name: storage - conn_name: external - conn_name: team-em1 - conn_name: team-em2 - conn_name: team-p1p1 - conn_name: team-p1p2 - conn_name: team-p2p1 - conn_name: team-p2p2 - name: Add an Ethernet connection with static IP configuration community.general.nmcli: conn_name: my-eth1 ifname: eth1 type: ethernet ip4: 192.0.2.100/24 gw4: 192.0.2.1 state: present - name: Add an Team connection with static IP configuration community.general.nmcli: conn_name: my-team1 ifname: my-team1 type: team ip4: 192.0.2.100/24 gw4: 192.0.2.1 state: present autoconnect: yes - name: Optionally, at the same time specify IPv6 addresses for the device community.general.nmcli: conn_name: my-eth1 ifname: eth1 type: ethernet ip4: 192.0.2.100/24 gw4: 192.0.2.1 ip6: 2001:db8::cafe gw6: 2001:db8::1 state: present - name: Add two IPv4 DNS server addresses community.general.nmcli: conn_name: my-eth1 type: ethernet dns4: - 192.0.2.53 - 198.51.100.53 state: present - name: Make a profile usable for all compatible Ethernet interfaces community.general.nmcli: ctype: ethernet name: my-eth1 ifname: '*' state: present - name: Change the property of a setting e.g. MTU community.general.nmcli: conn_name: my-eth1 mtu: 9000 type: ethernet state: present - name: Add second ip4 address community.general.nmcli: conn_name: my-eth1 ifname: eth1 type: ethernet ip4: - 192.0.2.100/24 - 192.0.3.100/24 state: present - name: Add second ip6 address community.general.nmcli: conn_name: my-eth1 ifname: eth1 type: ethernet ip6: - 2001:db8::cafe - 2002:db8::cafe state: present - name: Add VxLan community.general.nmcli: type: vxlan conn_name: vxlan_test1 vxlan_id: 16 vxlan_local: 192.168.1.2 vxlan_remote: 192.168.1.5 - name: Add gre community.general.nmcli: type: gre conn_name: gre_test1 ip_tunnel_dev: eth0 ip_tunnel_local: 192.168.1.2 ip_tunnel_remote: 192.168.1.5 - name: Add ipip community.general.nmcli: type: ipip conn_name: ipip_test1 ip_tunnel_dev: eth0 ip_tunnel_local: 192.168.1.2 ip_tunnel_remote: 192.168.1.5 - name: Add sit community.general.nmcli: type: sit conn_name: sit_test1 ip_tunnel_dev: eth0 ip_tunnel_local: 192.168.1.2 ip_tunnel_remote: 192.168.1.5 - name: Add zone community.general.nmcli: type: ethernet conn_name: my-eth1 zone: external state: present # nmcli exits with status 0 if it succeeds and exits with a status greater # than zero when there is a failure. The following list of status codes may be # returned: # # - 0 Success - indicates the operation succeeded # - 1 Unknown or unspecified error # - 2 Invalid user input, wrong nmcli invocation # - 3 Timeout expired (see --wait option) # - 4 Connection activation failed # - 5 Connection deactivation failed # - 6 Disconnecting device failed # - 7 Connection deletion failed # - 8 NetworkManager is not running # - 9 nmcli and NetworkManager versions mismatch # - 10 Connection, device, or access point does not exist. - name: Create the wifi connection community.general.nmcli: type: wifi conn_name: Brittany ifname: wlp4s0 ssid: Brittany wifi_sec: key-mgmt: wpa-psk psk: my_password autoconnect: true state: present - name: Create a hidden AP mode wifi connection community.general.nmcli: type: wifi conn_name: ChocoMaster ifname: wlo1 ssid: ChocoMaster wifi: hidden: true mode: ap autoconnect: true state: present - name: Create a gsm connection community.general.nmcli: type: gsm conn_name: my-gsm-provider ifname: cdc-wdm0 gsm: apn: my.provider.apn username: my-provider-username password: my-provider-password pin: my-sim-pin autoconnect: true state: present - name: Create a wireguard connection community.general.nmcli: type: wireguard conn_name: my-wg-provider ifname: mywg0 wireguard: listen-port: 51820 private-key: my-private-key autoconnect: true state: present ''' RETURN = r"""# """ from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_text import re class NmcliModuleError(Exception): pass class Nmcli(object): """ This is the generic nmcli manipulation class that is subclassed based on platform. A subclass may wish to override the following action methods:- - create_connection() - delete_connection() - edit_connection() - modify_connection() - show_connection() - up_connection() - down_connection() All subclasses MUST define platform and distribution (which may be None). """ platform = 'Generic' distribution = None SECRET_OPTIONS = ( '802-11-wireless-security.leap-password', '802-11-wireless-security.psk', '802-11-wireless-security.wep-key0', '802-11-wireless-security.wep-key1', '802-11-wireless-security.wep-key2', '802-11-wireless-security.wep-key3' ) def __init__(self, module): self.module = module self.state = module.params['state'] self.ignore_unsupported_suboptions = module.params['ignore_unsupported_suboptions'] self.autoconnect = module.params['autoconnect'] self.conn_name = module.params['conn_name'] self.master = module.params['master'] self.ifname = module.params['ifname'] self.type = module.params['type'] self.ip4 = module.params['ip4'] self.gw4 = module.params['gw4'] self.gw4_ignore_auto = module.params['gw4_ignore_auto'] self.routes4 = module.params['routes4'] self.routes4_extended = module.params['routes4_extended'] self.route_metric4 = module.params['route_metric4'] self.routing_rules4 = module.params['routing_rules4'] self.never_default4 = module.params['never_default4'] self.dns4 = module.params['dns4'] self.dns4_search = module.params['dns4_search'] self.dns4_ignore_auto = module.params['dns4_ignore_auto'] self.method4 = module.params['method4'] self.may_fail4 = module.params['may_fail4'] self.ip6 = module.params['ip6'] self.gw6 = module.params['gw6'] self.gw6_ignore_auto = module.params['gw6_ignore_auto'] self.routes6 = module.params['routes6'] self.routes6_extended = module.params['routes6_extended'] self.route_metric6 = module.params['route_metric6'] self.dns6 = module.params['dns6'] self.dns6_search = module.params['dns6_search'] self.dns6_ignore_auto = module.params['dns6_ignore_auto'] self.method6 = module.params['method6'] self.ip_privacy6 = module.params['ip_privacy6'] self.addr_gen_mode6 = module.params['addr_gen_mode6'] self.mtu = module.params['mtu'] self.stp = module.params['stp'] self.priority = module.params['priority'] self.mode = module.params['mode'] self.miimon = module.params['miimon'] self.primary = module.params['primary'] self.downdelay = module.params['downdelay'] self.updelay = module.params['updelay'] self.arp_interval = module.params['arp_interval'] self.arp_ip_target = module.params['arp_ip_target'] self.slavepriority = module.params['slavepriority'] self.forwarddelay = module.params['forwarddelay'] self.hellotime = module.params['hellotime'] self.maxage = module.params['maxage'] self.ageingtime = module.params['ageingtime'] self.hairpin = module.params['hairpin'] self.path_cost = module.params['path_cost'] self.mac = module.params['mac'] self.runner = module.params['runner'] self.runner_hwaddr_policy = module.params['runner_hwaddr_policy'] self.vlanid = module.params['vlanid'] self.vlandev = module.params['vlandev'] self.flags = module.params['flags'] self.ingress = module.params['ingress'] self.egress = module.params['egress'] self.vxlan_id = module.params['vxlan_id'] self.vxlan_local = module.params['vxlan_local'] self.vxlan_remote = module.params['vxlan_remote'] self.ip_tunnel_dev = module.params['ip_tunnel_dev'] self.ip_tunnel_local = module.params['ip_tunnel_local'] self.ip_tunnel_remote = module.params['ip_tunnel_remote'] self.ip_tunnel_input_key = module.params['ip_tunnel_input_key'] self.ip_tunnel_output_key = module.params['ip_tunnel_output_key'] self.nmcli_bin = self.module.get_bin_path('nmcli', True) self.dhcp_client_id = module.params['dhcp_client_id'] self.zone = module.params['zone'] self.ssid = module.params['ssid'] self.wifi = module.params['wifi'] self.wifi_sec = module.params['wifi_sec'] self.gsm = module.params['gsm'] self.wireguard = module.params['wireguard'] if self.method4: self.ipv4_method = self.method4 elif self.type in ('dummy', 'wireguard') and not self.ip4: self.ipv4_method = 'disabled' elif self.ip4: self.ipv4_method = 'manual' else: self.ipv4_method = None if self.method6: self.ipv6_method = self.method6 elif self.type in ('dummy', 'wireguard') and not self.ip6: self.ipv6_method = 'disabled' elif self.ip6: self.ipv6_method = 'manual' else: self.ipv6_method = None self.edit_commands = [] def execute_command(self, cmd, use_unsafe_shell=False, data=None): if isinstance(cmd, list): cmd = [to_text(item) for item in cmd] else: cmd = to_text(cmd) return self.module.run_command(cmd, use_unsafe_shell=use_unsafe_shell, data=data) def execute_edit_commands(self, commands, arguments): arguments = arguments or [] cmd = [self.nmcli_bin, 'con', 'edit'] + arguments data = "\n".join(commands) return self.execute_command(cmd, data=data) def connection_options(self, detect_change=False): # Options common to multiple connection types. options = { 'connection.autoconnect': self.autoconnect, 'connection.zone': self.zone, } # IP address options. if self.ip_conn_type and not self.master: options.update({ 'ipv4.addresses': self.enforce_ipv4_cidr_notation(self.ip4), 'ipv4.dhcp-client-id': self.dhcp_client_id, 'ipv4.dns': self.dns4, 'ipv4.dns-search': self.dns4_search, 'ipv4.ignore-auto-dns': self.dns4_ignore_auto, 'ipv4.gateway': self.gw4, 'ipv4.ignore-auto-routes': self.gw4_ignore_auto, 'ipv4.routes': self.enforce_routes_format(self.routes4, self.routes4_extended), 'ipv4.route-metric': self.route_metric4, 'ipv4.routing-rules': self.routing_rules4, 'ipv4.never-default': self.never_default4, 'ipv4.method': self.ipv4_method, 'ipv4.may-fail': self.may_fail4, 'ipv6.addresses': self.enforce_ipv6_cidr_notation(self.ip6), 'ipv6.dns': self.dns6, 'ipv6.dns-search': self.dns6_search, 'ipv6.ignore-auto-dns': self.dns6_ignore_auto, 'ipv6.gateway': self.gw6, 'ipv6.ignore-auto-routes': self.gw6_ignore_auto, 'ipv6.routes': self.enforce_routes_format(self.routes6, self.routes6_extended), 'ipv6.route-metric': self.route_metric6, 'ipv6.method': self.ipv6_method, 'ipv6.ip6-privacy': self.ip_privacy6, 'ipv6.addr-gen-mode': self.addr_gen_mode6 }) # Layer 2 options. if self.mac: options.update({self.mac_setting: self.mac}) if self.mtu_conn_type: options.update({self.mtu_setting: self.mtu}) # Connections that can have a master. if self.slave_conn_type: options.update({ 'connection.master': self.master, }) # Options specific to a connection type. if self.type == 'bond': options.update({ 'arp-interval': self.arp_interval, 'arp-ip-target': self.arp_ip_target, 'downdelay': self.downdelay, 'miimon': self.miimon, 'mode': self.mode, 'primary': self.primary, 'updelay': self.updelay, }) elif self.type == 'bond-slave': options.update({ 'connection.slave-type': 'bond', }) elif self.type == 'bridge': options.update({ 'bridge.ageing-time': self.ageingtime, 'bridge.forward-delay': self.forwarddelay, 'bridge.hello-time': self.hellotime, 'bridge.max-age': self.maxage, 'bridge.priority': self.priority, 'bridge.stp': self.stp, }) elif self.type == 'team': options.update({ 'team.runner': self.runner, 'team.runner-hwaddr-policy': self.runner_hwaddr_policy, }) elif self.type == 'bridge-slave': options.update({ 'connection.slave-type': 'bridge', 'bridge-port.path-cost': self.path_cost, 'bridge-port.hairpin-mode': self.hairpin, 'bridge-port.priority': self.slavepriority, }) elif self.type == 'team-slave': options.update({ 'connection.slave-type': 'team', }) elif self.tunnel_conn_type: options.update({ 'ip-tunnel.local': self.ip_tunnel_local, 'ip-tunnel.mode': self.type, 'ip-tunnel.parent': self.ip_tunnel_dev, 'ip-tunnel.remote': self.ip_tunnel_remote, }) if self.type == 'gre': options.update({ 'ip-tunnel.input-key': self.ip_tunnel_input_key, 'ip-tunnel.output-key': self.ip_tunnel_output_key }) elif self.type == 'vlan': options.update({ 'vlan.id': self.vlanid, 'vlan.parent': self.vlandev, 'vlan.flags': self.flags, 'vlan.ingress': self.ingress, 'vlan.egress': self.egress, }) elif self.type == 'vxlan': options.update({ 'vxlan.id': self.vxlan_id, 'vxlan.local': self.vxlan_local, 'vxlan.remote': self.vxlan_remote, }) elif self.type == 'wifi': options.update({ '802-11-wireless.ssid': self.ssid, 'connection.slave-type': 'bond' if self.master else None, }) if self.wifi: for name, value in self.wifi.items(): options.update({ '802-11-wireless.%s' % name: value }) if self.wifi_sec: for name, value in self.wifi_sec.items(): options.update({ '802-11-wireless-security.%s' % name: value }) elif self.type == 'gsm': if self.gsm: for name, value in self.gsm.items(): options.update({ 'gsm.%s' % name: value, }) elif self.type == 'wireguard': if self.wireguard: for name, value in self.wireguard.items(): options.update({ 'wireguard.%s' % name: value, }) # Convert settings values based on the situation. for setting, value in options.items(): setting_type = self.settings_type(setting) convert_func = None if setting_type is bool: # Convert all bool options to yes/no. convert_func = self.bool_to_string if detect_change: if setting in ('vlan.id', 'vxlan.id'): # Convert VLAN/VXLAN IDs to text when detecting changes. convert_func = to_text elif setting == self.mtu_setting: # MTU is 'auto' by default when detecting changes. convert_func = self.mtu_to_string elif setting == 'ipv6.ip6-privacy': convert_func = self.ip6_privacy_to_num elif setting_type is list: # Convert lists to strings for nmcli create/modify commands. convert_func = self.list_to_string if callable(convert_func): options[setting] = convert_func(options[setting]) return options @property def ip_conn_type(self): return self.type in ( 'bond', 'bridge', 'dummy', 'ethernet', '802-3-ethernet', 'generic', 'gre', 'infiniband', 'ipip', 'sit', 'team', 'vlan', 'wifi', '802-11-wireless', 'gsm', 'wireguard', ) @property def mac_setting(self): if self.type == 'bridge': return 'bridge.mac-address' else: return '802-3-ethernet.cloned-mac-address' @property def mtu_conn_type(self): return self.type in ( 'dummy', 'ethernet', 'team-slave', ) @property def mtu_setting(self): return '802-3-ethernet.mtu' @staticmethod def mtu_to_string(mtu): if not mtu: return 'auto' else: return to_text(mtu) @staticmethod def ip6_privacy_to_num(privacy): ip6_privacy_values = { 'disabled': '0', 'prefer-public-addr': '1 (enabled, prefer public IP)', 'prefer-temp-addr': '2 (enabled, prefer temporary IP)', 'unknown': '-1', } if privacy is None: return None if privacy not in ip6_privacy_values: raise AssertionError('{privacy} is invalid ip_privacy6 option'.format(privacy=privacy)) return ip6_privacy_values[privacy] @property def slave_conn_type(self): return self.type in ( 'bond-slave', 'bridge-slave', 'team-slave', 'wifi', ) @property def tunnel_conn_type(self): return self.type in ( 'gre', 'ipip', 'sit', ) @staticmethod def enforce_ipv4_cidr_notation(ip4_addresses): if ip4_addresses is None: return None return [address if '/' in address else address + '/32' for address in ip4_addresses] @staticmethod def enforce_ipv6_cidr_notation(ip6_addresses): if ip6_addresses is None: return None return [address if '/' in address else address + '/128' for address in ip6_addresses] def enforce_routes_format(self, routes, routes_extended): if routes is not None: return routes elif routes_extended is not None: return [self.route_to_string(route) for route in routes_extended] else: return None @staticmethod def route_to_string(route): result_str = '' result_str += route['ip'] if route.get('next_hop') is not None: result_str += ' ' + route['next_hop'] if route.get('metric') is not None: result_str += ' ' + str(route['metric']) for attribute, value in sorted(route.items()): if attribute not in ('ip', 'next_hop', 'metric') and value is not None: result_str += ' {0}={1}'.format(attribute, str(value).lower()) return result_str @staticmethod def bool_to_string(boolean): if boolean: return "yes" else: return "no" @staticmethod def list_to_string(lst): return ",".join(lst or [""]) @staticmethod def settings_type(setting): if setting in ('bridge.stp', 'bridge-port.hairpin-mode', 'connection.autoconnect', 'ipv4.never-default', 'ipv4.ignore-auto-dns', 'ipv4.ignore-auto-routes', 'ipv4.may-fail', 'ipv6.ignore-auto-dns', 'ipv6.ignore-auto-routes', '802-11-wireless.hidden'): return bool elif setting in ('ipv4.addresses', 'ipv6.addresses', 'ipv4.dns', 'ipv4.dns-search', 'ipv4.routes', 'ipv4.routing-rules', 'ipv6.dns', 'ipv6.dns-search', 'ipv6.routes', '802-11-wireless-security.group', '802-11-wireless-security.leap-password-flags', '802-11-wireless-security.pairwise', '802-11-wireless-security.proto', '802-11-wireless-security.psk-flags', '802-11-wireless-security.wep-key-flags', '802-11-wireless.mac-address-blacklist'): return list return str def get_route_params(self, raw_values): routes_params = [] for raw_value in raw_values: route_params = {} for parameter, value in re.findall(r'([\w-]*)\s?=\s?([^\s,}]*)', raw_value): if parameter == 'nh': route_params['next_hop'] = value elif parameter == 'mt': route_params['metric'] = value else: route_params[parameter] = value routes_params.append(route_params) return [self.route_to_string(route_params) for route_params in routes_params] def list_connection_info(self): cmd = [self.nmcli_bin, '--fields', 'name', '--terse', 'con', 'show'] (rc, out, err) = self.execute_command(cmd) if rc != 0: raise NmcliModuleError(err) return out.splitlines() def connection_exists(self): return self.conn_name in self.list_connection_info() def down_connection(self): cmd = [self.nmcli_bin, 'con', 'down', self.conn_name] return self.execute_command(cmd) def up_connection(self): cmd = [self.nmcli_bin, 'con', 'up', self.conn_name] return self.execute_command(cmd) def connection_update(self, nmcli_command): if nmcli_command == 'create': cmd = [self.nmcli_bin, 'con', 'add', 'type'] if self.tunnel_conn_type: cmd.append('ip-tunnel') else: cmd.append(self.type) cmd.append('con-name') elif nmcli_command == 'modify': cmd = [self.nmcli_bin, 'con', 'modify'] else: self.module.fail_json(msg="Invalid nmcli command.") cmd.append(self.conn_name) # Use connection name as default for interface name on creation. if nmcli_command == 'create' and self.ifname is None: ifname = self.conn_name else: ifname = self.ifname options = { 'connection.interface-name': ifname, } options.update(self.connection_options()) # Constructing the command. for key, value in options.items(): if value is not None: if key in self.SECRET_OPTIONS: self.edit_commands += ['set %s %s' % (key, value)] continue cmd.extend([key, value]) return self.execute_command(cmd) def create_connection(self): status = self.connection_update('create') if status[0] == 0 and self.edit_commands: status = self.edit_connection() if self.create_connection_up: status = self.up_connection() return status @property def create_connection_up(self): if self.type in ('bond', 'dummy', 'ethernet', 'infiniband', 'wifi'): if (self.mtu is not None) or (self.dns4 is not None) or (self.dns6 is not None): return True elif self.type == 'team': if (self.dns4 is not None) or (self.dns6 is not None): return True return False def remove_connection(self): # self.down_connection() cmd = [self.nmcli_bin, 'con', 'del', self.conn_name] return self.execute_command(cmd) def modify_connection(self): status = self.connection_update('modify') if status[0] == 0 and self.edit_commands: status = self.edit_connection() return status def edit_connection(self): commands = self.edit_commands + ['save', 'quit'] return self.execute_edit_commands(commands, arguments=[self.conn_name]) def show_connection(self): cmd = [self.nmcli_bin, '--show-secrets', 'con', 'show', self.conn_name] (rc, out, err) = self.execute_command(cmd) if rc != 0: raise NmcliModuleError(err) p_enum_value = re.compile(r'^([-]?\d+) \((\w+)\)$') conn_info = dict() for line in out.splitlines(): pair = line.split(':', 1) key = pair[0].strip() key_type = self.settings_type(key) if key and len(pair) > 1: raw_value = pair[1].lstrip() if raw_value == '--': conn_info[key] = None elif key == 'bond.options': # Aliases such as 'miimon', 'downdelay' are equivalent to the +bond.options 'option=value' syntax. opts = raw_value.split(',') for opt in opts: alias_pair = opt.split('=', 1) if len(alias_pair) > 1: alias_key = alias_pair[0] alias_value = alias_pair[1] conn_info[alias_key] = alias_value elif key in ('ipv4.routes', 'ipv6.routes'): conn_info[key] = [s.strip() for s in raw_value.split(';')] elif key_type == list: conn_info[key] = [s.strip() for s in raw_value.split(',')] else: m_enum = p_enum_value.match(raw_value) if m_enum is not None: value = m_enum.group(1) else: value = raw_value conn_info[key] = value return conn_info def get_supported_properties(self, setting): properties = [] if setting == '802-11-wireless-security': set_property = 'psk' set_value = 'FAKEVALUE' commands = ['set %s.%s %s' % (setting, set_property, set_value)] else: commands = [] commands += ['print %s' % setting, 'quit', 'yes'] (rc, out, err) = self.execute_edit_commands(commands, arguments=['type', self.type]) if rc != 0: raise NmcliModuleError(err) for line in out.splitlines(): prefix = '%s.' % setting if (line.startswith(prefix)): pair = line.split(':', 1) property = pair[0].strip().replace(prefix, '') properties.append(property) return properties def check_for_unsupported_properties(self, setting): if setting == '802-11-wireless': setting_key = 'wifi' elif setting == '802-11-wireless-security': setting_key = 'wifi_sec' else: setting_key = setting supported_properties = self.get_supported_properties(setting) unsupported_properties = [] for property, value in getattr(self, setting_key).items(): if property not in supported_properties: unsupported_properties.append(property) if unsupported_properties: msg_options = [] for property in unsupported_properties: msg_options.append('%s.%s' % (setting_key, property)) msg = 'Invalid or unsupported option(s): "%s"' % '", "'.join(msg_options) if self.ignore_unsupported_suboptions: self.module.warn(msg) else: self.module.fail_json(msg=msg) return unsupported_properties def _compare_conn_params(self, conn_info, options): changed = False diff_before = dict() diff_after = dict() for key, value in options.items(): if not value: continue if key in conn_info: current_value = conn_info[key] if key in ('ipv4.routes', 'ipv6.routes') and current_value is not None: current_value = self.get_route_params(current_value) if key == self.mac_setting: # MAC addresses are case insensitive, nmcli always reports them in uppercase value = value.upper() # ensure current_value is also converted to uppercase in case nmcli changes behaviour current_value = current_value.upper() if key == 'gsm.apn': # Depending on version nmcli adds double-qoutes to gsm.apn # Need to strip them in order to compare both current_value = current_value.strip('"') if key == self.mtu_setting and self.mtu is None: self.mtu = 0 else: # parameter does not exist current_value = None if isinstance(current_value, list) and isinstance(value, list): # compare values between two lists if sorted(current_value) != sorted(value): changed = True elif all([key == self.mtu_setting, self.type == 'dummy', current_value is None, value == 'auto', self.mtu is None]): value = None else: if current_value != to_text(value): changed = True diff_before[key] = current_value diff_after[key] = value diff = { 'before': diff_before, 'after': diff_after, } return (changed, diff) def is_connection_changed(self): options = { 'connection.interface-name': self.ifname, } if not self.type: current_con_type = self.show_connection().get('connection.type') if current_con_type: self.type = current_con_type options.update(self.connection_options(detect_change=True)) return self._compare_conn_params(self.show_connection(), options) def main(): # Parsing argument file module = AnsibleModule( argument_spec=dict( ignore_unsupported_suboptions=dict(type='bool', default=False), autoconnect=dict(type='bool', default=True), state=dict(type='str', required=True, choices=['absent', 'present']), conn_name=dict(type='str', required=True), master=dict(type='str'), ifname=dict(type='str'), type=dict(type='str', choices=[ 'bond', 'bond-slave', 'bridge', 'bridge-slave', 'dummy', 'ethernet', 'generic', 'gre', 'infiniband', 'ipip', 'sit', 'team', 'team-slave', 'vlan', 'vxlan', 'wifi', 'gsm', 'wireguard', ]), ip4=dict(type='list', elements='str'), gw4=dict(type='str'), gw4_ignore_auto=dict(type='bool', default=False), routes4=dict(type='list', elements='str'), routes4_extended=dict(type='list', elements='dict', options=dict( ip=dict(type='str', required=True), next_hop=dict(type='str'), metric=dict(type='int'), table=dict(type='int'), tos=dict(type='int'), cwnd=dict(type='int'), mtu=dict(type='int'), onlink=dict(type='bool') )), route_metric4=dict(type='int'), routing_rules4=dict(type='list', elements='str'), never_default4=dict(type='bool', default=False), dns4=dict(type='list', elements='str'), dns4_search=dict(type='list', elements='str'), dns4_ignore_auto=dict(type='bool', default=False), method4=dict(type='str', choices=['auto', 'link-local', 'manual', 'shared', 'disabled']), may_fail4=dict(type='bool', default=True), dhcp_client_id=dict(type='str'), ip6=dict(type='list', elements='str'), gw6=dict(type='str'), gw6_ignore_auto=dict(type='bool', default=False), dns6=dict(type='list', elements='str'), dns6_search=dict(type='list', elements='str'), dns6_ignore_auto=dict(type='bool', default=False), routes6=dict(type='list', elements='str'), routes6_extended=dict(type='list', elements='dict', options=dict( ip=dict(type='str', required=True), next_hop=dict(type='str'), metric=dict(type='int'), table=dict(type='int'), cwnd=dict(type='int'), mtu=dict(type='int'), onlink=dict(type='bool') )), route_metric6=dict(type='int'), method6=dict(type='str', choices=['ignore', 'auto', 'dhcp', 'link-local', 'manual', 'shared', 'disabled']), ip_privacy6=dict(type='str', choices=['disabled', 'prefer-public-addr', 'prefer-temp-addr', 'unknown']), addr_gen_mode6=dict(type='str', choices=['eui64', 'stable-privacy']), # Bond Specific vars mode=dict(type='str', default='balance-rr', choices=['802.3ad', 'active-backup', 'balance-alb', 'balance-rr', 'balance-tlb', 'balance-xor', 'broadcast']), miimon=dict(type='int'), downdelay=dict(type='int'), updelay=dict(type='int'), arp_interval=dict(type='int'), arp_ip_target=dict(type='str'), primary=dict(type='str'), # general usage mtu=dict(type='int'), mac=dict(type='str'), zone=dict(type='str'), # bridge specific vars stp=dict(type='bool', default=True), priority=dict(type='int', default=128), slavepriority=dict(type='int', default=32), forwarddelay=dict(type='int', default=15), hellotime=dict(type='int', default=2), maxage=dict(type='int', default=20), ageingtime=dict(type='int', default=300), hairpin=dict(type='bool', default=True), path_cost=dict(type='int', default=100), # team specific vars runner=dict(type='str', default='roundrobin', choices=['broadcast', 'roundrobin', 'activebackup', 'loadbalance', 'lacp']), # team active-backup runner specific options runner_hwaddr_policy=dict(type='str', choices=['same_all', 'by_active', 'only_active']), # vlan specific vars vlanid=dict(type='int'), vlandev=dict(type='str'), flags=dict(type='str'), ingress=dict(type='str'), egress=dict(type='str'), # vxlan specific vars vxlan_id=dict(type='int'), vxlan_local=dict(type='str'), vxlan_remote=dict(type='str'), # ip-tunnel specific vars ip_tunnel_dev=dict(type='str'), ip_tunnel_local=dict(type='str'), ip_tunnel_remote=dict(type='str'), # ip-tunnel type gre specific vars ip_tunnel_input_key=dict(type='str', no_log=True), ip_tunnel_output_key=dict(type='str', no_log=True), # 802-11-wireless* specific vars ssid=dict(type='str'), wifi=dict(type='dict'), wifi_sec=dict(type='dict', no_log=True), gsm=dict(type='dict'), wireguard=dict(type='dict'), ), mutually_exclusive=[['never_default4', 'gw4'], ['routes4_extended', 'routes4'], ['routes6_extended', 'routes6']], required_if=[("type", "wifi", [("ssid")])], supports_check_mode=True, ) module.run_command_environ_update = dict(LANG='C', LC_ALL='C', LC_MESSAGES='C', LC_CTYPE='C') nmcli = Nmcli(module) (rc, out, err) = (None, '', '') result = {'conn_name': nmcli.conn_name, 'state': nmcli.state} # check for issues if nmcli.conn_name is None: nmcli.module.fail_json(msg="Please specify a name for the connection") # team checks if nmcli.type == "team": if nmcli.runner_hwaddr_policy and not nmcli.runner == "activebackup": nmcli.module.fail_json(msg="Runner-hwaddr-policy is only allowed for runner activebackup") # team-slave checks if nmcli.type == 'team-slave': if nmcli.master is None: nmcli.module.fail_json(msg="Please specify a name for the master when type is %s" % nmcli.type) if nmcli.ifname is None: nmcli.module.fail_json(msg="Please specify an interface name for the connection when type is %s" % nmcli.type) if nmcli.type == 'wifi': unsupported_properties = {} if nmcli.wifi: if 'ssid' in nmcli.wifi: module.warn("Ignoring option 'wifi.ssid', it must be specified with option 'ssid'") del nmcli.wifi['ssid'] unsupported_properties['wifi'] = nmcli.check_for_unsupported_properties('802-11-wireless') if nmcli.wifi_sec: unsupported_properties['wifi_sec'] = nmcli.check_for_unsupported_properties('802-11-wireless-security') if nmcli.ignore_unsupported_suboptions and unsupported_properties: for setting_key, properties in unsupported_properties.items(): for property in properties: del getattr(nmcli, setting_key)[property] try: if nmcli.state == 'absent': if nmcli.connection_exists(): if module.check_mode: module.exit_json(changed=True) (rc, out, err) = nmcli.down_connection() (rc, out, err) = nmcli.remove_connection() if rc != 0: module.fail_json(name=('No Connection named %s exists' % nmcli.conn_name), msg=err, rc=rc) elif nmcli.state == 'present': if nmcli.connection_exists(): changed, diff = nmcli.is_connection_changed() if module._diff: result['diff'] = diff if changed: # modify connection (note: this function is check mode aware) # result['Connection']=('Connection %s of Type %s is not being added' % (nmcli.conn_name, nmcli.type)) result['Exists'] = 'Connections do exist so we are modifying them' if module.check_mode: module.exit_json(changed=True, **result) (rc, out, err) = nmcli.modify_connection() else: result['Exists'] = 'Connections already exist and no changes made' if module.check_mode: module.exit_json(changed=False, **result) if not nmcli.connection_exists(): result['Connection'] = ('Connection %s of Type %s is being added' % (nmcli.conn_name, nmcli.type)) if module.check_mode: module.exit_json(changed=True, **result) (rc, out, err) = nmcli.create_connection() if rc is not None and rc != 0: module.fail_json(name=nmcli.conn_name, msg=err, rc=rc) except NmcliModuleError as e: module.fail_json(name=nmcli.conn_name, msg=str(e)) if rc is None: result['changed'] = False else: result['changed'] = True if out: result['stdout'] = out if err: result['stderr'] = err module.exit_json(**result) if __name__ == '__main__': main()