Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fbreckle committed Aug 8, 2024
1 parent 35de904 commit b3c353a
Show file tree
Hide file tree
Showing 7 changed files with 25 additions and 17 deletions.
5 changes: 4 additions & 1 deletion docs/data-sources/platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,13 @@ data "netbox_platform" "PANOS" {

- `name` (String)

### Optional

- `manufacturer_id` (Number)

### Read-Only

- `id` (String) The ID of this resource.
- `slug` (String)
- `manufacturer_id` (String)


20 changes: 11 additions & 9 deletions docs/data-sources/prefix.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,20 @@ description: |-

### Optional

- `cidr` (String, Deprecated) At least one of `description`, `family`, `prefix`, `vlan_vid`, `vrf_id`, `vlan_id`, `site_id`, `cidr` or `tag` must be given. Conflicts with `prefix`.
- `description` (String) Description to include in the data source filter. At least one of `description`, `family`, `prefix`, `vlan_vid`, `vrf_id`, `vlan_id`, `site_id`, `cidr` or `tag` must be given.
- `family` (Number) The IP family of the prefix. One of 4 or 6. At least one of `description`, `family`, `prefix`, `vlan_vid`, `vrf_id`, `vlan_id`, `site_id`, `cidr` or `tag` must be given.
- `prefix` (String) At least one of `description`, `family`, `prefix`, `vlan_vid`, `vrf_id`, `vlan_id`, `site_id`, `cidr` or `tag` must be given. Conflicts with `cidr`.
- `site_id` (Number) At least one of `description`, `family`, `prefix`, `vlan_vid`, `vrf_id`, `vlan_id`, `site_id`, `cidr` or `tag` must be given.
- `tag` (String) Tag to include in the data source filter (must match the tag's slug). At least one of `description`, `family`, `prefix`, `vlan_vid`, `vrf_id`, `vlan_id`, `site_id`, `cidr` or `tag` must be given.
- `cidr` (String, Deprecated) At least one of `description`, `family`, `prefix`, `vlan_vid`, `vrf_id`, `vlan_id`, `site_id`, `role_id`, `cidr` or `tag` must be given. Conflicts with `prefix`.
- `custom_fields` (Map of String)
- `description` (String) Description to include in the data source filter. At least one of `description`, `family`, `prefix`, `vlan_vid`, `vrf_id`, `vlan_id`, `site_id`, `role_id`, `cidr` or `tag` must be given.
- `family` (Number) The IP family of the prefix. One of 4 or 6. At least one of `description`, `family`, `prefix`, `vlan_vid`, `vrf_id`, `vlan_id`, `site_id`, `role_id`, `cidr` or `tag` must be given.
- `prefix` (String) At least one of `description`, `family`, `prefix`, `vlan_vid`, `vrf_id`, `vlan_id`, `site_id`, `role_id`, `cidr` or `tag` must be given. Conflicts with `cidr`.
- `role_id` (Number) At least one of `description`, `family`, `prefix`, `vlan_vid`, `vrf_id`, `vlan_id`, `site_id`, `role_id`, `cidr` or `tag` must be given.
- `site_id` (Number) At least one of `description`, `family`, `prefix`, `vlan_vid`, `vrf_id`, `vlan_id`, `site_id`, `role_id`, `cidr` or `tag` must be given.
- `tag` (String) Tag to include in the data source filter (must match the tag's slug). At least one of `description`, `family`, `prefix`, `vlan_vid`, `vrf_id`, `vlan_id`, `site_id`, `role_id`, `cidr` or `tag` must be given.
- `tag__n` (String) Tag to exclude from the data source filter (must match the tag's slug).
Refer to [Netbox's documentation](https://demo.netbox.dev/static/docs/rest-api/filtering/#lookup-expressions)
for more information on available lookup expressions.
- `vlan_id` (Number) At least one of `description`, `family`, `prefix`, `vlan_vid`, `vrf_id`, `vlan_id`, `site_id`, `cidr` or `tag` must be given.
- `vlan_vid` (Number) At least one of `description`, `family`, `prefix`, `vlan_vid`, `vrf_id`, `vlan_id`, `site_id`, `cidr` or `tag` must be given.
- `vrf_id` (Number) At least one of `description`, `family`, `prefix`, `vlan_vid`, `vrf_id`, `vlan_id`, `site_id`, `cidr` or `tag` must be given.
- `vlan_id` (Number) At least one of `description`, `family`, `prefix`, `vlan_vid`, `vrf_id`, `vlan_id`, `site_id`, `role_id`, `cidr` or `tag` must be given.
- `vlan_vid` (Number) At least one of `description`, `family`, `prefix`, `vlan_vid`, `vrf_id`, `vlan_id`, `site_id`, `role_id`, `cidr` or `tag` must be given.
- `vrf_id` (Number) At least one of `description`, `family`, `prefix`, `vlan_vid`, `vrf_id`, `vlan_id`, `site_id`, `role_id`, `cidr` or `tag` must be given.

### Read-Only

Expand Down
3 changes: 2 additions & 1 deletion docs/data-sources/prefixes.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ description: |-

Required:

- `name` (String) The name of the field to filter on. Supported fields are: `prefix`, `vlan_vid`, `vrf_id`, `vlan_id`, `status`, `site_id`, & `tag`.
- `name` (String) The name of the field to filter on. Supported fields are: `prefix`, `contains`, `vlan_vid`, `vrf_id`, `vlan_id`, `status`, `site_id`, & `tag`.
- `value` (String) The value to pass to the specified filter.


Expand All @@ -42,6 +42,7 @@ Read-Only:
- `description` (String)
- `id` (Number)
- `prefix` (String)
- `site_id` (Number)
- `status` (String)
- `tags` (Set of String)
- `vlan_id` (Number)
Expand Down
1 change: 1 addition & 0 deletions docs/data-sources/vlans.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ Read-Only:
- `role` (Number)
- `site` (Number)
- `status` (String)
- `tag_ids` (List of Number)
- `tenant` (Number)
- `vid` (Number)

Expand Down
10 changes: 5 additions & 5 deletions docs/resources/config_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,16 @@ From the [official documentation](https://docs.netbox.dev/en/stable/models/extra

> Configuration templates can be used to render device configurations from context data. Templates are written in the Jinja2 language and can be associated with devices roles, platforms, and/or individual devices.
Context data is made available to devices and/or virtual machines based on their relationships to other objects in NetBox. For example, context data can be associated only with devices assigned to a particular site, or only to virtual machines in a certain cluster.
> Context data is made available to devices and/or virtual machines based on their relationships to other objects in NetBox. For example, context data can be associated only with devices assigned to a particular site, or only to virtual machines in a certain cluster.
## Example Usage

```terraform
resource "netbox_config_template" "test" {
name = "test"
description = "test description"
template_code = "hostname {{ name }}"
environment_params = jsonencode({"name" = "my-hostname"})
name = "test"
description = "test description"
template_code = "hostname {{ name }}"
environment_params = jsonencode({ "name" = "my-hostname" })
}
```

Expand Down
1 change: 1 addition & 0 deletions docs/resources/device_interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ resource "netbox_device_interface" "test" {

- `description` (String)
- `enabled` (Boolean) Defaults to `true`.
- `label` (String)
- `lag_device_interface_id` (Number) If this device is a member of a LAG group, you can reference the LAG interface here.
- `mac_address` (String)
- `mgmtonly` (Boolean)
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ resource "netbox_platform" "PANOS" {

### Optional

- `manufacturer_id` (Number)
- `slug` (String)
- `manufacturer_id` (String)

### Read-Only

Expand Down

0 comments on commit b3c353a

Please sign in to comment.