nautobot 2.0.4__py3-none-any.whl → 2.1.0b1__py3-none-any.whl

nautobot/docs/user-guide/feature-guides/getting-started/interfaces.md

@@ -1,100 +0,0 @@
-# Interfaces
-
-Interfaces in Nautobot represent network interfaces used to exchange data with connected devices.
-
-More information on Interfaces is in the [Interfaces](../../core-data-model/dcim/device.md#interfaces) section of the Nautobot documentation.
-
-Interfaces can be added at the Device or the Device Type level:
-
-* Interfaces added to an individual Device are for that Device only
-* Interfaces added to the Device Type will be applied to all NEW implementations of that Device Type (not existing implementations)
-
-Which one you select depends on your use case; in some instances you will need to use both, as in the example below.
-
-## Interface Add Example
-
-Let’s take an example:
-
-* We want to define a Device Type of `MX240-edge`
-* This Device Type will have 20x 10G (`xe-[0-1]/0/[0-9]`) Interfaces and one LAG (`ae0`) Interface
-* The `xe-0/0/9` and `xe-1/0/9` Interfaces will be members of the `ae0` Interface
-
-## Creating a Device Type
-
-We are going to use the **Device Type** to achieve part of this goal. Using the **Device Type** will also provide repeatability
-because the **Device Type** object also serves as a template. This templating feature is demonstrated in this example.
-
-Device Types can serve as templates for Devices, and as such the two are very similar. Here is a screenshot of a Device Type:
-
-![Device type example](../images/getting-started-nautobot-ui/21-device-type.png)
-
-Creating a Device Type is very similar to [creating a Device](creating-devices.md).
-
-To create a Device Type:
-
-1. Click on **Devices** in the top navigation menu
-2. Click on the **Device Types** option in the drop-down menu
-3. On the Device Types page `Add +` a new Device Type
-    * A Device Type requires a **Manufacturer** object to be created prior to creating the Device Type
-    * Device Type requires **Manufacturer**, **Model**, and **Height** values at creation
-    * In this example, name the Device Type `MX240-edge`
-4. On the home page for the specific Device Type, click on `+Add Components` and select `Interfaces`
-
-![Create a device type](../images/getting-started-nautobot-ui/15-create-device-type.png)
-
-You will now see the `Interface Template` form:
-
-1. Add the `ae0` Interface Template
-    * `Manufacturer` will auto-populate to the Manufacturer of the Device Type you are editing
-    * `Device Type` will auto-populate to the Device Type you are editing
-    * Populate a `Name`
-    * Select a `Type` of `Link Aggregation Group (LAG)` from the drop-down selector
-    * Add a `Description` and `Label` (optional)
-2. Click `Create and Add More`
-3. Create the `xe-` Interfaces
-    * This example shows bulk creation using a range (`xe-[0-1]/0/[0-9]`) in `Name`
-    * Select the appropriate Type from the drop-down selector
-4. Click on `Create`
-
-![Create interface templates](../images/getting-started-nautobot-ui/16-interface-templates.png)
-
-Clicking the `Create` button will take you back to the home screen for the Device Type you are editing. There, you will
-see that the **Interfaces** tab now has the expected 21 Interfaces listed.
-
-![Example interface template](../images/getting-started-nautobot-ui/17-templated-interfaces.png)
-
-!!! note
-    As of this writing (Nautobot 1.0.3), Interfaces cannot be assigned in to a LAG in the Device Type template; component
-    Interfaces must be designated in the specific instantiation of a Device created from the Device Type.
-
-## Creating a New Device Using the Device Type
-
-Create a new Device with these attributes:
-
-* **Name** = `edge2.van1`
-* **Device role** select `Customer Edge`
-* **Device type** select `Juniper MX240-edge` (this will show up as a fusion of the **Manufacturer** (`Juniper`) for the Device Type and the Device Type (`MX240-edge`) Names)
-* **Location** select `Vancouver 1`
-
-On the main screen for the new *Device*, you will see an **Interfaces** tab with the expected Interfaces from the *Device Type* template:
-
-![Assign device type](../images/getting-started-nautobot-ui/18-assign-device-type.png)
-
-!!! note
-    Device Type properties only apply to **new** instantiations of Devices from the Type;
-    Devices created prior to a modification of the Device Type will not inherit the changes retroactively
-
-## Specifying the LAG Components on the Device
-
-As of this writing (Nautobot 1.0.3), LAG component Interfaces cannot be assigned in the Device Type template, so we will
-edit this new Device, specifying the component `ae0` Interfaces.
-
-1. On the new Device's main page, select the appropriate Interfaces (`xe-0/0/9` and `xe-1/0/9`) to be added to `ae0` and click on the `Edit` button
-2. On the `Editing Interfaces` form, select `ae0` in the `Parent LAG` drop-down selector
-3. Click on `Apply`; you will be taken back to the main page for the Device
-
-![Edit LAG interface](../images/getting-started-nautobot-ui/19-edit-ints-for-lag.png)
-
-On the Device's main page, notice that `xe-0/0/9` and `xe-1/0/9` are now assigned to the `ae0` LAG:
-
-![LAG interface example](../images/getting-started-nautobot-ui/20-ints-int-lag.png)

nautobot/docs/user-guide/feature-guides/getting-started/ipam.md

@@ -1,104 +0,0 @@
-# IP Address Management
-
-This next section will demonstrate how to:
-
-* Create a Regional Internet Registry
-* Create a Prefix
-* Create assignable IP addresses
-* Assign an IP address to an Interface on a Device
-
-These type of operations fall under an umbrella called IP Address Management (IPAM).
-
-## Creating a Regional Internet Registry (RIR)
-
-A RIR allocates globally-routeable IP address space. There are five top-level RIRs, each responsible for a particular section of the globe.
-Nautobot also considers RFCs 1918 and 6589 to be RIR-like because they allocate private IP space.
-
-Nautobot requires any IP allocation be attributed to a RIR.
-
-To create a RIR:
-
-1. Click on **IPAM** in the top-level navigation menu
-2. Find **RIRs** and click on the **+**; this takes you to the `Add a new RIR` form
-3. Specify the RIR `Name`
-4. There is a checkbox to flag `Private` (internal use) only
-5. Click on the `Create` button
-
-![Add RIR](../images/getting-started-nautobot-ui/27-add-rir.png)
-
-## Creating a Prefix
-
-A Prefix is an IPv4 or IPv6 network and mask expressed in CIDR notation (e.g. 192.0.2.0/24).
-Each Prefix can be assigned to a particular Location, an RIR and virtual routing and forwarding (VRF) instance.
-
-To create a prefix:
-
-1. Click on **IPAM** in the top-level navigation menu
-2. Look for **Prefixes** and click on the **+**
-    * This will take you to the `Add a new prefix` form
-3. Populate the `Prefix` in CIDR notation
-4. If all addresses in the Prefix are usable, change the type to "Pool"
-5. Select a `Status` from the drop-down selector
-6. Optionally select a `RIR` from the drop-down selector
-7. Click on the `Create` button (not shown)
-
-![Add prefix](../images/getting-started-nautobot-ui/30-add-prefix.png)
-
-## Creating IP Addresses
-
-To create an IP address:
-
-1. Click on **IPAM** in the top-level navigation menu
-2. Find **IP Addresses** and click on the **+**
-    * This will take you to the `Add a new IP address` form
-3. In this example, we are going to create multiple individual addresses, so click on the `Bulk Create` tab
-4. Populate an Address pattern
-    * This example uses `10.10.10.[0-1,2-3,6-7]/31` to create 3 non-contiguous /31's
-    * The specified mask should be exactly as would be configured on the Device's Interface
-5. Select `Active` for `Status` from the drop-down selector
-6. Click on the `Create` button
-
-![Add IP address](../images/getting-started-nautobot-ui/32-add-ip-addr.png)
-
-## Assigning IP Addresses
-
-To assign an IP Address to a specific Device and Interface:
-
-1. Click on **IPAM** in the top-level navigation menu
-2. Click on **IP Addresses** to go to the main IP Addresses page
-3. Find the IP address you wish to assign to an Interface and click on it
-4. On the main page for the Address, click on the `Edit` button to go to the `Editing IP address` page
-![Assign IP address 1](../images/getting-started-nautobot-ui/33-assign-address.png)
-
-![Assign IP address 2](../images/getting-started-nautobot-ui/34-assign-address-2.png)
-
-Once on the `Editing IP address` page:
-
-1. Select a `Device` from the drop-down selector
-2. Select an `Interface` on the Device
-3. Click on the `Update` button
-    * This will take you back to the main page for the IP Address, where you will see the assignment shown as `device (interface)`
-
-![Assign IP address 3](../images/getting-started-nautobot-ui/35-assign-address-3.png)
-
-## Finding an IP Address for an Interface
-
-1. Click on **Devices** on the top-level navigation menu
-2. Click on **Devices** to go to the main page for Devices
-3. Search for the Device you are interested in (`edge2.van1` in this example) and click on the link to go to the main page for the Device
-4. Go to the `Interfaces` tab and look for the row with the Interface you are interested in; find the IP Address(es) in the **IP Addresses** column in the row
-
-![Verify IP address](../images/getting-started-nautobot-ui/36-verify-address.png)
-
-## Finding IP Addresses in a Prefix
-
-To find information on a particular Prefix:
-
-1. Click on **IPAM** in the top-level drop-down menu
-2. Click on **Prefixes** to get to the Prefixes main page
-3. Find the Prefix you are interested in and click on the link
-4. To view the available and allocated IP Addresses, click on the `IP Addresses` tab
-
-![Verify prefix 1](../images/getting-started-nautobot-ui/37-verify-prefix.png)
-
-![Verify prefix 2](../images/getting-started-nautobot-ui/38-verify-prefix2.png)

nautobot/docs/user-guide/feature-guides/getting-started/platforms.md

@@ -1,78 +0,0 @@
-# Platforms
-
-A Platform object can hold various information about a device, such as the OS, OS version, and NAPALM driver.
-
-Further information is available in the [Platforms](../../core-data-model/dcim/platform.md) section of the Nautobot docs.
-
-While use of Platforms is optional, they provide great value in many use cases.
-
-## Creating a Platform
-
-To create a Platform:
-
-1. Click on **Devices** in the top navigation menu
-2. Find **Platforms** and click on the **+** icon in the menu
-    * This takes you to the `Add a new platform` form
-3. Provide a `Name` (required)
-4. Select a `Manufacturer` from the drop-down selector (optional)
-5. Provide the name of the `NAPALM driver` (optional) (Note: this must be the exact name of the NAPALM driver)
-6. Provide `NAPALM arguments` (optional)
-7. Provide `Description` (optional)
-8. Click on the `Create` button
-
-!!! tip
-    NAPALM Driver Options include:
-
-    - eos (Arista)
-    - ios (Cisco)
-    - nxos (used with `nxapi` feature)
-    - nxos_ssh (used for ssh login)
-    - junos
-
-![Add platform](../images/getting-started-nautobot-ui/10-add-platform.png)
-
-Once completed, you will be sent to the Platforms page, where all the Platform variants are shown.
-
-!!! tip
-    Different use cases for Platforms may require different information. For example, to use a specific Platform with
-    the **Device Onboarding Plugin**, you may be required to override the default Name value with that of the
-    Netmiko [device_type](https://github.com/ktbyers/netmiko/blob/2dc032b64c3049d3048966441ee30a0139bebc81/netmiko/ssh_autodetect.py#L50)
-
-![Platforms page](../images/getting-started-nautobot-ui/11-platforms-page.png)
-
-## Adding a Platform to an Existing or New Device
-
-The Platform attribute is optional for a Device.
-
-It is quite easy to add a Platform to an existing Device or while creating a new Device.
-
-A Device's `Platform` is specified on the `Add a new device` or `Editing device` page, depending on whether you are adding or editing a Device.
-
-### Reaching the `Editing device` page for an Existing Device
-
-The quickest way to reach the `Editing device` page for a Device is to search for the Device name
-in the Search Bar.
-
-!!! tip
-    See the [Search Bar](search-bar.md) section of this guide for more information on using the Search Bar
-
-1. Type the device name in the Search Bar in the upper-right of the page
-2. Click on the device name on the results page
-3. Click on the `Edit` button on the main page for the Device
-
-![Device main page](../images/getting-started-nautobot-ui/43-get-to-device-main-page.png)
-
-### Reaching the `Add a new device` Page
-
-For a new Device, follow the steps to [create a new Device](creating-devices.md) to reach the `Add a new device` page.
-
-### Specifying the Device's Platform
-
-1. While on the **Add a new device**/**Editing device** page, scroll down to the 'Management' section
-2. In the `Platform` field drop-down selector, select the appropriate Platform
-3. Click the 'Update' (edit Device) or `Create` (add Device) button
-
-!!! tip
-    The only choices that will appear in the `Platform` drop-down selector will be those Platforms that have the same Manufacturer specified in the Device's `Hardware` section.
-
-![Add platform](../images/getting-started-nautobot-ui/44-add-platform.png)

nautobot/docs/user-guide/feature-guides/getting-started/search-bar.md

@@ -1,40 +0,0 @@
-# The Search Bar
-
-The exercises in the prior sections in this *Getting Started Guide* walked you through how to **navigate** to the proper objects.
-
-You can also use the Search Bar to find desired objects with either partial or complete alpha/numeric characters or exact UUID.
-
-We will show two quick examples.
-
-Example one:
-
-1. Type in `10.10.10.0` in the Search Bar and click on `Search`
-    * This takes you to a search results page
-2. **Prefix** search result `10.10.10.0/24`
-3. **IP Address** search result `10.10.10.0/31`
-4. Interface related to `10.10.10.0/31`
-5. Interface Parent (Device) for `10.10.10.0/31`
-
-Clicking on any of these objects takes you to the main page for that object.
-This example shows the result of clicking on the **IP Address** object (4).
-
-![Address search v2](../images/getting-started-nautobot-ui/42-address-search-v2.png)
-
-Example two shows a Device-specific search:
-
-1. Search for `edge`
-    * This takes you to a search results page
-2. In the drop-down selector to the right, select `Devices`
-3. Search results for Devices with `edge` in the name
-4. *Tenants* for each Device (if applicable)
-5. *Device Type* for each Device
-6. *Location* for each Device
-
-Clicking on an of the links for the results takes you to the main page for that object. For example:
-
-* Clicking on the `Vancouver 1` Location takes you to the main page for the Location.
-* Clicking on the `edge2.van1` Device takes you to the main page for the Device
-
-![Device search results](../images/getting-started-nautobot-ui/41-device-search-results.png)
-
-**END OF *Getting Started in the Web UI* GUIDE**

nautobot/docs/user-guide/feature-guides/getting-started/tenants.md

@@ -1,40 +0,0 @@
-# Tenants
-
-A 'Tenant' signifies ownership of an object in Nautobot and as such, any object may only have a single Tenant assigned.
-
-More information on Tenants can be found in the [Tenants](../../core-data-model/tenancy/tenant.md) section of the Nautobot docs.
-
-## Creating a Tenant
-
-To create a Tenant:
-
-1. Click on **Organization** on the top navigation menu
-2. Find **Tenants** and click on the `+`
-3. Populate the `Name` field
-4. Click the `Create` button
-
-![Add tenant](../images/getting-started-nautobot-ui/12-add-tenant.png)
-
-## Assigning a Tenant to an Object
-
-It is simple to assign a Tenant to an existing object. This next example will add a Tenant to an existing Device.
-
-1. Click on **Devices** in the top navigation menu
-2. Look for the **Devices** option and click on it
-    * This will take you to the **Devices** page
-3. Click on the specific Device you want to add the Tenant to
-    * This will take you to the main page for that Device
-4. On the specific Device page, click on the `Edit` button
-
-![Assign tenant to device 1](../images/getting-started-nautobot-ui/13-assign-tenant-to-device.png)
-
-Once on the page to edit the Device:
-
-1. Make a selection from the `Tenant` drop-down menu selector
-2. Click the `Update` button
-
-This will take you back to the main page for the Device.
-
-![Assign tenant to device 2](../images/getting-started-nautobot-ui/14-assign-tenant-to-device-2.png)
-
-Notice that the `Tenant` field is now populated/updated.

nautobot/docs/user-guide/feature-guides/getting-started/vlans-and-vlan-groups.md

@@ -1,87 +0,0 @@
-# VLANS and VLAN Groups
-
-Each VLAN may be assigned to a location, tenant, and/or VLAN group.
-
-Each VLAN must be assigned a status. The following statuses are available by default:
-
-* Active
-* Reserved
-* Deprecated
-
-In general, VLANs can have overlapping names and IDs. The exception to this is VLANs within a VLAN Group: each VLAN within a group must have a unique ID and name.  
-A VLAN Group may be assigned to a specific location, but a Group cannot belong to multiple locations. VLANs may be assigned to a specific location as well.
-
-The Nautobot documentation has more info about [VLANs](../../core-data-model/ipam/vlan.md) and [VLAN Groups](../../core-data-model/ipam/vlangroup.md).
-
-## VLAN Example
-
-The following example will show:
-
-* Creating a `vlan 200` without a location assignment (*global* scope)
-* Creating two VLANs, each with overlapping Names and IDs: ID = `100` and Name = `vlan 100`
-    * Neither of the `vlan 100` instances will be assigned to a group, but each of the VLANs will be assigned to a different location (*location-specific* scope)
-* How the *location-specific* and *global* scopes affect which VLANs can be assigned on which Devices
-
-!!! note
-    This example will require a Location (`Ottawa 1`) within a Parent Location (`Ottawa`) in the `North America` Parent Location in addition to the `Vancouver 1` Location and `Vancouver` Parent Location created prior.
-    Refer back to the [Create a Loaction](creating-devices.md#create-a-location) sections to do so.
-
-### Creating the VLANs
-
-1. Click on **IPAM** in the top navigation menu
-2. Look for the **VLANS** option and click on the **+** to go to the `Add a new VLAN` form
-3. Populate `ID` with `200`
-4. Populate `Name` with `vlan 200`
-5. Select `Status` as `Active`
-6. Click on `Create and Add Another` to save; you will then be taken to the `Add a new VLAN` form
-
-!!! note
-    The required parameters to create a new VLAN are bolded in the `Add a new VLAN` form: **ID**, **Name**, and **Status**
-
-![Create VLANs 1](../images/getting-started-nautobot-ui/22-create-vlans.png)
-
-Now we'll create two instances of VLANs, each with **ID** = `100` and **Name** = `vlan 100` and an `Active` **Status**.
-The differentiator will be that one instance will be assigned to the `Vancouver 1` Site and the other to the `Ottawa 1` Site.
-
-On the `Add a new VLAN` form:
-
-1. Populate `ID` with `100`
-2. Populate `Name` with `vlan 100`
-3. Select `Status` as `Active`
-4. Select `Vancouver 1` from the `Location` selector drop-down
-5. Click on the `Create and Add Another` button
-
-On the `Add a new VLAN` form:
-
-1. Populate `ID` with `100`
-2. Populate `Name` with `vlan 100`
-3. Select `Status` as `Active`
-4. Select `Ottawa 1` from the `Location` selector drop-down
-5. Click on the `Create` button when complete with the second instance
-
-![Create VLANs 2](../images/getting-started-nautobot-ui/23-create-vlans-2.png)
-
-Once you've created the three VLANs and then hit the `Create` button, you will be taken to the **VLANs** main page. On that page,
-you'll see the three VLANs and the Location assignment for each one. Each `vlan 100` instance will have a Location assignment, while
-`vlan 200` will not:
-
-![VLAN main page](../images/getting-started-nautobot-ui/24-vlan-main-page.png)
-
-### Assigning VLANs to an Interface
-
-To assign a VLAN to an Interface:
-
-1. Click on **IPAM** on the top-level navigation menu
-2. Select **Devices** to go to the Devices main page
-3. Click on the name of the Device you wish to add a VLAN to (`edge2.van1`) in this example
-4. Click on the `Edit` button for the `xe-0/0/0` Interface to go to the `Editing interface xe-0/0/0` page
-5. On the `Editing interface xe-0/0/0` page, set `802.1Q` Mode to `Access` (or whatever mode you need) and then click on the VLAN drop-down selector. Notice that there are two choices:
-    * One choice is the `vlan 100` instance specifically assigned to the `Vancouver 1` Location
-    * The other choice is `vlan 200`, which was not assigned to a Location, and thus has a global scope
-
-![Add VLAN to interface 1](../images/getting-started-nautobot-ui/25-add-vlan-to-interface.png)
-
-!!! note
-    The `vlan 100` instance that is assigned to the `Ottawa 1` Location does not show up as an option for the `Vancouver1` Location
-
-![Add VLAN to interface 2](../images/getting-started-nautobot-ui/26-add-vlan-to-interface-2.png)