Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
121 changes: 80 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ sonic-confidb-utils generate

## Configuration Parameters

**bgp_ports**
### bgp_ports

Example:

Expand All @@ -38,7 +38,7 @@ Result:
}
```

**breakouts**
### breakouts

Example:

Expand All @@ -65,7 +65,7 @@ Result:

For each breakout also the correspondig ports entries are added.

**docker_routing_config_mode**
### docker_routing_config_mode

Can be one of `separated`, `split`, `split-unified`, `unified`.

Expand All @@ -87,7 +87,7 @@ Result:
}
```

**features**
### features

Enabling a feature makes SONiC check the status of the corresponding container.
If a feature is enabled and the container stops running `container_checker` will complain and `show system-health summary` will show
Expand Down Expand Up @@ -121,7 +121,7 @@ Result:
}
```

**frr_mgmt_framework_config**
### frr_mgmt_framework_config

Example:

Expand All @@ -141,7 +141,7 @@ Result:
}
```

**interconnects**
### interconnects

Example:

Expand Down Expand Up @@ -172,7 +172,7 @@ Result:
}
```

**lldp_hello_time**
### lldp_hello_time

Example:

Expand All @@ -192,7 +192,7 @@ Result:
}
```

**looback_address**
### looback_address

Example:

Expand All @@ -211,19 +211,7 @@ Result:
}
```

and

```json
{
"VXLAN_TUNNEL": {
"vtep": {
"src_ip": "10.7.7.7"
}
}
}
```

**mclag**
### mclag

Example:

Expand Down Expand Up @@ -267,7 +255,7 @@ Result:
}
```

**mgmt_interface**
### mgmt_interface

Example:

Expand All @@ -289,7 +277,7 @@ Result:
}
```

**mgmt_vrf**
### mgmt_vrf

Example:

Expand All @@ -309,7 +297,7 @@ Result:
}
```

**nameservers**
### nameservers

Example:

Expand All @@ -330,22 +318,31 @@ Result:
}
```

**ntpservers**
### ntp

Example:

```yaml
ntpservers:
- 0.europe.pool.ntp.org
- 1.europe.pool.ntp.org
- 2.europe.pool.ntp.org
- 3.europe.pool.ntp.org
ntp:
src_interface: Loopback0
vrf: default
servers:
- 0.europe.pool.ntp.org
- 1.europe.pool.ntp.org
- 2.europe.pool.ntp.org
- 3.europe.pool.ntp.org
```

Result:

```json
{
"NTP": {
"global": {
"src_intf": "Loopback0",
"vrf": "default"
}
},
"NTP_SERVER": {
"0.europe.pool.ntp.org": {},
"1.europe.pool.ntp.org": {},
Expand All @@ -355,15 +352,15 @@ Result:
}
```

**portchannels**
### portchannels

Example:

```yaml
portchannels:
default_mtu: 9000
list:
- number: "01"
- number: 01
mtu: 1500
fallback: true
members:
Expand Down Expand Up @@ -393,7 +390,7 @@ Result:
}
```

**ports**
### ports

Example:

Expand All @@ -404,6 +401,7 @@ breakouts:
ports:
default_fec: none
default_mtu: 9000
default_autoneg: on
list:
- name: Ethernet0
ips:
Expand All @@ -421,7 +419,7 @@ Result:
"Ethernet0": {
"admin_status": "up",
"alias": "Eth1/1(Port1)",
"autoneg": "off",
"autoneg": "on",
"fec": "rs",
"index": "1",
"lanes": "1",
Expand All @@ -446,9 +444,9 @@ and
```

The speed of a port is determined by its breakout configuration.
If no breakout configuration for a port is passed its default breakout is assumed.
If a breakout configuration allows more than one speed options, e.g. `1x100G[40G]`, the first speed option is used as a default (`100G` in the example case).
A `speed` option can be passed to the port config to specify an alternative speed, e.g.
If no breakout configuration for a port is provided its default breakout is assumed.
If a breakout configuration allows more than one speed options, e.g. `1x100G[40G]`, the first speed option is used as a default (`100G` in the example).
A `speed` option can be added to the port config to specify an alternative speed, e.g.

```yaml
ports:
Expand All @@ -458,7 +456,7 @@ ports:

For each port that is not explicitly configured in `breakouts` and `ports` an entry with defaults will be added to the `"PORT"` dictionary.

**sag**
### sag

Example:

Expand All @@ -479,7 +477,7 @@ Result:
}
```

**ssh_sourceranges**
### ssh_sourceranges

Example:

Expand All @@ -493,16 +491,45 @@ Result:
```json
{
"ACL_RULE": {
"ALLOW_NTP|DEFAULT_RULE": {
"ETHER_TYPE": "2048",
"PACKET_ACTION": "DROP",
"PRIORITY": "1"
},
"ALLOW_NTP|RULE_1": {
"PACKET_ACTION": "ACCEPT",
"PRIORITY": "99",
"SRC_IP": "0.0.0.0/0"
},
"ALLOW_SSH|DEFAULT_RULE": {
"ETHER_TYPE": "2048",
"PACKET_ACTION": "DROP",
"PRIORITY": "1"
},
"ALLOW_SSH|RULE_1": {
"PACKET_ACTION": "ACCEPT",
"PRIORITY": "91",
"SRC_IP": "10.1.23.1/30"
}
},
"ACL_TABLE": {
"ALLOW_NTP": {
"policy_desc": "Allow NTP",
"services": ["NTP"],
"stage": "ingress",
"type": "CTRLPLANE"
},
"ALLOW_SSH": {
"policy_desc": "Allow SSH access",
"services": ["SSH"],
"stage": "ingress",
"type": "CTRLPLANE"
}
}
}
```

**vlans** and **vlan_members**
### vlans and vlan_members

Example:

Expand Down Expand Up @@ -551,11 +578,13 @@ Result:
}
```

**vteps**
### vteps

Example:

```yaml
loopback_address: 10.7.7.7

vteps:
- vni: 103999
vlan: Vlan3999
Expand All @@ -565,6 +594,16 @@ Result:

```json
{
"VXLAN_EVPN_NVO": {
"nvo": {
"source_vtep": "vtep"
}
},
"VXLAN_TUNNEL": {
"vtep": {
"src_ip": "10.7.7.7"
}
},
"VXLAN_TUNNEL_MAP": {
"vtep|map_103999_Vlan3999": {
"vlan": "Vlan3999",
Expand Down
Loading