Configuration and Customization¶
Configuration options¶
Here below is the list of configuration options that the module can take. We also provide the json schema for the content of the configuration file, as well as an example of configuration file content. The example configuration file only uses all the default values, it is equivalent to providing an empty config file.
Show JSON schema
{
"title": "ConnectConfig",
"description": "This is the root of the configuration.\nEach entry in the configuration file should correspond to one of the embedded Config objects.",
"type": "object",
"properties": {
"main": {
"$ref": "#/$defs/MainConfig"
},
"carrier_ethernet_evc": {
"$ref": "#/$defs/CarrierEthernetEvcConfig"
},
"direct_internet_access": {
"$ref": "#/$defs/DirectInternetAccess"
},
"label_distribution_protocol": {
"$ref": "#/$defs/LabelDistributionProtocolConfig"
},
"nokia": {
"$ref": "#/$defs/NokiaConfig"
},
"cisco": {
"$ref": "#/$defs/CiscoConfig"
},
"juniper": {
"$ref": "#/$defs/JuniperConfig"
},
"eth_cfm": {
"$ref": "#/$defs/EthernetCFMConfig"
},
"uni": {
"$ref": "#/$defs/UniConfig"
}
},
"$defs": {
"BackendConfig": {
"description": "This is the CarrierEthernetEvc's backend config. It determines which backend should be\navailable and which one should be the default.",
"properties": {
"default": {
"enum": [
"LDP",
"EVPN"
],
"type": "string",
"default": "LDP",
"title": "Default"
},
"enabled": {
"items": {
"enum": [
"LDP",
"EVPN"
],
"type": "string"
},
"title": "Enabled",
"type": "array"
}
},
"title": "BackendConfig",
"type": "object"
},
"CarrierEthernetEvcConfig": {
"description": "This is the CarrierEthernetEvc config.",
"properties": {
"service_id": {
"$ref": "#/$defs/ServiceIdConfig"
},
"backend": {
"$ref": "#/$defs/BackendConfig"
},
"multi_homing": {
"$ref": "#/$defs/MultiHomingConfig"
},
"mtu": {
"default": 1514,
"maximum": 65536,
"minimum": 576,
"title": "Mtu",
"type": "integer"
}
},
"title": "CarrierEthernetEvcConfig",
"type": "object"
},
"CiscoConfig": {
"description": "This is the cisco specific config",
"properties": {
"netconf_retry_count": {
"default": 5,
"exclusiveMinimum": 0,
"title": "Netconf Retry Count",
"type": "integer"
},
"netconf_retry_interval": {
"default": 5,
"exclusiveMinimum": 0,
"title": "Netconf Retry Interval",
"type": "integer"
},
"xconnect": {
"$ref": "#/$defs/CiscoXconnectConfig"
}
},
"title": "CiscoConfig",
"type": "object"
},
"CiscoQosInputConfig": {
"description": "Configuration related to input policy maps configuration on cisco routers.",
"properties": {
"policy_class": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
}
],
"default": "class-default",
"title": "Policy Class"
},
"policy_name": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
}
],
"default": "template://connect/cisco/input_policy_name.j2",
"title": "Policy Name"
},
"traffic_class": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "integer"
}
],
"default": 2,
"title": "Traffic Class"
}
},
"title": "CiscoQosInputConfig",
"type": "object"
},
"CiscoQosOutputConfig": {
"description": "Configuration related to output policy maps configuration on cisco routers.",
"properties": {
"policy_class": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
}
],
"default": "class-default",
"title": "Policy Class"
},
"policy_name": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
}
],
"default": "template://connect/cisco/output_policy_name.j2",
"title": "Policy Name"
}
},
"title": "CiscoQosOutputConfig",
"type": "object"
},
"CiscoXconnectConfig": {
"description": "This is configuration specific to xconnect services on cisco\nrouters.",
"properties": {
"service_name": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
}
],
"default": "template://connect/cisco/xconnect_service_name.j2",
"title": "Service Name"
},
"group_name": {
"default": "evpn-vpws",
"title": "Group Name",
"type": "string"
},
"l2_interface_name": {
"default": "template://connect/cisco/l2_interface_name.j2",
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"title": "L2 Interface Name",
"type": "string"
},
"l2_interface_description": {
"default": "template://connect/cisco/l2_interface_description.j2",
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"title": "L2 Interface Description",
"type": "string"
},
"qos_input": {
"$ref": "#/$defs/CiscoQosInputConfig"
},
"qos_output": {
"$ref": "#/$defs/CiscoQosOutputConfig"
}
},
"title": "CiscoXconnectConfig",
"type": "object"
},
"DirectInternetAccess": {
"properties": {
"p2p_networks": {
"items": {
"format": "ipv4network",
"type": "string"
},
"title": "P2P Networks",
"type": "array"
},
"link_local_p2p": {
"default": false,
"title": "Link Local P2P",
"type": "boolean"
},
"vrf_name": {
"default": "template://connect/dia/vrf_name.j2",
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"title": "Vrf Name",
"type": "string"
}
},
"title": "DirectInternetAccess",
"type": "object"
},
"EthernetCFMConfig": {
"description": "This is the ethernet cfm quality of service config",
"properties": {
"enabled": {
"default": false,
"title": "Enabled",
"type": "boolean"
},
"level": {
"default": 0,
"maximum": 7,
"minimum": 0,
"title": "Level",
"type": "integer"
},
"domain_name": {
"default": "Network_Domain",
"title": "Domain Name",
"type": "string"
},
"mep_direction": {
"default": "up",
"enum": [
"up",
"down"
],
"title": "Mep Direction",
"type": "string"
},
"mep_id": {
"default": "template://connect/eth_cfm/mep_id.j2",
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"title": "Mep Id",
"type": "string"
},
"mep_mac_address": {
"default": "template://connect/eth_cfm/mep_mac_address.j2",
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"title": "Mep Mac Address",
"type": "string"
},
"check_interval": {
"default": "1s",
"enum": [
"10ms",
"100ms",
"1s",
"10s",
"60s",
"600s"
],
"title": "Check Interval",
"type": "string"
},
"md_admin_name": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
}
],
"default": "64512",
"title": "Md Admin Name"
},
"eth_tag": {
"default": "template://connect/eth_cfm/eth_tag.j2",
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"title": "Eth Tag",
"type": "string"
},
"eth_test": {
"default": true,
"title": "Eth Test",
"type": "boolean"
}
},
"title": "EthernetCFMConfig",
"type": "object"
},
"InventorySet": {
"description": "Container for different inventory types",
"properties": {
"netbox": {
"$ref": "#/$defs/NetboxConfig"
}
},
"title": "InventorySet",
"type": "object"
},
"JuniperConfig": {
"description": "This is the juniper specific config",
"properties": {
"netconf_retry_count": {
"default": 5,
"exclusiveMinimum": 0,
"title": "Netconf Retry Count",
"type": "integer"
},
"netconf_retry_interval": {
"default": 5,
"exclusiveMinimum": 0,
"title": "Netconf Retry Interval",
"type": "integer"
}
},
"title": "JuniperConfig",
"type": "object"
},
"LabelDistributionProtocolConfig": {
"description": "This is the LDP config.",
"properties": {},
"title": "LabelDistributionProtocolConfig",
"type": "object"
},
"LagIdConfig": {
"description": "This is the Uni service's lag id config. It determines the range of ids that can be used for the allocation of the lag.",
"properties": {
"start": {
"default": 1,
"title": "Start",
"type": "integer"
},
"end": {
"default": 64,
"title": "End",
"type": "integer"
}
},
"title": "LagIdConfig",
"type": "object"
},
"MainConfig": {
"description": "This is the main config, it contains elements transient to the whole module usage.",
"properties": {
"inventory_path": {
"anyOf": [
{
"pattern": "^source:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"pattern": "^file:\\/\\/(\\/[^\\/]+)+?$",
"type": "string"
}
],
"default": "source:///connect-inventory.yaml",
"title": "Inventory Path"
},
"inventory": {
"$ref": "#/$defs/InventorySet"
},
"allowed_uni_resolvers": {
"items": {
"type": "string"
},
"title": "Allowed Uni Resolvers",
"type": "array"
}
},
"title": "MainConfig",
"type": "object"
},
"MultiHomingConfig": {
"description": "This is the MultiHoming config.",
"properties": {
"enabled": {
"default": false,
"title": "Enabled",
"type": "boolean"
},
"lag_id": {
"default": "template://connect/lag_id.j2",
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"title": "Lag Id",
"type": "string"
},
"es_id": {
"default": "template://connect/es_id.j2",
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"title": "Es Id",
"type": "string"
},
"es_name": {
"default": "template://connect/es_name.j2",
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"title": "Es Name",
"type": "string"
},
"create_esi": {
"default": true,
"title": "Create Esi",
"type": "boolean"
}
},
"title": "MultiHomingConfig",
"type": "object"
},
"NetboxConfig": {
"properties": {
"url": {
"anyOf": [
{
"pattern": "^https?://[^/]+?(:\\d+)?/?$",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Url"
},
"token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Token"
},
"token_env": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Token Env"
},
"agent_autostart": {
"default": false,
"title": "Agent Autostart",
"type": "boolean"
}
},
"title": "NetboxConfig",
"type": "object"
},
"NokiaBGPConfig": {
"description": "This is Nokia bgp config",
"properties": {
"resolution": {
"default": "any",
"enum": [
"none",
"filter",
"any"
],
"title": "Resolution",
"type": "string"
},
"tagging": {
"default": true,
"title": "Tagging",
"type": "boolean"
},
"filters": {
"$ref": "#/$defs/NokiaBGPFiltersConfig"
},
"local_attachment_name": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
}
],
"default": "template://connect/nokia/local_attachment_name.j2",
"title": "Local Attachment Name"
},
"remote_attachment_name": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
}
],
"default": "template://connect/nokia/remote_attachment_name.j2",
"title": "Remote Attachment Name"
}
},
"title": "NokiaBGPConfig",
"type": "object"
},
"NokiaBGPFiltersConfig": {
"properties": {
"ldp": {
"default": false,
"title": "Ldp",
"type": "boolean"
},
"rsvp": {
"default": false,
"title": "Rsvp",
"type": "boolean"
},
"sr_isis": {
"default": false,
"title": "Sr Isis",
"type": "boolean"
},
"sr_te": {
"default": false,
"title": "Sr Te",
"type": "boolean"
}
},
"title": "NokiaBGPFiltersConfig",
"type": "object"
},
"NokiaConfig": {
"description": "This is the Nokia config.",
"properties": {
"netconf_retry_count": {
"default": 5,
"exclusiveMinimum": 0,
"title": "Netconf Retry Count",
"type": "integer"
},
"netconf_retry_interval": {
"default": 5,
"exclusiveMinimum": 0,
"title": "Netconf Retry Interval",
"type": "integer"
},
"customer_id": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
}
],
"default": "1",
"title": "Customer Id"
},
"epipe": {
"$ref": "#/$defs/NokiaEpipeConfig"
},
"vpls": {
"$ref": "#/$defs/NokiaVplsConfig"
},
"uni": {
"$ref": "#/$defs/NokiaUniConfig"
}
},
"title": "NokiaConfig",
"type": "object"
},
"NokiaEVPNConfig": {
"description": "This is Nokia EVPN config",
"properties": {
"bgp": {
"$ref": "#/$defs/NokiaBGPConfig"
}
},
"title": "NokiaEVPNConfig",
"type": "object"
},
"NokiaEpipeConfig": {
"description": "This is the Nokia epipe config",
"properties": {
"enable_sdp": {
"default": true,
"title": "Enable Sdp",
"type": "boolean"
},
"service_name": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
}
],
"default": "template://connect/nokia/epipe_service_name.j2",
"title": "Service Name"
},
"qos_ingress": {
"$ref": "#/$defs/NokiaEpipeQosIngressConfig"
},
"qos_egress": {
"$ref": "#/$defs/NokiaEpipeQosEgressConfig"
},
"evpn": {
"$ref": "#/$defs/NokiaEVPNConfig"
},
"sap_id": {
"default": "template://connect/nokia/sap_id.j2",
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"title": "Sap Id",
"type": "string"
},
"sap_description": {
"default": "template://connect/nokia/sap_description.j2",
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"title": "Sap Description",
"type": "string"
},
"esi_port_id": {
"default": "template://connect/nokia/port_esi.j2",
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"title": "Esi Port Id",
"type": "string"
}
},
"title": "NokiaEpipeConfig",
"type": "object"
},
"NokiaEpipeQosEgressConfig": {
"properties": {
"cbs": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "null"
}
],
"default": "auto",
"title": "Cbs"
},
"mbs": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "null"
}
],
"default": "auto",
"title": "Mbs"
},
"pir": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "null"
}
],
"default": "max",
"title": "Pir"
},
"policy_name": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
}
],
"default": "default-policy",
"title": "Policy Name"
},
"queue_id": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "integer"
}
],
"default": 3,
"title": "Queue Id"
}
},
"title": "NokiaEpipeQosEgressConfig",
"type": "object"
},
"NokiaEpipeQosIngressConfig": {
"properties": {
"cbs": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "null"
}
],
"default": "auto",
"title": "Cbs"
},
"mbs": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "null"
}
],
"default": "auto",
"title": "Mbs"
},
"pir": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "null"
}
],
"default": "max",
"title": "Pir"
},
"policy_name": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
}
],
"default": "default-policy",
"title": "Policy Name"
},
"policer_id": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "integer"
}
],
"default": 3,
"title": "Policer Id"
}
},
"title": "NokiaEpipeQosIngressConfig",
"type": "object"
},
"NokiaUniConfig": {
"description": "This is the Nokia user network interface config.",
"properties": {
"netconf_retry_count": {
"default": 5,
"exclusiveMinimum": 0,
"title": "Netconf Retry Count",
"type": "integer"
},
"netconf_retry_interval": {
"default": 5,
"exclusiveMinimum": 0,
"title": "Netconf Retry Interval",
"type": "integer"
},
"port_mode": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"enum": [
"access",
"network",
"hybrid"
],
"type": "string"
}
],
"default": "template://connect/nokia/port_mode.j2",
"title": "Port Mode"
}
},
"title": "NokiaUniConfig",
"type": "object"
},
"NokiaVplsConfig": {
"description": "This is the Nokia vpls config",
"properties": {
"service_name": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
}
],
"default": "template://connect/nokia/vpls_service_name.j2",
"title": "Service Name"
},
"qos_ingress": {
"$ref": "#/$defs/NokiaVplsQosIngressConfig"
},
"qos_egress": {
"$ref": "#/$defs/NokiaVplsQosEgressConfig"
},
"evpn": {
"$ref": "#/$defs/NokiaEVPNConfig"
},
"fdb": {
"$ref": "#/$defs/NokiaVplsFdbConfig"
},
"proxy_arp": {
"$ref": "#/$defs/NokiaVplsProxyArpConfig"
},
"sap_id": {
"default": "template://connect/nokia/sap_id.j2",
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"title": "Sap Id",
"type": "string"
},
"sap_description": {
"default": "template://connect/nokia/sap_description.j2",
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"title": "Sap Description",
"type": "string"
},
"sap_dist_cpu_protection": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sap Dist Cpu Protection"
}
},
"title": "NokiaVplsConfig",
"type": "object"
},
"NokiaVplsFdbConfig": {
"description": "Forwarding database (FDB) config",
"properties": {
"table_high_wmark": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "integer"
}
],
"default": 80,
"title": "Table High Wmark"
},
"table_low_wmark": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "integer"
}
],
"default": 60,
"title": "Table Low Wmark"
},
"table_size": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "integer"
}
],
"default": 2500,
"title": "Table Size"
}
},
"title": "NokiaVplsFdbConfig",
"type": "object"
},
"NokiaVplsProxyArpConfig": {
"description": "ARP Proxy config",
"properties": {
"age_time": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
}
],
"default": "900",
"title": "Age Time"
},
"send_refresh": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
}
],
"default": "300",
"title": "Send Refresh"
},
"table_size": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "integer"
}
],
"default": 2500,
"title": "Table Size"
}
},
"title": "NokiaVplsProxyArpConfig",
"type": "object"
},
"NokiaVplsQosEgressConfig": {
"description": "VPLS QoS Egress config",
"properties": {
"cbs": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "null"
}
],
"default": "auto",
"title": "Cbs"
},
"mbs": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "null"
}
],
"default": "auto",
"title": "Mbs"
},
"pir": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "null"
}
],
"default": "max",
"title": "Pir"
},
"policy_name": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
}
],
"default": "default-policy",
"title": "Policy Name"
},
"queue_id": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "integer"
}
],
"default": 1,
"title": "Queue Id"
}
},
"title": "NokiaVplsQosEgressConfig",
"type": "object"
},
"NokiaVplsQosIngressConfig": {
"description": "VPLS QoS Ingress config",
"properties": {
"cbs": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "null"
}
],
"default": "auto",
"title": "Cbs"
},
"mbs": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "null"
}
],
"default": "auto",
"title": "Mbs"
},
"pir": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "null"
}
],
"default": "max",
"title": "Pir"
},
"policy_name": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "string"
}
],
"default": "default-policy",
"title": "Policy Name"
},
"queue_id": {
"anyOf": [
{
"pattern": "^template:\\/\\/([^\\/]+)?(\\/[^\\/]+)+$",
"type": "string"
},
{
"type": "integer"
}
],
"default": 1,
"title": "Queue Id"
}
},
"title": "NokiaVplsQosIngressConfig",
"type": "object"
},
"ServiceIdConfig": {
"description": "This is the CarrierEthernetEvc's service id config. It determines from which range and\nusing which strategy, service ids allocated to CarrierEthernetEvcs should be picked.",
"properties": {
"start": {
"default": 1,
"exclusiveMinimum": 0,
"title": "Start",
"type": "integer"
},
"end": {
"default": 100,
"exclusiveMinimum": 0,
"title": "End",
"type": "integer"
},
"strategy": {
"default": "next",
"enum": [
"next",
"any"
],
"title": "Strategy",
"type": "string"
}
},
"title": "ServiceIdConfig",
"type": "object"
},
"UniConfig": {
"properties": {
"lag_id_range": {
"$ref": "#/$defs/LagIdConfig"
}
},
"title": "UniConfig",
"type": "object"
}
}
}
Show Default Config
carrier_ethernet_evc:
backend:
default: LDP
enabled:
- LDP
- EVPN
mtu: 1514
multi_homing:
create_esi: true
enabled: false
es_id: template://connect/es_id.j2
es_name: template://connect/es_name.j2
lag_id: template://connect/lag_id.j2
service_id:
end: 100
start: 1
strategy: next
cisco:
netconf_retry_count: 5
netconf_retry_interval: 5
xconnect:
group_name: evpn-vpws
l2_interface_description: template://connect/cisco/l2_interface_description.j2
l2_interface_name: template://connect/cisco/l2_interface_name.j2
qos_input:
policy_class: class-default
policy_name: template://connect/cisco/input_policy_name.j2
traffic_class: 2
qos_output:
policy_class: class-default
policy_name: template://connect/cisco/output_policy_name.j2
service_name: template://connect/cisco/xconnect_service_name.j2
direct_internet_access:
link_local_p2p: false
p2p_networks: []
vrf_name: template://connect/dia/vrf_name.j2
eth_cfm:
check_interval: 1s
domain_name: Network_Domain
enabled: false
eth_tag: template://connect/eth_cfm/eth_tag.j2
eth_test: true
level: 0
md_admin_name: '64512'
mep_direction: up
mep_id: template://connect/eth_cfm/mep_id.j2
mep_mac_address: template://connect/eth_cfm/mep_mac_address.j2
juniper:
netconf_retry_count: 5
netconf_retry_interval: 5
label_distribution_protocol: {}
main:
allowed_uni_resolvers:
- inmanta
inventory:
netbox:
agent_autostart: false
token: null
token_env: null
url: null
inventory_path: source:///connect-inventory.yaml
nokia:
customer_id: '1'
epipe:
enable_sdp: true
esi_port_id: template://connect/nokia/port_esi.j2
evpn:
bgp:
filters:
ldp: false
rsvp: false
sr_isis: false
sr_te: false
local_attachment_name: template://connect/nokia/local_attachment_name.j2
remote_attachment_name: template://connect/nokia/remote_attachment_name.j2
resolution: any
tagging: true
qos_egress:
cbs: auto
mbs: auto
pir: max
policy_name: default-policy
queue_id: 3
qos_ingress:
cbs: auto
mbs: auto
pir: max
policer_id: 3
policy_name: default-policy
sap_description: template://connect/nokia/sap_description.j2
sap_id: template://connect/nokia/sap_id.j2
service_name: template://connect/nokia/epipe_service_name.j2
netconf_retry_count: 5
netconf_retry_interval: 5
uni:
netconf_retry_count: 5
netconf_retry_interval: 5
port_mode: template://connect/nokia/port_mode.j2
vpls:
evpn:
bgp:
filters:
ldp: false
rsvp: false
sr_isis: false
sr_te: false
local_attachment_name: template://connect/nokia/local_attachment_name.j2
remote_attachment_name: template://connect/nokia/remote_attachment_name.j2
resolution: any
tagging: true
fdb:
table_high_wmark: 80
table_low_wmark: 60
table_size: 2500
proxy_arp:
age_time: '900'
send_refresh: '300'
table_size: 2500
qos_egress:
cbs: auto
mbs: auto
pir: max
policy_name: default-policy
queue_id: 1
qos_ingress:
cbs: auto
mbs: auto
pir: max
policy_name: default-policy
queue_id: 1
sap_description: template://connect/nokia/sap_description.j2
sap_dist_cpu_protection: null
sap_id: template://connect/nokia/sap_id.j2
service_name: template://connect/nokia/vpls_service_name.j2
uni:
lag_id_range:
end: 64
start: 1
- uni¶
- Type:
object
- Default:
- uni.lag_id_range¶
This is the Uni service’s lag id config. It determines the range of ids that can be used for the allocation of the lag.
- Type:
object
- Default:
- uni.lag_id_range.end¶
- Type:
integer
- Default:
64
- uni.lag_id_range.start¶
- Type:
integer
- Default:
1
- eth_cfm¶
This is the ethernet cfm quality of service config
- Type:
object
- Default:
- eth_cfm.eth_test¶
- Type:
boolean
- Default:
True
- eth_cfm.eth_tag¶
- Type:
string
- Default:
template://connect/eth_cfm/eth_tag.j2
- eth_cfm.md_admin_name¶
- Type:
any
- Default:
64512
- eth_cfm.check_interval¶
- Type:
string
- Default:
1s
- eth_cfm.mep_mac_address¶
- Type:
string
- Default:
template://connect/eth_cfm/mep_mac_address.j2
- eth_cfm.mep_id¶
- Type:
string
- Default:
template://connect/eth_cfm/mep_id.j2
- eth_cfm.mep_direction¶
- Type:
string
- Default:
up
- eth_cfm.domain_name¶
- Type:
string
- Default:
Network_Domain
- eth_cfm.level¶
- Type:
integer
- Default:
0
- eth_cfm.enabled¶
- Type:
boolean
- Default:
False
- juniper¶
This is the juniper specific config
- Type:
object
- Default:
- juniper.netconf_retry_interval¶
- Type:
integer
- Default:
5
- juniper.netconf_retry_count¶
- Type:
integer
- Default:
5
- cisco¶
This is the cisco specific config
- Type:
object
- Default:
- cisco.xconnect¶
This is configuration specific to xconnect services on cisco routers.
- Type:
object
- Default:
- cisco.xconnect.qos_output¶
Configuration related to output policy maps configuration on cisco routers.
- Type:
object
- Default:
- cisco.xconnect.qos_output.policy_name¶
- Type:
any
- Default:
template://connect/cisco/output_policy_name.j2
- cisco.xconnect.qos_output.policy_class¶
- Type:
any
- Default:
class-default
- cisco.xconnect.qos_input¶
Configuration related to input policy maps configuration on cisco routers.
- Type:
object
- Default:
- cisco.xconnect.qos_input.traffic_class¶
- Type:
any
- Default:
2
- cisco.xconnect.qos_input.policy_name¶
- Type:
any
- Default:
template://connect/cisco/input_policy_name.j2
- cisco.xconnect.qos_input.policy_class¶
- Type:
any
- Default:
class-default
- cisco.xconnect.l2_interface_description¶
- Type:
string
- Default:
template://connect/cisco/l2_interface_description.j2
- cisco.xconnect.l2_interface_name¶
- Type:
string
- Default:
template://connect/cisco/l2_interface_name.j2
- cisco.xconnect.group_name¶
- Type:
string
- Default:
evpn-vpws
- cisco.xconnect.service_name¶
- Type:
any
- Default:
template://connect/cisco/xconnect_service_name.j2
- cisco.netconf_retry_interval¶
- Type:
integer
- Default:
5
- cisco.netconf_retry_count¶
- Type:
integer
- Default:
5
- nokia¶
This is the Nokia config.
- Type:
object
- Default:
- nokia.uni¶
This is the Nokia user network interface config.
- Type:
object
- Default:
- nokia.uni.port_mode¶
- Type:
any
- Default:
template://connect/nokia/port_mode.j2
- nokia.uni.netconf_retry_interval¶
- Type:
integer
- Default:
5
- nokia.uni.netconf_retry_count¶
- Type:
integer
- Default:
5
- nokia.vpls¶
This is the Nokia vpls config
- Type:
object
- Default:
- nokia.vpls.sap_dist_cpu_protection¶
- Type:
any
- Default:
None
- nokia.vpls.sap_description¶
- Type:
string
- Default:
template://connect/nokia/sap_description.j2
- nokia.vpls.sap_id¶
- Type:
string
- Default:
template://connect/nokia/sap_id.j2
- nokia.vpls.proxy_arp¶
ARP Proxy config
- Type:
object
- Default:
- nokia.vpls.proxy_arp.table_size¶
- Type:
any
- Default:
2500
- nokia.vpls.proxy_arp.send_refresh¶
- Type:
any
- Default:
300
- nokia.vpls.proxy_arp.age_time¶
- Type:
any
- Default:
900
- nokia.vpls.fdb¶
Forwarding database (FDB) config
- Type:
object
- Default:
- nokia.vpls.fdb.table_size¶
- Type:
any
- Default:
2500
- nokia.vpls.fdb.table_low_wmark¶
- Type:
any
- Default:
60
- nokia.vpls.fdb.table_high_wmark¶
- Type:
any
- Default:
80
- nokia.vpls.evpn¶
This is Nokia EVPN config
- Type:
object
- Default:
- nokia.vpls.evpn.bgp¶
This is Nokia bgp config
- Type:
object
- Default:
- nokia.vpls.evpn.bgp.remote_attachment_name¶
- Type:
any
- Default:
template://connect/nokia/remote_attachment_name.j2
- nokia.vpls.evpn.bgp.local_attachment_name¶
- Type:
any
- Default:
template://connect/nokia/local_attachment_name.j2
- nokia.vpls.evpn.bgp.filters¶
- Type:
object
- Default:
- nokia.vpls.evpn.bgp.filters.sr_te¶
- Type:
boolean
- Default:
False
- nokia.vpls.evpn.bgp.filters.sr_isis¶
- Type:
boolean
- Default:
False
- nokia.vpls.evpn.bgp.filters.rsvp¶
- Type:
boolean
- Default:
False
- nokia.vpls.evpn.bgp.filters.ldp¶
- Type:
boolean
- Default:
False
- nokia.vpls.evpn.bgp.tagging¶
- Type:
boolean
- Default:
True
- nokia.vpls.evpn.bgp.resolution¶
- Type:
string
- Default:
any
- nokia.vpls.qos_egress¶
VPLS QoS Egress config
- Type:
object
- Default:
- nokia.vpls.qos_egress.queue_id¶
- Type:
any
- Default:
1
- nokia.vpls.qos_egress.policy_name¶
- Type:
any
- Default:
default-policy
- nokia.vpls.qos_egress.pir¶
- Type:
any
- Default:
max
- nokia.vpls.qos_egress.mbs¶
- Type:
any
- Default:
auto
- nokia.vpls.qos_egress.cbs¶
- Type:
any
- Default:
auto
- nokia.vpls.qos_ingress¶
VPLS QoS Ingress config
- Type:
object
- Default:
- nokia.vpls.qos_ingress.queue_id¶
- Type:
any
- Default:
1
- nokia.vpls.qos_ingress.policy_name¶
- Type:
any
- Default:
default-policy
- nokia.vpls.qos_ingress.pir¶
- Type:
any
- Default:
max
- nokia.vpls.qos_ingress.mbs¶
- Type:
any
- Default:
auto
- nokia.vpls.qos_ingress.cbs¶
- Type:
any
- Default:
auto
- nokia.vpls.service_name¶
- Type:
any
- Default:
template://connect/nokia/vpls_service_name.j2
- nokia.epipe¶
This is the Nokia epipe config
- Type:
object
- Default:
- nokia.epipe.esi_port_id¶
- Type:
string
- Default:
template://connect/nokia/port_esi.j2
- nokia.epipe.sap_description¶
- Type:
string
- Default:
template://connect/nokia/sap_description.j2
- nokia.epipe.sap_id¶
- Type:
string
- Default:
template://connect/nokia/sap_id.j2
- nokia.epipe.evpn¶
This is Nokia EVPN config
- Type:
object
- Default:
- nokia.epipe.evpn.bgp¶
This is Nokia bgp config
- Type:
object
- Default:
- nokia.epipe.evpn.bgp.remote_attachment_name¶
- Type:
any
- Default:
template://connect/nokia/remote_attachment_name.j2
- nokia.epipe.evpn.bgp.local_attachment_name¶
- Type:
any
- Default:
template://connect/nokia/local_attachment_name.j2
- nokia.epipe.evpn.bgp.filters¶
- Type:
object
- Default:
- nokia.epipe.evpn.bgp.filters.sr_te¶
- Type:
boolean
- Default:
False
- nokia.epipe.evpn.bgp.filters.sr_isis¶
- Type:
boolean
- Default:
False
- nokia.epipe.evpn.bgp.filters.rsvp¶
- Type:
boolean
- Default:
False
- nokia.epipe.evpn.bgp.filters.ldp¶
- Type:
boolean
- Default:
False
- nokia.epipe.evpn.bgp.tagging¶
- Type:
boolean
- Default:
True
- nokia.epipe.evpn.bgp.resolution¶
- Type:
string
- Default:
any
- nokia.epipe.qos_egress¶
- Type:
object
- Default:
- nokia.epipe.qos_egress.queue_id¶
- Type:
any
- Default:
3
- nokia.epipe.qos_egress.policy_name¶
- Type:
any
- Default:
default-policy
- nokia.epipe.qos_egress.pir¶
- Type:
any
- Default:
max
- nokia.epipe.qos_egress.mbs¶
- Type:
any
- Default:
auto
- nokia.epipe.qos_egress.cbs¶
- Type:
any
- Default:
auto
- nokia.epipe.qos_ingress¶
- Type:
object
- Default:
- nokia.epipe.qos_ingress.policer_id¶
- Type:
any
- Default:
3
- nokia.epipe.qos_ingress.policy_name¶
- Type:
any
- Default:
default-policy
- nokia.epipe.qos_ingress.pir¶
- Type:
any
- Default:
max
- nokia.epipe.qos_ingress.mbs¶
- Type:
any
- Default:
auto
- nokia.epipe.qos_ingress.cbs¶
- Type:
any
- Default:
auto
- nokia.epipe.service_name¶
- Type:
any
- Default:
template://connect/nokia/epipe_service_name.j2
- nokia.epipe.enable_sdp¶
- Type:
boolean
- Default:
True
- nokia.customer_id¶
- Type:
any
- Default:
1
- nokia.netconf_retry_interval¶
- Type:
integer
- Default:
5
- nokia.netconf_retry_count¶
- Type:
integer
- Default:
5
- label_distribution_protocol¶
This is the LDP config.
- Type:
object
- Default:
- direct_internet_access¶
- Type:
object
- Default:
- direct_internet_access.vrf_name¶
- Type:
string
- Default:
template://connect/dia/vrf_name.j2
- direct_internet_access.link_local_p2p¶
- Type:
boolean
- Default:
False
- direct_internet_access.p2p_networks¶
- Type:
array
- Default:
- carrier_ethernet_evc¶
This is the CarrierEthernetEvc config.
- Type:
object
- Default:
- carrier_ethernet_evc.mtu¶
- Type:
integer
- Default:
1514
- carrier_ethernet_evc.multi_homing¶
This is the MultiHoming config.
- Type:
object
- Default:
- carrier_ethernet_evc.multi_homing.create_esi¶
- Type:
boolean
- Default:
True
- carrier_ethernet_evc.multi_homing.es_name¶
- Type:
string
- Default:
template://connect/es_name.j2
- carrier_ethernet_evc.multi_homing.es_id¶
- Type:
string
- Default:
template://connect/es_id.j2
- carrier_ethernet_evc.multi_homing.lag_id¶
- Type:
string
- Default:
template://connect/lag_id.j2
- carrier_ethernet_evc.multi_homing.enabled¶
- Type:
boolean
- Default:
False
- carrier_ethernet_evc.backend¶
This is the CarrierEthernetEvc’s backend config. It determines which backend should be available and which one should be the default.
- Type:
object
- Default:
- carrier_ethernet_evc.backend.enabled¶
- Type:
array
- Default:
- carrier_ethernet_evc.backend.default¶
- Type:
string
- Default:
LDP
- carrier_ethernet_evc.service_id¶
This is the CarrierEthernetEvc’s service id config. It determines from which range and using which strategy, service ids allocated to CarrierEthernetEvcs should be picked.
- Type:
object
- Default:
- carrier_ethernet_evc.service_id.strategy¶
- Type:
string
- Default:
next
- carrier_ethernet_evc.service_id.end¶
- Type:
integer
- Default:
100
- carrier_ethernet_evc.service_id.start¶
- Type:
integer
- Default:
1
- main¶
This is the main config, it contains elements transient to the whole module usage.
- Type:
object
- Default:
- main.allowed_uni_resolvers¶
- Type:
array
- Default:
- main.inventory¶
Container for different inventory types
- Type:
object
- Default:
- main.inventory.netbox¶
- Type:
object
- Default:
- main.inventory.netbox.agent_autostart¶
- Type:
boolean
- Default:
False
- main.inventory.netbox.token_env¶
- Type:
any
- Default:
None
- main.inventory.netbox.token¶
- Type:
any
- Default:
None
- main.inventory.netbox.url¶
- Type:
any
- Default:
None
- main.inventory_path¶
- Type:
any
- Default:
source:///connect-inventory.yaml