Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: status is now split #13

Merged
merged 1 commit into from
Mar 28, 2024
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
4 changes: 3 additions & 1 deletion docs/docs/CMDB/models/BGP.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ The main idea is to have a `BGPSession` linked to two `DeviceBGPSession` to avoi

```yaml
BGPSession:
status: boolean
state: string choice
monitoring_state: string choice
peer_a: cmdb.DeviceBGPSession
peer_b: cmdb.DeviceBGPSession
password: string
Expand All @@ -65,6 +66,7 @@ BGPSession:
```yaml
DeviceBGPSession:
device: dcim.Device
enabled: boolean
description: string
local_address: netbox.ipam.IPAddress
remote_asn: cmdb.ASN
Expand Down
8 changes: 4 additions & 4 deletions docs/docs/CMDB/models/Routing-Policies.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@ erDiagram
PrefixList:
name: string
device: dcim.Device
ip_version: string choices
ip_version: string choice
```

```yaml
PrefixListTerm:
prefix_list: cmdb.PrefixList
sequence: integer
decision: string choices
decision: string choice
prefix: IPNetwork
le: integer
ge: integer
Expand All @@ -55,7 +55,7 @@ BGPCommunityList:
BGPCommunityListTerm:
bgp_community_list: cmdb.BGPCommunityList
sequence: integer
decision: string choices
decision: string choice
community: string
```

Expand All @@ -73,7 +73,7 @@ RoutePolicyTerm:
route_policy: cmdb.RoutePolicy
description: string
sequence: integer
decision: string choices
decision: string choice

# match
from_bgp_community: string
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ For instance, we represent the BGP session itself with two joined tables describ
`DeviceBGPSession` <==> `BGPSession` <==> `DeviceBGPSession`

* `DeviceBGPSession` contains the `local-as` but not the `peer-as`, avoiding data duplication. The `peer-as` being the `local-as` of the other neighbor.
* `BGPSession` contains all information peers have in common, like status (`in production`, `maintenance` etc...) or `MD5 password`.
* `BGPSession` contains all information peers have in common, like state (`in production`, `maintenance` etc...) or `MD5 password`.

### Data Aggregation API

Expand Down
Loading