veritas.onboarding.additional

Module Contents

Functions

additional(→ benedict.benedict)	get additional properties
get_additional_values_from_file(→ benedict.benedict)	get additional values by reading a file
add_values_from_csv(→ benedict.benedict)	get additinal values by reading a csv file
add_values_from_excel(→ benedict.benedict)	add additional values by reading an excel file
get_additional_values_from_config(→ benedict.benedict)	get additional values from config
get_matches(→ any)	loop through ALL matches and check if it matches
read_file(→ dict)	read config file

Attributes

_global_cache

veritas.onboarding.additional._global_cache

veritas.onboarding.additional.additional(device_defaults: dict, device_facts: dict, ciscoconf: veritas.configparser, onboarding_config: dict) → benedict.benedict

get additional properties

Parameters:

• device_defaults (dict) – device defaults

• device_facts (dict) – device facts

• ciscoconf (configparser) – configparser object

• onboarding_config (dict) – onboard config

Returns:

additional – additional values

Return type:

benedict

veritas.onboarding.additional.get_additional_values_from_file(response: benedict.benedict, item_config: dict, device_facts: dict, device_defaults: dict, onboarding_config: dict) → benedict.benedict

get additional values by reading a file

Parameters:

• response (benedict) – the current response

• item_config (dict) – the config for the item

• device_facts (dict) – device facts

• device_defaults (dict) – device defaults

• onboarding_config (dict) – onboarding config

Returns:

additinal – additional values

Return type:

benedict

veritas.onboarding.additional.add_values_from_csv(response: benedict.benedict, item_config: dict, device_facts: dict, device_defaults: dict, onboarding_config: dict) → benedict.benedict

get additinal values by reading a csv file

Parameters:

• response (benedict) – current response

• item_config (dict) – item config

• device_facts (dict) – device facts

• device_defaults (dict) – device defaults

• onboarding_config (dict) – onboard config

Returns:

additional – additional values

Return type:

benedict

veritas.onboarding.additional.add_values_from_excel(response: benedict.benedict, item_config: dict, device_facts: dict, device_defaults: dict, onboarding_config: dict) → benedict.benedict

add additional values by reading an excel file

Parameters:

• response (benedict) – current response

• item_config (dict) – item config

• device_facts (dict) – device facts

• device_defaults (dict) – device defaults

• onboarding_config (dict) – onboard config

Returns:

additional – additional values

Return type:

benedict

veritas.onboarding.additional.get_additional_values_from_config(response: benedict.benedict, device_facts: dict, device_defaults: dict, item_config: dict, ciscoconf: veritas.configparser) → benedict.benedict

get additional values from config

Parameters:

• response (benedict) – current response

• device_facts (dict) – device facts

• device_defaults (dict) – device defaults

• item_config (dict) – item config

• ciscoconf (configparser) – configparser object

Returns:

additional – additional values

Return type:

benedict

veritas.onboarding.additional.get_matches(device_facts: dict, device_defaults: dict, matches: dict, ciscoconf: veritas.configparser) → any

loop through ALL matches and check if it matches

get_matches looks either at the (global/interface) config, the facts, or the default values of the device. lookups like ic (case insenitive) or re (use regular expression) can be used.

examples:

facts__fqdn__re: k(?P<digits>d+)rt facts__hostname__ic: myhostname config__global__ic: username my_user config__interfaces__ic: ip address

get_matches returns the value that matches

veritas.onboarding.additional.read_file(filename: str, device_platform: str) → dict

read config file

read yaml file and check if file must be processed (is active and platform matches)

Parameters:

• filename (str) – config filename

• device_platform (str) – platform of device

Returns:

config – config

Return type:

dict