2. API Reference¶

2.1. Controller¶

2.1.1. exabgpctl.view¶

exception exabgpctl.controller.ExabgpCTLError¶: Generic Error to catch from view

exabgpctl.controller.config_load()¶

ExaBGP config loader. Loader will use exabgp lib to load the config like exabgp did

Returns:	configuration with path, state, version, neighbors and processes.
Return type:	dict

Examples

>>> import os
>>> os.environ['EXABGPCTL_CONF'] = "/etc/exabgp/exabgp.conf"
>>> os.environ['EXABGPCTL_STATE'] = "/var/lib/exabgp/state"
>>> cfg = config_load()
>>> cfg
{
    'path': '/tmp/exabgp/exabgp.conf',
    'state': '/tmp/exabgp/state',
    'version': {
        'python': '3.7.1',
        'exabgp': '3.4.19',
        'os': 'Linux-4.4.0-138-generic-x86_64-with',
        'exabgpctl': '19.01-1'
    },
    'neighbors': [
        {
            'local_address': '192.168.1.1',
            'local_as': 12345,
            'name': '192.168.0.1',
            'peer_address': '192.168.0.1',
            'peer_as': 67890,
            'router_id': '192.168.1.1',
            ...
        },
        {
            'local_address': '192.168.1.1',
            'local_as': 12345,
            'name': '192.168.0.1',
            'peer_address': '192.168.0.1',
            'peer_as': 67890,
            'router_id': '192.168.1.1',
            ...
        }
    ],
    'processes': [
    {
        'name': 'service1.exabgp.lan',
        'run': {
            'ip_dynamic': False,
            'disabled_execute': None,
            'sudo': False,
            'pid': None,
            'community': '11223:344',
            'withdraw_on_down': True,
            'execute': ['/usr/bin/exabgpctl process state service1...'],
            'name': 'service1.exabgp.lan',
            'interval': 5,
            'disable': '/tmp/exabgp/maintenance/service1.exabgp.lan',
            'command': '/bin/mycheck',
            'timeout': 5,
            ...
        },
        ...
    },
    {
        'name': 'service2.exabgp.lan',
        'run': {
            'ip_dynamic': False,
            'disabled_execute': None,
            'sudo': False,
            'pid': None,
            'community': '11223:355',
            'withdraw_on_down': True,
            'execute': ['/usr/bin/exabgpctl process state service2...'],
            'name': 'service2.exabgp.lan',
            'interval': 5,
            'disable': '/tmp/exabgp/maintenance/service2.exabgp.lan',
            'command': '/bin/mycheck',
            'timeout': 5,
            ...
        },
        ...
    },
    {
        'name': 'service3.exabgp.lan',
        'run': {
            'ip_dynamic': False,
            'disabled_execute': None,
            'sudo': False,
            'pid': None,
            'community': '11223:366',
            'withdraw_on_down': True,
            'execute': ['/usr/bin/exabgpctl process state service3...'],
            'name': 'service3.exabgp.lan',
            'interval': 5,
            'disable': '/tmp/exabgp/maintenance/service3.exabgp.lan',
            'command': '/bin/mycheck',
            'timeout': 5,
            ...
        },
        ...
    }
    ]
}

Raises:	`ExabgpCTLError` – if the conf file doesn’t exists.

See also

github.com/ahmet2mir/python-snippets/snippets/flat_unflat_dict.py

exabgpctl.controller.get_neighbor(cfg, name)¶

Show neighbor details.

Parameters:	cfg (dict) – config from config_load. name (str) – neighbor to retrieve.
Returns:	neighbor data.
Return type:	dict

Examples

>>> get_neighbor(cfg, '192.168.0.2')
{
    'local_address': '192.168.1.1',
    'local_as': 12345,
    'name': '192.168.0.1',
    'peer_address': '192.168.0.1',
    'peer_as': 67890,
    'router_id': '192.168.1.1',
    ...
}

Raises:	`ExabgpCTLError` – If neighbor not found.

exabgpctl.controller.get_process(cfg, name)¶

Show process details.

Parameters:	cfg (dict) – config from config_load. name (str) – process to retrieve.
Returns:	process data.
Return type:	dict

Examples

>>> get_process(cfg, 'service1.exabgp.lan')
{
    'name': 'service1.exabgp.lan',
    'run': {
        'ip_dynamic': False,
        'disabled_execute': None,
        'sudo': False,
        'pid': None,
        'community': '11223:344',
        'withdraw_on_down': True,
        'name': 'service1.exabgp.lan',
        'interval': 5,
        'disable': '/tmp/exabgp/maintenance/service1.exabgp.lan',
        'command': '/bin/mycheck',
        'timeout': 5,
        ...
    },
    ...
}

Raises:	`ExabgpCTLError` – If process not found.

exabgpctl.controller.get_version(key=None)¶

Get module, deps and platform version informations.

Parameters:	key (str) – filter item
Returns:	With exabgp, exabgctl, python and os versions. If key specified will return a string.
Return type:	dict

Examples

>>> get_version()
{
    'python': '3.7.1',
    'exabgp': '3.4.19',
    'os': 'Linux-4.4.0-138-generic-x86_64-with',
    'exabgpctl': '19.01-1'
}
>>> get_version("exabgpctl")
'19.01-1'

