nautobot 2.0.0a2__py3-none-any.whl → 2.0.0b1__py3-none-any.whl

nautobot/docs/installation/migrating-from-netbox.md

@@ -69,28 +69,16 @@ The following backwards-incompatible changes have been made to the data model in
 
 ### Status Fields
 
-!!! tip
-    Status names are now lower-cased when setting the `status` field on CSV imports. The `slug` value is used for create/update of objects and for filtering in the API.
-
-A new [`Status`](../models/extras/status.md) model has been added to represent the `status` field for many models. Each status has a human-readable `name` field (e.g. `Active`), and a `slug` field (e.g. `active`).
+A new [`Status`](../models/extras/status.md) model has been added to represent the `status` field for many models. Each status has a human-readable `name` field (e.g. `Active`), a `color`, a `description`, and a set of `content_types` that it can be applied to (for example, `Device` and `Location`).
 
 ### Display name
 
 Several models such as device type and VLAN exposed a `display_name` property, which has now been renamed to `display`. In fact, there are several other instances, especially in the REST API, where the `display_name` field was used and as such, all instances have been renamed to `display`.
 
-#### CSV Imports
-
-When using CSV import to define a `status` field on imported objects, such as when importing Devices or Prefixes, the `Status.slug` field is used.
-
-For example, the built-in **Active** status has a slug of `active`, so the `active` value would be used for import.
-
 #### Default Choices
 
 Because `status` fields are now stored in the database, they cannot have a default value, just like other similar objects like Device Roles or Device Types. In cases where `status` was not required to be set because it would use the default value, you must now provide a `status` yourself.  
 
-!!! note
-    For consistency in the API, the `slug` value of a `status` is used when creating or updating an object.
-
 #### Choices in Code
 
 All `*StatusChoices` enums used for populated `status` field choices (such as `nautobot.dcim.choices.DeviceStatusChoices`) are deprecated. Any code you have that is leveraging these will now result in an error when performing lookups on objects with `status` fields.
@@ -110,7 +98,7 @@ Update it to this:
 from nautobot.extras.models import Status
 from nautobot.dcim.models import Device
 
-Device.objects.filter(status=Status.objects.get(slug="planned"))
+Device.objects.filter(status=Status.objects.get(name="Planned"))
 ```
 
 ### UUID Primary Database Keys
@@ -145,10 +133,10 @@ All IPAM objects with network field types (`ipam.IPAddress`, and `ipam.Prefix`)
 
 Below is a summary of the underlying technical changes to network fields. These will be explained in more detail in the following sections.
 
-- For `IPAddress`, the `address` field was exploded out to `host`, `broadcast`, and `prefix_length` fields; `address` was converted into a computed field.
+- For `IPAddress`, the `address` field was exploded out to `host` and `mask_length` fields; `address` was converted into a computed field.
 - For `Prefix` objects, the `prefix` field was exploded out to `network`, `broadcast`, and `prefix_length` fields; `prefix` was converted into a computed field.
 - The `host`, `network`, and `broadcast` fields are now of a `varbinary` database type, which is represented as a packed binary integer (for example, the host `1.1.1.1` is packed as `b"\x01\x01\x01\x01"`)
-- Network membership queries are accomplished by triangulating the "position" of an address using the IP, broadcast, and prefix length of the source and target addresses.
+- Network membership queries are accomplished by triangulating the "position" of an address using the `host` of the `IPAddress` and the `network` and `broadcast` of the `Prefix`.
 
 !!! note
     You should never have to worry about the binary nature of how the network fields are stored in the database! The Django database ORM takes care of it all!
@@ -159,7 +147,7 @@ The following fields have changed when working with `ipam.IPAddress` objects:
 
 ##### `address` is now a computed field
 
-This field is computed from `{host}/{prefix_length}` and is represented as a `netaddr.IPNetwork` object.
+This field is computed from `{host}/{mask_length}` and is represented as a `netaddr.IPNetwork` object.
 
 ```python
 >>> ip = IPAddress(address="1.1.1.1/30")
@@ -185,7 +173,7 @@ IPNetwork('1.1.1.1/30')
 ```
 
 !!! note
-    If you use a `prefix_length` other than `/32` (IPv4) or `/128` (IPv6) it **must** be included in your lookups
+    If you use a `mask_length` other than `/32` (IPv4) or `/128` (IPv6) it **must** be included in your lookups
 
 This field *cannot be used in **nested** filter expressions*:
 
@@ -209,47 +197,28 @@ This field *can* be used in nested filter expressions, for example:
 >>> Device.objects.filter(primary_ip4__host="1.1.1.1")
 ```
 
