Skip to content

Commit

Permalink
docs(README): adding new config options to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@bl4ko
bl4ko committed Nov 29, 2024
1 parent d9e2fb8 commit 93f15c6
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,10 @@ Example configuration can be found [here](#example-config).

### Logger

| Parameter | Description | Type | Possible values | Default | Required |
| -------------- | ------------------------------------------------------ | ---- | --------------- | ------- | -------- |
| `logger.level` | Log level | int/string | [0-3] or [debug,info,warn,error] | 1,info | No |
| `logger.dest` | Log output filename. Default `""` representing stdout. | str | Any valid path | "" | No |
| Parameter | Description | Type | Possible values | Default | Required |
| -------------- | ------------------------------------------------------ | ---------- | -------------------------------- | ------- | -------- |
| `logger.level` | Log level | int/string | [0-3] or [debug,info,warn,error] | 1,info | No |
| `logger.dest` | Log output filename. Default `""` representing stdout. | str | Any valid path | "" | No |

### Netbox

Expand All @@ -62,7 +62,7 @@ Example configuration can be found [here](#example-config).
| `netbox.validateCert` | Validate the TLS certificate of your netbox instance. | bool | [true, false] | false | No |
| `netbox.timeout` | Max timeout for api call of your netbox instance. | int | >=0 | 30 | No |
| `netbox.removeOrphans` | If set to **true** all objects, marked with netbox-ssot tag that were not found during this iteration are automatically deleted. If set to **false**, objects that were not found are marked with an **Orphan** tag. We can then use **netbox.removeOrphansAfterDays** to remove the orphans after n days that they were not seen on the sources. | bool | [true, false] | true | No |
| `netbox.removeOrphansAfterDays` | Specifies the number of days to wait before automatically deleting objects marked as Orphan. This setting is only applicable if netbox.removeOrphans is set to false. A value of 5 means objects are deleted in five days after being marked as Orphan and not found since. | int | >0 | MaxInt | No |
| `netbox.removeOrphansAfterDays` | Specifies the number of days to wait before automatically deleting objects marked as Orphan. This setting is only applicable if netbox.removeOrphans is set to false. A value of 5 means objects are deleted in five days after being marked as Orphan and not found since. | int | >0 | MaxInt | No |
| `netbox.tag` | Tag to be applied to all objects managed by netbox-ssot. | string | any | "netbox-ssot" | No |
| `netbox.tagColor` | TagColor for the netbox-ssot tag. | string | any | "07426b" | No |
| `netbox.sourcePriority` | Array of source names in order of priority. If an object (e.g. Vlan) is found in multiple sources, the first source in the list will be used. | []string | any | [] | No |
Expand All @@ -83,14 +83,19 @@ Example configuration can be found [here](#example-config).
| `source.validateCert` | Enforce TLS certificate validation. | all | bool | [true, false] | false | No |
| `source.tagColor` | TagColor for the source tag. | all | string | any | Predefined | No |
| `source.ignoredSubnets` | List of subnets, which will be ignored (e.g. IPs won't be synced). | all | []string | any | [] | No |
| `source.permittedSubnets` | List of subnets, which will be permitted (e.g. only IPs in these subnets will be synced). | all | []string | any | [] | No |
| `source.interfaceFilter` | Regex representation of interface names to be ignored (e.g. `(cali\|vxlan\|flannel\|[a-f0-9]{15})`) | all | string | any | [] | No |
| `source.collectArpData` | Collect data from the arp table of the device. | [**paloalto**, **ios-xe**] | bool | [true, false] | false | No |
| `source.datacenterClusterGroupRelations` | Regex relations in format `regex = clusterGroupName`, that map each datacenter that satisfies regex to clusterGroupname (see [#130](https://github.com/bl4ko/netbox-ssot/issues/130)). | [**vmware**, **ovirt**] | []string | any | [] | No |
| `source.hostSiteRelations` | Regex relations in format `regex = siteName`, that map each host that satisfies regex to site. | all | []string | any | [] | No |
| `source.clusterSiteRelations` | Regex relations in format `regex = siteName`, that map each cluster that satisfies regex to site. | all | []string | any | [] | No |
| `source.clusterTenantRelations` | Regex relations in format `regex = tenantName`, that map each cluster that satisfies regex to tenant. | all | []string | any | [] | No |
| `source.hostTenantRelations` | Regex relations in format `regex = tenantName`, that map each host that satisfies regex to tenant. | all | []string | any | [] | No |
| `source.hostRoleRelations` | Regex relations in format `regex = roleName`, that map each host that satisfies regex to device role. | all | []string | any | [] | No |
| `source.hostTenantRelations` | Regex relations in format `regex = tenantName`, that map each host that satisfies regex to tenant. | all | []string | any | [] | No |
| `source.vmTenantRelations` | Regex relations in format `regex = tenantName`, that map each vm that satisfies regex to tenant. | all | []string | any | [] | No |
| `source.vmTenantRelations` | Regex relations in format `regex = tenantName`, that map each vm that satisfies regex to tenant. | all | []string | any | [] | No |
| `source.vmRoleRelations` | Regex relations in format `regex = roleName`, that map each vm that satisfies regex to device role. | all | []string | any | [] | No |
| `source.vlanGroupRelations` | Regex relations in format `regex = vlanGroup`, that map each vlan that satisfies regex to vlanGroup. | all | []string | any | [] | No |
| `source.vlanTenantRelations` | Regex relations in format `regex = tenantName`, that map each vlan that satisfies regex to tenant. | all | []string | any | [] | No |
| `source.wlanTenantRelations` | Regex relations in format `regex = tenantName`, that map each wlan that satisfies regex to tenant. | [dnac] | []string | any | [] | No |
Expand Down

0 comments on commit 93f15c6

Please sign in to comment.