 (c) 2015, Chris Long <[email protected]> <[email protected]>

This file is a module for Ansible that interacts with Network Manager

 Ansible is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 Ansible is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.    See the
 GNU General Public License for more details.

 You should have received a copy of the GNU General Public License
 along with Ansible.    If not, see <http://www.gnu.org/licenses/>.

Table of Contents
This documentation is a work in progress.
Why did I write an Ansible module for NetworkManager?
DOCUMENTATION
- options
  - state
  - enabled
  - action
  - cname
  - ifname
  - type
  - mode
  - master
  - ip4
  - gw4
  - dns4
  - ip6
  - gw6
  - dns6
  - mtu
bond specific * primary * miimon * downdelay * updelay * arp_interval * arp_ip_target
bridge specific * stp * priority * forwarddelay * hellotime * maxage * ageingtime * mac * slavepriority * path_cost * hairpin
vlan specific * vlanid * vlandev * flags * ingress * egress
EXAMPLES
Exit Statuses

This documentation is a work in progress.

I will be trying to document as I code but there might be some instances where the documentation is slightly out of sync. I apologise in advance for that but my attempts to stay synced are closely aligned with me getting the code to a working state. So fingers crossed, it should stay interpretable enough.

Why did I write an Ansible module for NetworkManager?

The main reason I started writing this module was because I was building or should I say rebuilding an OpenStack undercloud the N'th time and I was sick of having to write Jinja templates for configuring the interfaces and then write all of the supporting playbook guff to manage deployment and consequent network management shell cmds for one type of interface and then rewrite it again for another type of interface.

This makes things simple, quick and extremely flexible. E.g. You can build multiple bond interfaces with assorted NIC configurations and deploy them within a couple of minutes. If you're not happy with bonding, you can, in a few seconds, change the configuration to team and team-slaves and redeploy that in a couple of minutes just by changing the 'type'. At the moment, the playbook process here would be:

Create bond
create bond-slave
deploy 'playbook-add.yml'
decide you want teams not bonds
Remove above connection 'playbook-del.yml'
in 'playbook-add.yml' change bond to team and bond-slave to team-slave
deploy 'playbook-add.yml' and voila, you now have teams rather than bonds.

Warning. Make sure that you do not change your "management NIC" or add it to one of the new connections as you could lose connectivity to your remote machine

DOCUMENTATION:

module: nmcli author: Chris Long
short_description: Manage Networking
requirements: [ nmcli, dbus ]
description: Manage the network devices. Create, modify, and manage, ethernet, teams, bonds, vlans etc.
###options:

state:

required: True
default: "present"
choices: [ present, absent ]
description:

Whether the device should exist or not, taking action if the state is different from what is stated.

enabled:

required: False
default: "yes"
choices: [ "yes", "no" ]
description:

Whether the service should start on boot. B(At least one of state and enabled are required.)
Whether the connection profile can be automatically activated ( default: yes)

action:

required: False
default: None
choices: [ add, modify, show, up, down ]
description:

Set to 'add' if you want to add a connection.
Set to 'modify' if you want to modify a connection. Modify one or more properties in the connection profile.
Set to 'delete' if you want to delete a connection. Delete a configured connection. The connection to be deleted is identified by its name 'cfname'.
Set to 'show' if you want to show a connection. Will show all devices unless 'cfname' is set.
Set to 'up' if you want to bring a connection up. Requires 'cfname' to be set.
Set to 'down' if you want to bring a connection down. Requires 'cfname' to be set.

cname:

required: True
default: None
description:

Where CNAME will be the name used to call the connection. when not provided a default name is generated: [-][-]

ifname:

required: False
default: cname
description:

Where INAME will be the what we call the interface name. Required with 'up', 'down' modifiers.
interface to bind the connection to. The connection will only be applicable to this interface name.
A special value of "*" can be used for interface-independent connections.
The ifname argument is mandatory for all connection types except bond, team, bridge and vlan.

type:

required: False
default: None
choices: [ ethernet, team, team-slave, bond, bond-slave, bridge, vlan ]
description:

This is the type of device or network connection that you wish to create.

mode:

required: False
choices: [ "balance-rr", "active-backup", "balance-xor", "broadcast", "802.3ad", "balance-tlb", "balance-alb" ]
default: None
description:

This is the type of device or network connection that you wish to create for a bond, team or bridge. (NetworkManager default: balance-rr)