nornir.core.configuration

class nornir.core.configuration.Config(inventory: Optional[nornir.core.configuration.InventoryConfig] = None, ssh: Optional[nornir.core.configuration.SSHConfig] = None, logging: Optional[nornir.core.configuration.LoggingConfig] = None, core: Optional[nornir.core.configuration.CoreConfig] = None, runner: Optional[nornir.core.configuration.RunnerConfig] = None, user_defined: Optional[Dict[str, Any]] = None)

core

dict() → Dict[str, Any]

classmethod from_dict(inventory: Dict[str, Any] = None, ssh: Optional[Dict[str, Any]] = None, logging: Optional[Dict[str, Any]] = None, core: Optional[Dict[str, Any]] = None, runner: Optional[Dict[str, Any]] = None, user_defined: Optional[Dict[str, Any]] = None) → nornir.core.configuration.Config

classmethod from_file(config_file: str, inventory: Optional[Dict[str, Any]] = None, ssh: Optional[Dict[str, Any]] = None, logging: Optional[Dict[str, Any]] = None, core: Optional[Dict[str, Any]] = None, runner: Optional[Dict[str, Any]] = None, user_defined: Optional[Dict[str, Any]] = None) → nornir.core.configuration.Config

inventory

logging

runner

ssh

user_defined

class nornir.core.configuration.CoreConfig(raise_on_error: Optional[bool] = None)

class Parameters

raise_on_error = <nornir.core.configuration.Parameter object>

dict() → Dict[str, Any]

raise_on_error

class nornir.core.configuration.InventoryConfig(plugin: Optional[str] = None, options: Optional[Dict[str, Any]] = None, transform_function: Optional[str] = None, transform_function_options: Optional[Dict[str, Any]] = None)

class Parameters

options = <nornir.core.configuration.Parameter object>

plugin = <nornir.core.configuration.Parameter object>

transform_function = <nornir.core.configuration.Parameter object>

transform_function_options = <nornir.core.configuration.Parameter object>

dict() → Dict[str, Any]

options

plugin

transform_function

transform_function_options

class nornir.core.configuration.LoggingConfig(enabled: Optional[bool] = None, level: Optional[str] = None, log_file: Optional[str] = None, format: Optional[str] = None, to_console: Optional[bool] = None, loggers: Optional[List[str]] = None)

class Parameters

enabled = <nornir.core.configuration.Parameter object>

format = <nornir.core.configuration.Parameter object>

level = <nornir.core.configuration.Parameter object>

log_file = <nornir.core.configuration.Parameter object>

loggers = <nornir.core.configuration.Parameter object>

to_console = <nornir.core.configuration.Parameter object>

configure() → None

dict() → Dict[str, Any]

enabled

format

level

log_file

loggers

to_console

class nornir.core.configuration.Parameter(envvar: str, typ: Optional[Type[nornir.core.configuration.T]] = None, help: str = '', default: Optional[nornir.core.configuration.T] = None)

resolve(value: Optional[nornir.core.configuration.T]) → nornir.core.configuration.T

class nornir.core.configuration.RunnerConfig(plugin: Optional[str] = None, options: Optional[Dict[str, Any]] = None)

class Parameters

options = <nornir.core.configuration.Parameter object>

plugin = <nornir.core.configuration.Parameter object>

dict() → Dict[str, Any]

options

plugin

class nornir.core.configuration.SSHConfig(config_file: Optional[str] = None)

class Parameters

config_file = <nornir.core.configuration.Parameter object>

config_file

dict() → Dict[str, Any]