-##### IPAddress `prefix_length` contains the prefix length
+##### IPAddress `mask_length` contains the prefix length
 
 This is an integer, such as `30` for `/30`.
 
 ```python
->>> ip.prefix_length
+>>> ip.mask_length
 30
 ```
 
-For IP addresses with a prefix length other than a host prefix, you will need to filter using `host` and `prefix_length` fields for greater accuracy.
+For IP addresses with a mask length other than a host prefix, you will need to filter using `host` and `mask_length` fields for greater accuracy.
 
-For example, if you have multiple `IPAddress` objects with the same `host` value but different `prefix_length`:
+For example, if you have multiple `IPAddress` objects with the same `host` value but different `mask_length`:
 
 ```python
 >>> IPAddress.objects.create(address="1.1.1.1/32")
 <IPAddress: 1.1.1.1/32>
 >>> IPAddress.objects.filter(host="1.1.1.1")
 <IPAddressQuerySet [<IPAddress: 1.1.1.1/30>, <IPAddress: 1.1.1.1/32>]>
->>> IPAddress.objects.filter(host="1.1.1.1", prefix_length=30)
+>>> IPAddress.objects.filter(host="1.1.1.1", mask_length=30)
 <IPAddressQuerySet [<IPAddress: 1.1.1.1/30>]>
 ```
 
-##### IPAddress `broadcast` contains the broadcast address
-
-If the prefix length is that of a host prefix (e.g. `/32`), `broadcast` will be the same as the `host` :
-
-```python
->>> IPAddress.objects.get(address="1.1.1.1/32").broadcast
-'1.1.1.1'
-```
-
-If the prefix length is any larger (e.g. `/24`), `broadcast` will be that of the containing network for that prefix length (e.g. `1.1.1.255`):
-
-```python
->>> IPAddress.objects.create(address="1.1.1.1/24").broadcast
-'1.1.1.255'
-```
-
-!!! note
-    This field is largely for internal use only for facilitating network membership queries and it is not recommend that you use it for filtering.
-
 #### Changes to `Aggregate` and `Prefix`
 
 The following fields have changed when working with `ipam.Aggregate` and `ipam.Prefix` objects.
@@ -349,7 +318,7 @@ Prefix.objects.filter(prefix__net_mask_length=value)
 Nautobot:
 
 ```python
-IPAddress.objects.filter(prefix_length=value)
+IPAddress.objects.filter(mask_length=value)
 # or
 Prefix.objects.filter(prefix_length=value)
 ```

nautobot/docs/installation/migrating-from-postgresql.md

@@ -64,7 +64,7 @@ Example output:
 # Django version 3.2.16
 # Nautobot version 2.0.0a0
 # Example Nautobot App version 1.0.0
-Python 3.7.13 (default, May 11 2022, 08:57:12)
+Python 3.8.16 (default, Mar 23 2023, 04:48:11)
 [GCC 10.2.1 20210110] on linux
 Type "help", "copyright", "credits" or "license" for more information.
 (InteractiveConsole)

nautobot/docs/installation/nautobot.md

