Merge branch 'feature' into 8366-job-scheduling

2025-12-18 11:22:25 -06:00 · 2022-10-20 17:03:57 -04:00
parent 4f95c5a72c bd79a27e4d
commit 893925436d
100 changed files with 3032 additions and 2797 deletions
--- a/docs/installation/6-ldap.md
+++ b/docs/installation/6-ldap.md
@@ -46,7 +46,7 @@ Next, create a file in the same directory as `configuration.py` (typically `/opt
 ### General Server Configuration

 !!! info
-    When using Windows Server 2012 you may need to specify a port on `AUTH_LDAP_SERVER_URI`. Use `3269` for secure, or `3268` for non-secure.
+    When using Active Directory you may need to specify a port on `AUTH_LDAP_SERVER_URI` to authenticate users from all domains in the forest. Use `3269` for secure, or `3268` for non-secure access to the GC (Global Catalog).

 ```python
 import ldap
@@ -67,6 +67,16 @@ AUTH_LDAP_BIND_PASSWORD = "demo"
 # Note that this is a NetBox-specific setting which sets:
 #     ldap.set_option(ldap.OPT_X_TLS_REQUIRE_CERT, ldap.OPT_X_TLS_NEVER)
 LDAP_IGNORE_CERT_ERRORS = True
+
+# Include this setting if you want to validate the LDAP server certificates against a CA certificate directory on your server
+# Note that this is a NetBox-specific setting which sets:
+#     ldap.set_option(ldap.OPT_X_TLS_CACERTDIR, LDAP_CA_CERT_DIR)
+LDAP_CA_CERT_DIR = '/etc/ssl/certs'
+
+# Include this setting if you want to validate the LDAP server certificates against your own CA.
+# Note that this is a NetBox-specific setting which sets:
+#     ldap.set_option(ldap.OPT_X_TLS_CACERTFILE, LDAP_CA_CERT_FILE)
+LDAP_CA_CERT_FILE = '/path/to/example-CA.crt'
 ```

 STARTTLS can be configured by setting `AUTH_LDAP_START_TLS = True` and using the `ldap://` URI scheme.
--- a/docs/integrations/graphql-api.md
+++ b/docs/integrations/graphql-api.md
@@ -47,7 +47,7 @@ NetBox provides both a singular and plural query field for each object type:

 For example, query `device(id:123)` to fetch a specific device (identified by its unique ID), and query `device_list` (with an optional set of filters) to fetch all devices.

-For more detail on constructing GraphQL queries, see the [Graphene documentation](https://docs.graphene-python.org/en/latest/).
+For more detail on constructing GraphQL queries, see the [Graphene documentation](https://docs.graphene-python.org/en/latest/) as well as the [GraphQL queries documentation](https://graphql.org/learn/queries/).

 ## Filtering

@@ -56,6 +56,47 @@ The GraphQL API employs the same filtering logic as the UI and REST API. Filters
 ```
 {"query": "query {site_list(region:\"north-carolina\", status:\"active\") {name}}"}
 ```
+In addition, filtering can be done on list of related objects as shown in the following query:
+
+```
+{
+  device_list {
+    id
+    name
+    interfaces(enabled: true) {
+      name
+    }
+  }
+}
+```
+
+## Multiple Return Types
+
+Certain queries can return multiple types of objects, for example cable terminations can return circuit terminations, console ports and many others.  These can be queried using [inline fragments](https://graphql.org/learn/schema/#union-types) as shown below:
+
+```
+{
+    cable_list {
+      id
+      a_terminations {
+        ... on CircuitTerminationType {
+          id
+          class_type
+        }
+        ... on ConsolePortType {
+          id
+          class_type
+        }
+        ... on ConsoleServerPortType {
+          id
+          class_type
+        }
+      }
+    }
+}
+
+```
+The field "class_type" is an easy way to distinguish what type of object it is when viewing the returned data, or when filtering.  It contains the class name, for example "CircuitTermination" or "ConsoleServerPort".

 ## Authentication

--- a/docs/plugins/development/forms.md
+++ b/docs/plugins/development/forms.md
@@ -144,73 +144,73 @@ class MyModelFilterForm(NetBoxModelFilterSetForm):
 In addition to the [form fields provided by Django](https://docs.djangoproject.com/en/stable/ref/forms/fields/), NetBox provides several field classes for use within forms to handle specific types of data. These can be imported from `utilities.forms.fields` and are documented below.

 ::: utilities.forms.ColorField
-    selection:
+    options:
      members: false

 ::: utilities.forms.CommentField
-    selection:
+    options:
      members: false

 ::: utilities.forms.JSONField
-    selection:
+    options:
      members: false

 ::: utilities.forms.MACAddressField
-    selection:
+    options:
      members: false

 ::: utilities.forms.SlugField
-    selection:
+    options:
      members: false

 ## Choice Fields

 ::: utilities.forms.ChoiceField
-    selection:
+    options:
      members: false

 ::: utilities.forms.MultipleChoiceField
-    selection:
+    options:
      members: false

 ## Dynamic Object Fields

 ::: utilities.forms.DynamicModelChoiceField
-    selection:
+    options:
      members: false

 ::: utilities.forms.DynamicModelMultipleChoiceField
-    selection:
+    options:
      members: false

 ## Content Type Fields

 ::: utilities.forms.ContentTypeChoiceField
-    selection:
+    options:
      members: false

 ::: utilities.forms.ContentTypeMultipleChoiceField
-    selection:
+    options:
      members: false

 ## CSV Import Fields

 ::: utilities.forms.CSVChoiceField
-    selection:
+    options:
      members: false

 ::: utilities.forms.CSVMultipleChoiceField
-    selection:
+    options:
      members: false

 ::: utilities.forms.CSVModelChoiceField
-    selection:
+    options:
      members: false

 ::: utilities.forms.CSVContentTypeField
-    selection:
+    options:
      members: false

 ::: utilities.forms.CSVMultipleContentTypeField
-    selection:
+    options:
      members: false
--- a/docs/plugins/development/graphql-api.md
+++ b/docs/plugins/development/graphql-api.md
@@ -32,11 +32,11 @@ schema = MyQuery
 NetBox provides two object type classes for use by plugins.

 ::: netbox.graphql.types.BaseObjectType
-    selection:
+    options:
      members: false

 ::: netbox.graphql.types.NetBoxObjectType
-    selection:
+    options:
      members: false

 ## GraphQL Fields
@@ -44,9 +44,9 @@ NetBox provides two object type classes for use by plugins.
 NetBox provides two field classes for use by plugins.

 ::: netbox.graphql.fields.ObjectField
-    selection:
+    options:
      members: false

 ::: netbox.graphql.fields.ObjectListField
-    selection:
+    options:
      members: false
--- a/docs/plugins/development/index.md
+++ b/docs/plugins/development/index.md
@@ -108,6 +108,7 @@ NetBox looks for the `config` variable within a plugin's `__init__.py` to load i
 | `max_version`         | Maximum version of NetBox with which the plugin is compatible                                                            |
 | `middleware`          | A list of middleware classes to append after NetBox's build-in middleware                                                |
 | `queues`              | A list of custom background task queues to create                                                                        |
+| `search_extensions`   | The dotted path to the list of search index classes (default: `search.indexes`)                                          |
 | `template_extensions` | The dotted path to the list of template extension classes (default: `template_content.template_extensions`)              |
 | `menu_items`          | The dotted path to the list of menu items provided by the plugin (default: `navigation.menu_items`)                      |
 | `graphql_schema`      | The dotted path to the plugin's GraphQL schema class, if any (default: `graphql.schema`)                                 |
--- a/docs/plugins/development/search.md
+++ b/docs/plugins/development/search.md
@@ -0,0 +1,29 @@
+# Search
+
+Plugins can define and register their own models to extend NetBox's core search functionality. Typically, a plugin will include a file named `search.py`, which holds all search indexes for its models (see the example below).
+
+```python
+# search.py
+from netbox.search import SearchMixin
+from .filters import MyModelFilterSet
+from .tables import MyModelTable
+from .models import MyModel
+
+class MyModelIndex(SearchMixin):
+    model = MyModel
+    queryset = MyModel.objects.all()
+    filterset = MyModelFilterSet
+    table = MyModelTable
+    url = 'plugins:myplugin:mymodel_list'
+```
+
+To register one or more indexes with NetBox, define a list named `indexes` at the end of this file:
+
+```python
+indexes = [MyModelIndex]
+```
+
+!!! tip
+    The path to the list of search indexes can be modified by setting `search_indexes` in the PluginConfig instance.
+
+::: netbox.search.SearchIndex
--- a/docs/plugins/development/tables.md
+++ b/docs/plugins/development/tables.md
@@ -52,38 +52,38 @@ This will automatically apply any user-specific preferences for the table. (If u
 The table column classes listed below are supported for use in plugins. These classes can be imported from `netbox.tables.columns`.

 ::: netbox.tables.BooleanColumn
-    selection:
+    options:
      members: false

 ::: netbox.tables.ChoiceFieldColumn
-    selection:
+    options:
      members: false

 ::: netbox.tables.ColorColumn
-    selection:
+    options:
      members: false

 ::: netbox.tables.ColoredLabelColumn
-    selection:
+    options:
      members: false

 ::: netbox.tables.ContentTypeColumn
-    selection:
+    options:
      members: false

 ::: netbox.tables.ContentTypesColumn
-    selection:
+    options:
      members: false

 ::: netbox.tables.MarkdownColumn
-    selection:
+    options:
      members: false

 ::: netbox.tables.TagColumn
-    selection:
+    options:
      members: false

 ::: netbox.tables.TemplateColumn
-    selection:
+    options:
      members:
        - __init__
--- a/docs/plugins/development/views.md
+++ b/docs/plugins/development/views.md
@@ -84,24 +84,24 @@ Below are the class definitions for NetBox's object views. These views handle CR
 ::: netbox.views.generic.base.BaseObjectView

 ::: netbox.views.generic.ObjectView
-    selection:
+    options:
      members:
        - get_object
        - get_template_name

 ::: netbox.views.generic.ObjectEditView
-    selection:
+    options:
      members:
        - get_object
        - alter_object

 ::: netbox.views.generic.ObjectDeleteView
-    selection:
+    options:
      members:
        - get_object

 ::: netbox.views.generic.ObjectChildrenView
-    selection:
+    options:
      members:
        - get_children
        - prep_table_data
@@ -113,22 +113,22 @@ Below are the class definitions for NetBox's multi-object views. These views han
 ::: netbox.views.generic.base.BaseMultiObjectView

 ::: netbox.views.generic.ObjectListView
-    selection:
+    options:
      members:
        - get_table
        - export_table
        - export_template

 ::: netbox.views.generic.BulkImportView
-    selection:
+    options:
      members: false

 ::: netbox.views.generic.BulkEditView
-    selection:
+    options:
      members: false

 ::: netbox.views.generic.BulkDeleteView
-    selection:
+    options:
      members:
        - get_form

@@ -137,12 +137,12 @@ Below are the class definitions for NetBox's multi-object views. These views han
 These views are provided to enable or enhance certain NetBox model features, such as change logging or journaling. These typically do not need to be subclassed: They can be used directly e.g. in a URL path.

 ::: netbox.views.generic.ObjectChangeLogView
-    selection:
+    options:
      members:
        - get_form

 ::: netbox.views.generic.ObjectJournalView
-    selection:
+    options:
      members:
        - get_form

--- a/docs/release-notes/version-3.3.md
+++ b/docs/release-notes/version-3.3.md
@@ -2,6 +2,21 @@

 ## v3.3.6 (FUTURE)

+### Enhancements
+
+* [#9722](https://github.com/netbox-community/netbox/issues/9722) - Add LDAP configuration parameters to specify certificates
+* [#10685](https://github.com/netbox-community/netbox/issues/10685) - Position A/Z termination cards above the fold under circuit view
+
+### Bug Fixes
+
+* [#9669](https://github.com/netbox-community/netbox/issues/9669) - Strip colons from usernames when using remote authentication
+* [#10575](https://github.com/netbox-community/netbox/issues/10575) - Include OIDC dependencies for python-social-auth
+* [#10584](https://github.com/netbox-community/netbox/issues/10584) - Fix service clone link
+* [#10643](https://github.com/netbox-community/netbox/issues/10643) - Ensure consistent display of custom fields for all model forms
+* [#10646](https://github.com/netbox-community/netbox/issues/10646) - Fix filtering of power feed by power panel when connecting a cable
+* [#10655](https://github.com/netbox-community/netbox/issues/10655) - Correct display of assigned contacts in object tables
+* [#10712](https://github.com/netbox-community/netbox/issues/10712) - Fix ModuleNotFoundError exception when generating API schema under Python 3.9+
+
 ---

 ## v3.3.5 (2022-10-05)
--- a/docs/release-notes/version-3.4.md
+++ b/docs/release-notes/version-3.4.md
@@ -17,15 +17,19 @@ A new `PluginMenu` class has been introduced, which enables a plugin to inject a

 ### Enhancements

+* [#8245](https://github.com/netbox-community/netbox/issues/8245) - Enable GraphQL filtering of related objects
 * [#9249](https://github.com/netbox-community/netbox/issues/9249) - Device and virtual machine names are no longer case-sensitive
 * [#9478](https://github.com/netbox-community/netbox/issues/9478) - Add `link_peers` field to GraphQL types for cabled objects
 * [#9654](https://github.com/netbox-community/netbox/issues/9654) - Add `weight` field to racks, device types, and module types
+* [#9817](https://github.com/netbox-community/netbox/issues/9817) - Add `assigned_object` field to GraphQL type for IP addresses and L2VPN terminations
 * [#9892](https://github.com/netbox-community/netbox/issues/9892) - Add optional `name` field for FHRP groups
 * [#10348](https://github.com/netbox-community/netbox/issues/10348) - Add decimal custom field type
 * [#10556](https://github.com/netbox-community/netbox/issues/10556) - Include a `display` field in all GraphQL object types
+* [#10595](https://github.com/netbox-community/netbox/issues/10595) - Add GraphQL relationships for additional generic foreign key fields

 ### Plugins API

+* [#8927](https://github.com/netbox-community/netbox/issues/8927) - Enable inclusion of plugin models in global search via `SearchIndex`
 * [#9071](https://github.com/netbox-community/netbox/issues/9071) - Introduce `PluginMenu` for top-level plugin navigation menus
 * [#9072](https://github.com/netbox-community/netbox/issues/9072) - Enable registration of tabbed plugin views for core NetBox models
 * [#9880](https://github.com/netbox-community/netbox/issues/9880) - Introduce `django_apps` plugin configuration parameter
@@ -36,6 +40,7 @@ A new `PluginMenu` class has been introduced, which enables a plugin to inject a
 * [#9045](https://github.com/netbox-community/netbox/issues/9045) - Remove legacy ASN field from provider model
 * [#9046](https://github.com/netbox-community/netbox/issues/9046) - Remove legacy contact fields from provider model
 * [#10358](https://github.com/netbox-community/netbox/issues/10358) - Raise minimum required PostgreSQL version from 10 to 11
+* [#10699](https://github.com/netbox-community/netbox/issues/10699) - Remove custom `import_object()` function

 ### REST API Changes

@@ -54,3 +59,20 @@ A new `PluginMenu` class has been introduced, which enables a plugin to inject a

 * All object types now include a `display` field
 * All cabled object types now include a `link_peers` field
+* Add a `contacts` relationship for all relevant models
+* dcim.Cable
+    * Add A/B terminations fields
+* dcim.CableTermination
+    * Add `termination` field
+* dcim.InventoryItem
+    * Add `component` field
+* dcim.InventoryItemTemplate
+    * Add `component` field
+* ipam.FHRPGroupAssignment
+    * Add `interface` field
+* ipam.IPAddress
+    * Add `assigned_object` field
+* ipam.L2VPNTermination
+    * Add `assigned_object` field
+* ipam.VLANGroupType
+    * Add `scope` field