Role configuration

Role configuration settings can be set either as regular inventory variables or directly as task_vars on the import_role task.

Input Variables Validation settings

TableYAML

Variable	Type	Required	Default	Value Restrictions	Description
avd_data_conversion_mode	String		debug	Valid Values: - disabled - error - warning - info - debug - quiet	Conversion Mode for AVD input data conversion. Input data conversion will perform type conversion of input variables as defined in the schema. The type conversion is intended to help the user to identify minor issues with the input data, while still allowing the data to be validated. During conversion, messages will generated with information about the host(s) and key(s) which required conversion. “disabled” means that conversion will not run - avoid this since conversion is also handling data deprecation and upgrade. “error” will produce error messages and fail the task. “warning” will produce warning messages. “info” will produce regular log messages. “debug” will produce hidden debug messages viewable with -v. “quiet” will not produce any messages
avd_data_validation_mode	String		warning	Valid Values: - disabled - error - warning - info - debug	Validation Mode for AVD input data validation. Input data validation will validate the input variables according to the schema. During validation, messages will generated with information about the host(s) and key(s) which failed validation. “disabled” means that validation will not run. “error” will produce error messages and fail the task. “warning” will produce warning messages. “info” will produce regular log messages. “debug” will produce hidden debug messages viewable with -v.
<network_services_keys.name>	List, items: Dictionary
- name	String	Required, Unique			Specify a tenant name. Tenant provide a construct to group L3 VRFs and L2 VLANs. Networks services can be filtered by tenant name.
vrfs	List, items: Dictionary				VRFs will only be configured on a node if any of the underlying objects like svis or l3_interfaces apply to the node. It is recommended to only define a VRF in one Tenant. If the same VRF name is used across multiple tenants and those tenants are accepted by filter.tenants on the node, any object set under the duplicate VRFs must either be unique or be an exact match. VRF “default” is partially supported under network-services. Currently the supported options for “default” vrf are route-target, route-distinguisher settings, structured_config, raw_eos_cli in bgp and SVIs are the only supported interface type. Vlan-aware-bundles are supported as well inside default vrf. OSPF is not supported currently.
- name	String	Required, Unique
structured_config	Dictionary				Custom structured config for eos_cli_config_gen.
<node_type_keys.key>	Dictionary
defaults	Dictionary				Define variables for all nodes of this type.
structured_config	Dictionary				Custom structured config for eos_cli_config_gen.
node_groups	List, items: Dictionary				Define variables related to all nodes part of this group.
- group	String	Required, Unique			The Node Group Name is used for MLAG domain unless set with ‘mlag_domain_id’. The Node Group Name is also used for peer description on downstream switches’ uplinks.
nodes	List, items: Dictionary				Define variables per node.
- name	String	Required, Unique			The Node Name is used as “hostname”.
structured_config	Dictionary				Custom structured config for eos_cli_config_gen.
structured_config	Dictionary				Custom structured config for eos_cli_config_gen.
nodes	List, items: Dictionary				Define variables per node.
- name	String	Required, Unique			The Node Name is used as “hostname”.
structured_config	Dictionary				Custom structured config for eos_cli_config_gen.

avd_data_conversion_mode: <str>
avd_data_validation_mode: <str>
<network_services_keys.name>:
  - name: <str>
    vrfs:
      - name: <str>
        structured_config: <dict>
<node_type_keys.key>:
  defaults:
    structured_config: <dict>
  node_groups:
    - group: <str>
      nodes:
        - name: <str>
          structured_config: <dict>
      structured_config: <dict>
  nodes:
    - name: <str>
      structured_config: <dict>

Documentation output settings

The documentation_output settings can be leveraged to control documentation generation. This can be useful if for instance the project has thousands of endpoints, to be able to disable fabric-wide connected endpoints documentation.

TableYAML

Variable	Type	Required	Default	Value Restrictions	Description
eos_designs_documentation	Dictionary				Control fabric documentation generation.
connected_endpoints	Boolean		False		Generate fabric-wide documentation for connected endpoints.

eos_designs_documentation:
  connected_endpoints: <bool>

Custom Templates

TableYAML

Variable	Type	Required	Default	Value Restrictions	Description
eos_designs_custom_templates	List, items: Dictionary
- template	String	Required			Template file.
options	Dictionary				Template options.
list_merge	String		append_rp		Merge strategy for lists.
strip_empty_keys	Boolean		True		Filter out keys from the generated output if value is null/none/undefined.

eos_designs_custom_templates:
  - template: <str>
    options:
      list_merge: <str>
      strip_empty_keys: <bool>

---

Last update: August 17, 2023