@@ -204,7 +204,7 @@ Edit `$NAUTOBOT_ROOT/nautobot_config.py`, and head over to the documentation on
 
 * [`ALLOWED_HOSTS`](../configuration/required-settings.md#allowed_hosts): You must set this value. This can be set to `["*"]` for a quick start, but this value is not suitable for production deployment.
 * [`DATABASES`](../configuration/required-settings.md#databases): Database connection parameters. If you installed your database server on the same system as Nautobot, you'll need to update the `USER` and `PASSWORD` fields here. If you are using MySQL, you'll also need to update the `ENGINE` field, changing the default database driver suffix from `django.db.backends.postgresql` to `django.db.backends.mysql`.
-* **Redis settings**: Redis configuration requires multiple settings including [`CACHEOPS_REDIS`](../configuration/required-settings.md#cacheops_redis), if different from the defaults. If you installed Redis on the same system as Nautobot, you do not need to change these settings.
+* **Redis settings**: Redis configuration requires multiple settings, if different from the defaults. If you installed Redis on the same system as Nautobot, you do not need to change these settings.
 
 !!! important
     You absolutely must update your required settings in your `nautobot_config.py` or Nautobot will not work.

nautobot/docs/installation/tables/v2-api-behavior-changes.yaml

@@ -0,0 +1,70 @@
+---
+- Model: "(all)"
+  Field: "created"
+  Changes: "Now is a date/time rather than only a date"
+- Model: "Cable"
+  Field: "status"
+  Changes: "Now is a foreign-key rather than a pseudo-enum"
+- Model: "Circuit"
+  Field: "status"
+  Changes: "Now is a foreign-key rather than a pseudo-enum"
+- Model: "Device"
+  Field: "config_context"
+  Changes: "Now is only included when specifically requested with `?include=config_context` query parameter"
+- Model: "Device"
+  Field: "location"
+  Changes: "Now required, no longer optional"
+- Model: "Device"
+  Field: "status"
+  Changes: "Now is a foreign-key rather than a pseudo-enum"
+- Model: "DeviceRedundancyGroup"
+  Field: "status"
+  Changes: "Now is a foreign-key rather than a pseudo-enum"
+- Model: "Interface"
+  Field: "status"
+  Changes: "Now is a foreign-key rather than a pseudo-enum"
+- Model: "IPAddress"
+  Field: "role"
+  Changes: "Now is a foreign-key to `Role` rather than a string"
+- Model: "IPAddress"
+  Field: "status"
+  Changes: "Now is a foreign-key rather than a pseudo-enum"
+- Model: "JobLogEntry"
+  Field: "display"
+  Changes: "Now contains the message text rather than the message timestamp"
+- Model: "Location"
+  Field: "status"
+  Changes: "Now is a foreign-key rather than a pseudo-enum"
+- Model: "PowerFeed"
+  Field: "status"
+  Changes: "Now is a foreign-key rather than a pseudo-enum"
+- Model: "PowerPanel"
+  Field: "location"
+  Changes: "Now required, no longer optional"
+- Model: "Prefix"
+  Field: "status"
+  Changes: "Now is a foreign-key rather than a pseudo-enum"
+- Model: "Rack"
+  Field: "location"
+  Changes: "Now required, no longer optional"
+- Model: "Rack"
+  Field: "status"
+  Changes: "Now is a foreign-key rather than a pseudo-enum"
+- Model: "RackGroup"
+  Field: "location"
+  Changes: "Now required, no longer optional"
+- Model: "RackGroup"
+  Field: "rack_count"
+  Changes: "Now only counts Racks directly belonging to this RackGroup, not those belonging to its descendants"
+- Model: "TenantGroup"
+  Field: "tenant_count"
+  Changes: "Now only counts Tenants directly belonging to this TenantGroup, not those belonging to its descendants"
+- Model: "VirtualMachine"
+  Field: "status"
+  Changes: "Now is a foreign-key rather than a pseudo-enum"
+- Model: "VLAN"
+  Field: "status"
+  Changes: "Now is a foreign-key rather than a pseudo-enum"
+- Model: "VMInterface"
+  Field: "status"
+  Changes: "Now is a foreign-key rather than a pseudo-enum"

nautobot/docs/installation/tables/v2-api-removed-fields.yaml

@@ -0,0 +1,142 @@
+---
+- Model/Endpoint: "/api/plugins/installed-plugins"
+  Removed Field: "verison"
+  Comments: "Use `version` instead"
+- Model/Endpoint: "/api/status/"
+  Removed Field: "rq-workers-running"
+  Comments: "Django-RQ is no longer supported"
+- Model/Endpoint: "CircuitTermination"
+  Removed Field: "site"
+  Comments: "Use `location` instead"
+- Model/Endpoint: "CircuitType"
+  Removed Field: "slug"
+  Comments:
+- Model/Endpoint: "Cluster"
+  Removed Field: "site"
+  Comments: "Use `location` instead"
+- Model/Endpoint: "ClusterGroup"
+  Removed Field: "slug"
+  Comments:
+- Model/Endpoint: "ClusterType"
+  Removed Field: "slug"
+  Comments:
+- Model/Endpoint: "ConfigContext"
+  Removed Field: "regions"
+  Comments: "Use `locations` instead"
+- Model/Endpoint: "ConfigContext"
+  Removed Field: "sites"
+  Comments: "Use `locations` instead"
+- Model/Endpoint: "CustomLink"
+  Removed Field: "slug"
+  Comments:
+- Model/Endpoint: "Device"
+  Removed Field: "primary_ip"
+  Comments: "Use `primary_ip4` or `primary_ip6`instead"
+- Model/Endpoint: "Device"
+  Removed Field: "site"
+  Comments: "Use `location` instead"
+- Model/Endpoint: "DeviceRedundancyGroup"
+  Removed Field: "slug"
+  Comments:
+- Model/Endpoint: "DynamicGroup"
+  Removed Field: "slug"
+  Comments:
+- Model/Endpoint: "GitRepository"
+  Removed Field: "token"
+  Comments: "Use Secrets instead"
+- Model/Endpoint: "GitRepository"
+  Removed Field: "username"
+  Comments: "Use Secrets instead"
+- Model/Endpoint: "GraphQLQuery"
+  Removed Field: "slug"
+  Comments:
+- Model/Endpoint: "IPAddress"
+  Removed Field: "broadcast"
+  Comments: "Use parent Prefix's broadcast instead"
+- Model/Endpoint: "IPAddress"
+  Removed Field: "vrf"
+  Comments: "VRF is now related to the assigned Interface(s), as well as the parent Prefix"
+- Model/Endpoint: "JobHook"
+  Removed Field: "slug"
+  Comments:
+- Model/Endpoint: "JobResult"
+  Removed Field: "job_id"
+  Comments:
+- Model/Endpoint: "JobResult"
+  Removed Field: "obj_type"
+  Comments:
+- Model/Endpoint: "Location"
+  Removed Field: "site"
+  Comments: "Use `parent` instead"
+- Model/Endpoint: "Manufacturer"
+  Removed Field: "slug"
+  Comments:
+- Model/Endpoint: "Platform"
+  Removed Field: "slug"
+  Comments:
+- Model/Endpoint: "PowerFeed"
+  Removed Field: "site"
+  Comments: "Use `location` instead"
+- Model/Endpoint: "PowerPanel"
+  Removed Field: "site"
+  Comments: "Use `location` instead"
+- Model/Endpoint: "Prefix"
+  Removed Field: "is_pool"
+  Comments: "Use `type` instead"
+- Model/Endpoint: "Prefix"
+  Removed Field: "site"
+  Comments: "Use `location` instead"
+- Model/Endpoint: "Provider"
+  Removed Field: "slug"
+  Comments:
+- Model/Endpoint: "Rack"
+  Removed Field: "site"
+  Comments: "Use `location` instead"
+- Model/Endpoint: "RackGroup"
+  Removed Field: "site"
+  Comments: "Use `location` instead"
+- Model/Endpoint: "RelationshipAssociation"
+  Removed Field: "slug"
+  Comments:
+- Model/Endpoint: "RIR"
+  Removed Field: "slug"
+  Comments:
+- Model/Endpoint: "Role"
+  Removed Field: "slug"
+  Comments:
+- Model/Endpoint: "RouteTarget"
+  Removed Field: "slug"
+  Comments:
+- Model/Endpoint: "Secret"
+  Removed Field: "slug"
+  Comments:
+- Model/Endpoint: "SecretsGroup"
+  Removed Field: "slug"
+  Comments:
+- Model/Endpoint: "SecretsGroupAssociation"
+  Removed Field: "slug"
+  Comments:
+- Model/Endpoint: "Status"
+  Removed Field: "slug"
+  Comments:
+- Model/Endpoint: "Tenant"
+  Removed Field: "slug"
+  Comments:
+- Model/Endpoint: "TenantGroup"
+  Removed Field: "slug"
+  Comments:
+- Model/Endpoint: "VirtualMachine"
+  Removed Field: "primary_ip"
+  Comments: "Use `primary_ip4` or `primary_ip6`instead"
+- Model/Endpoint: "VLAN"
+  Removed Field: "site"
+  Comments: "Use `location` instead"
+- Model/Endpoint: "VLANGroup"
+  Removed Field: "site"
+  Comments: "Use `location` instead"
+- Model/Endpoint: "VRF"
+  Removed Field: "enforce_unique"
+  Comments: "Uniqueness of Prefixes and IPAddresses is now enforced at the database level"
+- Model/Endpoint: "Webhook"
+  Removed Field: "slug"
+  Comments:

nautobot/docs/installation/tables/v2-api-renamed-fields.yaml

@@ -0,0 +1,124 @@
+---
+- Model: "Circuit"
+  Renamed Field: "termination_a"
+  New Name: "circuit_termination_a"
+- Model: "Circuit"
+  Renamed Field: "termination_z"
+  New Name: "circuit_termination_z"
+- Model: "Circuit"
+  Renamed Field: "type"
+  New Name: "circuit_type"
+- Model: "ConfigContext"
+  Renamed Field: "schema"
+  New Name: "config_context_schema"
+- Model: "Cluster"
+  Renamed Field: "group"
+  New Name: "cluster_group"
+- Model: "Cluster"
+  Renamed Field: "type"
+  New Name: "cluster_type"
+- Model: "ComputedField"
+  Renamed Field: "slug"
+  New Name: "key"
+- Model: "CustomField"
+  Renamed Field: "slug"
+  New Name: "key"
+- Model: "CustomFieldChoice"
+  Renamed Field: "field"
+  New Name: "custom_field"
+- Model: "Device"
+  Renamed Field: "device_role"
+  New Name: "role"
+- Model: "Device"
+  Renamed Field: "local_context_data"
+  New Name: "local_config_context_data"
+- Model: "Device"
+  Renamed Field: "local_context_schema"
+  New Name: "local_config_context_schema"
+- Model: "Device"
+  Renamed Field: "parent_device"
+  New Name: "parent_bay"
+- Model: "FrontPortTemplate"
+  Renamed Field: "rear_port"
+  New Name: "rear_port_template"
+- Model: "Interface"
+  Renamed Field: "count_ipaddresses"
+  New Name: "ip_address_count"
+- Model: "InventoryItem"
+  Renamed Field: "_depth"
+  New Name: "tree_depth"
+- Model: "IPAddress"
+  Renamed Field: "family"
+  New Name: "ip_version"
+- Model: "IPAddress"
+  Renamed Field: "prefix_length"
+  New Name: "mask_length"
+- Model: "JobResult"
+  Renamed Field: "created"
+  New Name: "date_created"
+- Model: "JobResult"
+  Renamed Field: "completed"
+  New Name: "date_done"
+- Model: "JobResult"
+  Renamed Field: "job_kwargs"
+  New Name: "task_kwargs"
+- Model: "JobResult"
+  Renamed Field: "schedule"
+  New Name: "scheduled_job"
+- Model: "Location"
+  Renamed Field: "virtualmachine_count"
+  New Name: "virtual_machine_count"
+- Model: "Manufacturer"
+  Renamed Field: "devicetype_count"
+  New Name: "device_type_count"
+- Model: "Manufacturer"
+  Renamed Field: "inventoryitem_count"
+  New Name: "inventory_item_count"
+- Model: "Platform"
+  Renamed Field: "virtualmachine_count"
+  New Name: "virtual_machine_count"
+- Model: "PowerOutletTemplate"
+  Renamed Field: "power_port"
+  New Name: "power_port_template"
+- Model: "PowerPanel"
+  Renamed Field: "powerfeed_count"
+  New Name: "power_feed_count"
+- Model: "Prefix"
+  Renamed Field: "family"
+  New Name: "ip_version"
+- Model: "Rack"
+  Renamed Field: "group"
+  New Name: "rack_group"
+- Model: "Rack"
+  Renamed Field: "powerfeed_count"
+  New Name: "power_feed_count"
+- Model: "RackGroup"
+  Renamed Field: "_depth"
+  New Name: "tree_depth"
+- Model: "Relationship"
+  Renamed Field: "name"
+  New Name: "label"
+- Model: "Relationship"
+  Renamed Field: "slug"
+  New Name: "key"
+- Model: "SecretsGroupAssociation"
+  Renamed Field: "group"
+  New Name: "secrets_group"
+- Model: "Service"
+  Renamed Field: "ipaddresses"
+  New Name: "ip_addresses"
+- Model: "Tenant"
+  Renamed Field: "group"
+  New Name: "tenant_group"
+- Model: "TenantGroup"
+  Renamed Field: "_depth"
+  New Name: "tree_depth"
+- Model: "VirtualMachine"
+  Renamed Field: "local_context_data"
+  New Name: "local_config_context_data"
+- Model: "VirtualMachine"
+  Renamed Field: "local_context_schema"
+  New Name: "local_config_context_schema"
+- Model: "VLAN"
+  Renamed Field: "group"
+  New Name: "vlan_group"