exabgpctl.controller.list_disabled_processes(cfg)¶

List disabled processes from config.

Parameters:	cfg (dict) – config from config_load.
Returns:	list of string with process names.
Return type:	list

Examples

>>> list_disabled_processes(cfg)
['service1.exabgp.lan']

exabgpctl.controller.list_enabled_processes(cfg)¶

List enabled processes from config.

Parameters:	cfg (dict) – config from config_load.
Returns:	list of string with process names.
Return type:	list

Examples

>>> list_enabled_processes(cfg)
['service2.exabgp.lan', 'service3.exabgp.lan']

exabgpctl.controller.list_neighbors(cfg)¶

List neighbors from config.

Parameters:	cfg (dict) – config from config_load.
Returns:	list of string with neighbor names.
Return type:	list

Examples

>>> list_neighbors(cfg)
['192.168.0.2', '192.168.0.1']

exabgpctl.controller.list_processes(cfg)¶

List processes from config.

Parameters:	cfg (dict) – config from config_load.
Returns:	list of string with process names.
Return type:	list

Examples

>>> list_processes(cfg)
['service1.exabgp.lan', 'service2.exabgp.lan', 'service3.exabgp.lan']

exabgpctl.controller.print_flat(data)¶

Print data in flat mode.

If data is not hash or list, will only print raw value.

Parameters:	data (dict) – data to print.

Examples

>>> data = {
        "key1": {
            "key11": {
                "key111": "value111"
            },
            "key12": {
                "key121": "value121"
            }
        },
        "key2": ["one","two", "three"]
    }
>>> print_flat(data)
key1__key11__key111=value111
key1__key12__key121=value121
key2[0]=one
key2[1]=two
key2[2]=three

exabgpctl.controller.print_json(data)¶

Print data in json mode.

If data is not hash or list, will only print raw value.

Parameters:	data (dict) – data to print.

Examples

>>> data = {
        "key1": {
            "key11": {
                "key111": "value111"
            },
            "key12": {
                "key121": "value121"
            }
        },
        "key2": ["one","two", "three"]
    }
>>> print_json(data)
{
    "key2": [
        "one",
        "two",
        "three"
    ],
    "key1": {
        "key12": {
            "key121": "value121"
        },
        "key11": {
            "key111": "value111"
        }
    }
}

exabgpctl.controller.print_yaml(data)¶

Print data in yaml mode.

If data is not hash or list, will only print raw value.

Parameters:	data (dict) – data to print.

Examples

>>> data = {
        "key1": {
            "key11": {
                "key111": "value111"
            },
            "key12": {
                "key121": "value121"
            }
        },
        "key2": ["one","two", "three"]
    }
>>> print_yaml(data)
---
key1:
  key11:
    key111: value111
  key12:
    key121: value121
key2:
  - one
  - two
  - three

exabgpctl.controller.state_process(cfg, process)¶

Set exabgp state in a statefile.

ExaBGP healthcheck command could run an action on each state change using environment called “STATE”. See healthcheck –execute option.

Parameters:

cfg (dict) – config from config_load.
process (str) – process to enable.

Returns:

One of exabgp stat: INIT: Initial state DISABLED: Disabled state RISING: Checks are currently succeeding. FALLING: Checks are currently failing. UP: Service is considered as up. DOWN: Service is considered as down.

Return type:

str

Examples

>>> import os
>>> os.environ["STATE"] = "UP"
>>> state_process(cfg, 'service1.exabgp.lan')
'UP'
>>> with open(cfg["state"] + "/service1.exabgp.lan", "r") as fd:
...     fd.read()
'UP'

exabgpctl.controller.status_neighbors(cfg)¶

Check connectivity with neighbors.

Parameters:	cfg (dict) – config from config_load.
Returns:	with statuses for each neighbor.
Return type:	dict

Examples

>>> status_neighbors(cfg)
{
    '192.168.0.1': {
        'status': True,
        'status_addressport': ['192.168.0.1', 179]
    },
    '192.168.0.2': {
        'status': True,
        'status_addressport': ['192.168.0.2', 179]
    }
}

exabgpctl.controller.status_processes(cfg)¶

Read all states from statefiles and run using healthcheck commands.

Parameters:	cfg (dict) – config from config_load. process (str) – process to enable.
Returns:	with statuses for each process.
Return type:	dict

Examples

>>> status_processes(cfg)
{
    'service1.exabgp.lan': {
        'state': 'UP',
        'state_path': '/tmp/exabgp/state/service1.exabgp.lan',
        'command': True,
        'command_check': '/bin/mycheck'
    },
    'service2.exabgp.lan': {
        'state': 'DOWN',
        'state_path': '/tmp/exabgp/state/service2.exabgp.lan',
        'command': False,
        'command_check': '/bin/mycheck'
    },
    'service3.exabgp.lan': {
        'state': 'DOWN',
        'state_path': '/tmp/exabgp/state/service3.exabgp.lan',
        'command': False,
        'command_check': '/bin/mycheck'
    }
}

exabgpctl.controller.tcping(address, port)¶

Like tcping tools, will test if the address:port is open.

Parameters:	address (str) – target address ip. port (int) – target port.
Returns:	True if address:port is open.
Return type:	bool

Examples

>>> tcping('8.8.8.8', 53)
True