Skip to content

Commit c3a6f5d

Browse files
authored
docs: status is now split (#13)
New fields: - state - monitoring_state - enabled
1 parent 49ca152 commit c3a6f5d

File tree

3 files changed

+8
-6
lines changed

3 files changed

+8
-6
lines changed

docs/docs/CMDB/models/BGP.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,8 @@ The main idea is to have a `BGPSession` linked to two `DeviceBGPSession` to avoi
5454

5555
```yaml
5656
BGPSession:
57-
status: boolean
57+
state: string choice
58+
monitoring_state: string choice
5859
peer_a: cmdb.DeviceBGPSession
5960
peer_b: cmdb.DeviceBGPSession
6061
password: string
@@ -65,6 +66,7 @@ BGPSession:
6566
```yaml
6667
DeviceBGPSession:
6768
device: dcim.Device
69+
enabled: boolean
6870
description: string
6971
local_address: netbox.ipam.IPAddress
7072
remote_asn: cmdb.ASN

docs/docs/CMDB/models/Routing-Policies.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ erDiagram
2828
PrefixList:
2929
name: string
3030
device: dcim.Device
31-
ip_version: string choices
31+
ip_version: string choice
3232
```
3333
3434
```yaml
3535
PrefixListTerm:
3636
prefix_list: cmdb.PrefixList
3737
sequence: integer
38-
decision: string choices
38+
decision: string choice
3939
prefix: IPNetwork
4040
le: integer
4141
ge: integer
@@ -55,7 +55,7 @@ BGPCommunityList:
5555
BGPCommunityListTerm:
5656
bgp_community_list: cmdb.BGPCommunityList
5757
sequence: integer
58-
decision: string choices
58+
decision: string choice
5959
community: string
6060
```
6161
@@ -73,7 +73,7 @@ RoutePolicyTerm:
7373
route_policy: cmdb.RoutePolicy
7474
description: string
7575
sequence: integer
76-
decision: string choices
76+
decision: string choice
7777

7878
# match
7979
from_bgp_community: string

docs/docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ For instance, we represent the BGP session itself with two joined tables describ
6060
`DeviceBGPSession` <==> `BGPSession` <==> `DeviceBGPSession`
6161

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

6565
### Data Aggregation API
6666

0 commit comments

Comments
 (0)