furemcape.administrator package

Admininsters the system.

class furemcape.administrator.Census(*args, **kwargs)

Bases: furemcape.shared.obj.BaseAttrObject

Checks which services are available.

ALL_SERVICES = ['hitdb', 'issuedb', 'feeder', 'analyzer', 'responder', 'reporter', 'administrator']
LOG = <Logger furemcape.administrator.census (WARNING)>
check(services=None)

Checks specified services.

Returns cached check results if available.

Parameters

services (list) – List of services to check (defaults to all).

Returns

Map of service names to result dict for each service.

Return type

dict

check_administrator()

Re-checks administrator service.

Returns

Map with with status.

Return type

dict

check_analyzer()

Re-checks analyzer service.

Returns

Map with with status.

Return type

dict

check_feeder()

Re-checks feeder service.

Returns

Map with with status.

Return type

dict

check_hitdb()

Re-checks hitdb.

Returns

Map with with status and error message.

Return type

dict

check_issuedb()

Re-checks issuedb.

Returns

Map with with status and error message.

Return type

dict

check_reporter()

Re-checks reporter service.

Returns

Map with with status.

Return type

dict

check_responder()

Re-checks responder service.

Returns

Map with with status.

Return type

dict

recheck(services=None)

Re-checks specified services.

Parameters

services (list) – List of services to check (defaults to all).

Returns

Map of service names to result dict for each service.

Return type

dict

furemcape.administrator.install(services=None, batch=False)

Installs specified services.

If “upgrade” specified for services, upgrade existing only. If “all” specified for services, install/upgrade all. If no services specified, install/upgrade all.

Parameters
  • services (list) – Services to install.

  • batch (bool) – True to skip prompts (defaults to false).

Submodules

furemcape.administrator.census module

Checks which services are available.

class furemcape.administrator.census.Census(*args, **kwargs)

Bases: furemcape.shared.obj.BaseAttrObject

Checks which services are available.

ALL_SERVICES = ['hitdb', 'issuedb', 'feeder', 'analyzer', 'responder', 'reporter', 'administrator']
LOG = <Logger furemcape.administrator.census (WARNING)>
check(services=None)

Checks specified services.

Returns cached check results if available.

Parameters

services (list) – List of services to check (defaults to all).

Returns

Map of service names to result dict for each service.

Return type

dict

check_administrator()

Re-checks administrator service.

Returns

Map with with status.

Return type

dict

check_analyzer()

Re-checks analyzer service.

Returns

Map with with status.

Return type

dict

check_feeder()

Re-checks feeder service.

Returns

Map with with status.

Return type

dict

check_hitdb()

Re-checks hitdb.

Returns

Map with with status and error message.

Return type

dict

check_issuedb()

Re-checks issuedb.

Returns

Map with with status and error message.

Return type

dict

check_reporter()

Re-checks reporter service.

Returns

Map with with status.

Return type

dict

check_responder()

Re-checks responder service.

Returns

Map with with status.

Return type

dict

recheck(services=None)

Re-checks specified services.

Parameters

services (list) – List of services to check (defaults to all).

Returns

Map of service names to result dict for each service.

Return type

dict

furemcape.administrator.installer module

Installs/upgrades services.

furemcape.administrator.installer.install(services=None, batch=False)

Installs specified services.

If “upgrade” specified for services, upgrade existing only. If “all” specified for services, install/upgrade all. If no services specified, install/upgrade all.

Parameters
  • services (list) – Services to install.

  • batch (bool) – True to skip prompts (defaults to false).

furemcape.administrator.installer.install_administrator(census=None, batch=False)

Installs administrator service.

Parameters
  • census (Census) – Initialized census object (creates new object by default).

  • batch (bool) – True to skip prompts (defaults to false).

furemcape.administrator.installer.install_analyzer(census=None, batch=False)

Installs analyzer service.

Parameters
  • census (Census) – Initialized census object (creates new object by default).

  • batch (bool) – True to skip prompts (defaults to false).

furemcape.administrator.installer.install_feeder(census=None, batch=False)

Installs feeder service.

Parameters
  • census (Census) – Initialized census object (creates new object by default).

  • batch (bool) – True to skip prompts (defaults to false).

furemcape.administrator.installer.install_hitdb(census=None, batch=False)

Installs hitdb.

Parameters
  • census (Census) – Initialized census object (creates new object by default).

  • batch (bool) – True to skip prompts (defaults to false).

Raises

Exception – error connecting to hitdb.

furemcape.administrator.installer.install_issuedb(census=None, batch=False)

Installs issuedb.

Parameters
  • census (Census) – Initialized census object (creates new object by default).

  • batch (bool) – True to skip prompts (defaults to false).

Raises

Exception – error connecting to issuedb.

furemcape.administrator.installer.install_reporter(census=None, batch=False)

Installs reporter service.

Parameters
  • census (Census) – Initialized census object (creates new object by default).

  • batch (bool) – True to skip prompts (defaults to false).

furemcape.administrator.installer.install_responder(census=None, batch=False)

Installs responder service.

Parameters
  • census (Census) – Initialized census object (creates new object by default).

  • batch (bool) – True to skip prompts (defaults to false).