Driver Index¶

Cumulus¶

Modules¶

system:

Type: Module

Supported Attributes:

Attribute	Type	Allowed Operations	Description	Examples
hostname	string	SET	This attribute defines the system’s hostname, it can be either a short name or fully qualified	hostname hostname.domain.com

# Example Runcible system module
---
system:
  hostname: hostname

interfaces:

Type: Module Array

Supported Attributes:

Attribute	Type	Allowed Operations	Description	Examples
name	string	CREATE REMOVE	The name of the interface	swp1 ge01/0/1
portfast	boolean	SET	Enables spanning tree portfast on the interface	False True
pvid	integer	SET DELETE	Vlan ID of the untagged PVID vlan for this interface.	10 20 30
bpduguard	boolean	SET	Enables BPDU Guard on the interface	False True
vlans	list	SET ADD DELETE CLEAR	A list of the tagged VLANS trunked to this interface. Depending on the switch and interface mode, this may be mutually exclusive with pvid.	[1, 10, 15, 50] [20, 30, 40] [20]
ipv4_addresses	list	SET ADD DELETE CLEAR	A list of IPV4 addresses of the interface in CIDR notation	[‘192.168.1.2/24’, ‘192.168.1.3/24’] [‘10.2.3.2/24’]

# Example Runcible interfaces module array
---
interfaces:
- bpduguard: false
  ipv4_addresses:
  - 192.168.1.2/24
  - 192.168.1.3/24
  name: swp1
  portfast: false
  pvid: 10
  vlans:
  - 1
  - 10
  - 15
  - 50

vlans:

Type: Module Array

Supported Attributes:

Attribute	Type	Allowed Operations	Description	Examples
id	integer	CREATE REMOVE	The VLAN id of the VLAN	2 20 4094
name	string	DELETE SET	The symbolic name of the vlan	office_vlan
ipv4_addresses	list	DELETE SET ADD CLEAR	A list of IPV4 addresses of the interface in CIDR notation	[‘192.168.1.2/24’, ‘192.168.1.3/24’] [‘10.2.3.2/24’]
ipv4_gateway	string	DELETE SET	The IPV4 default gateway for the interface	192.168.1.1 10.2.3.1
mtu	integer	DELETE SET	The maximum MTU of the interface	1500 9000

# Example Runcible vlans module array
---
vlans:
- id: 2
  ipv4_addresses:
  - 192.168.1.2/24
  - 192.168.1.3/24
  ipv4_gateway: 192.168.1.1
  mtu: 1500
  name: office_vlan

ntp_client:

Type: Module

Supported Attributes:

Attribute	Type	Allowed Operations	Description	Examples
interface	string	DELETE SET	Interface used for NTP	swp1 eth0
servers	list	DELETE SET ADD CLEAR	A list of servers hostname or IP addresses used for NTP	[‘0.pool.ntp.org’, ‘1.pool.ntp.org’, ‘2.pool.ntp.org’]

# Example Runcible ntp_client module
---
ntp_client:
  interface: swp1
  servers:
  - 0.pool.ntp.org
  - 1.pool.ntp.org
  - 2.pool.ntp.org

cumulus_mclag:

Type: Module

Supported Attributes:

Attribute	Type	Allowed Operations	Description	Examples
interface_ip	string	SET DELETE	The IP address that will be assigned to the peerlink bond for state syncing	169.254.2.1/30
peerlink_interfaces	list	SET ADD DELETE CLEAR	The interfaces used to create the peerlink bond	[‘swp47’, ‘swp48’]
system_mac_address	string	SET DELETE	The emulated mac address of the CLAG cluster	44:38:39:ff:01:01
peer_ip	string	SET DELETE	The CLAG peers ip address	169.254.2.2
priority	integer	SET DELETE	The priority of this device in the CLAG cluster	1000 0
backup_ip	string	SET DELETE	The backup ip used for the CLAG cluster if the peer_ip is unreachable	192.168.122.18
clagd_args	list	SET ADD DELETE CLEAR	Additional arguments passed to the CLAG daemon on startup (such as –vm to enable CLAG in a virtual machine	–vm

# Example Runcible cumulus_mclag module
---
cumulus_mclag:
  backup_ip: 192.168.122.18
  clagd_args: --vm
  interface_ip: 169.254.2.1/30
  peer_ip: 169.254.2.2
  peerlink_interfaces:
  - swp47
  - swp48
  priority: 1000
  system_mac_address: 44:38:39:ff:01:01

bonds:

Type: Module Array

Supported Attributes:

Attribute	Type	Allowed Operations	Description	Examples
name	string	CREATE REMOVE	Name of the bond	po1 bond0
slaves	list	SET ADD DELETE CLEAR	A list of member interfaces that are slaves in the bond	[‘swp1’, ‘swp2’] [‘ge0/0/1’, ‘ge0/0/2’]
mtu	integer	SET DELETE	Sets the maximum allowed MTU for the bond	1500 9000
ipv4_addresses	list	SET ADD DELETE CLEAR	A list of IPV4 addresses of the bond in CIDR notation	[‘192.168.1.2/24’, ‘192.168.1.3/24’] [‘10.2.3.2/24’]
ipv4_gateway	string	SET DELETE	The IPV4 default gateway for the bond	192.168.1.1 10.2.3.1
vlans	list	SET ADD DELETE CLEAR	A lit of tagged vlans on the bond	[1, 2, 3, 4] [200, 201, 202]
pvid	integer	SET DELETE	The untagged or PVID vlan on the bond	1 2 3 4000
clag_id	integer	SET DELETE	The CLAG ID of the bond	1 2

# Example Runcible bonds module array
---
bonds:
- clag_id: 1
  ipv4_addresses:
  - 192.168.1.2/24
  - 192.168.1.3/24
  ipv4_gateway: 192.168.1.1
  mtu: 1500
  name: po1
  pvid: 1
  slaves:
  - swp1
  - swp2
  vlans:
  - 1
  - 2
  - 3
  - 4

lldp:

Type: Module

Supported Attributes:

Attribute	Type	Allowed Operations	Description	Examples

# Example Runcible lldp module
---
lldp: {}