2016-07-08 12:55:57 -04:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								site_name: NetBox
							 | 
						
					
						
							
								
									
										
										
										
											2018-10-02 11:51:53 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								theme: readthedocs
							 | 
						
					
						
							
								
									
										
										
										
											2019-07-09 11:36:39 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								repo_url: https://github.com/netbox-community/netbox
							 | 
						
					
						
							
								
									
										
										
										
											2016-07-08 16:00:53 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							
								
									
										
										
										
											2016-07-08 12:55:57 -04:00
										 
									 
								 
							 | 
							
								
							 | 
							
								
							 | 
							
							
								pages:
							 | 
						
					
						
							
								
									
										
										
										
											2018-07-17 17:23:10 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								    - Introduction: 'index.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								    - Installation:
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Installing NetBox: 'installation/index.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - 1. PostgreSQL: 'installation/1-postgresql.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - 2. NetBox: 'installation/2-netbox.md'
							 | 
						
					
						
							
								
									
										
										
										
											2018-07-30 17:19:22 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								        - 3. HTTP Daemon: 'installation/3-http-daemon.md'
							 | 
						
					
						
							
								
									
										
										
										
											2018-07-17 17:23:10 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								        - 4. LDAP (Optional): 'installation/4-ldap.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Upgrading NetBox: 'installation/upgrading.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Migrating to Python3: 'installation/migrating-to-python3.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								    - Configuration:
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Configuring NetBox: 'configuration/index.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Required Settings: 'configuration/required-settings.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Optional Settings: 'configuration/optional-settings.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								    - Core Functionality:
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - IP Address Management: 'core-functionality/ipam.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - VLANs: 'core-functionality/vlans.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Sites and Racks: 'core-functionality/sites-and-racks.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Devices: 'core-functionality/devices.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Virtual Machines: 'core-functionality/virtual-machines.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Services: 'core-functionality/services.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Circuits: 'core-functionality/circuits.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Secrets: 'core-functionality/secrets.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Tenancy: 'core-functionality/tenancy.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								    - Additional Features:
							 | 
						
					
						
							
								
									
										
										
										
											2019-09-20 09:10:32 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								        - Caching: 'additional-features/caching.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Change Logging: 'additional-features/change-logging.md'
							 | 
						
					
						
							
								
									
										
										
										
											2018-07-17 17:23:10 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								        - Context Data: 'additional-features/context-data.md'
							 | 
						
					
						
							
								
									
										
										
										
											2019-09-20 09:10:32 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								        - Custom Fields: 'additional-features/custom-fields.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Custom Scripts: 'additional-features/custom-scripts.md'
							 | 
						
					
						
							
								
									
										
										
										
											2018-07-17 17:23:10 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								        - Export Templates: 'additional-features/export-templates.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Graphs: 'additional-features/graphs.md'
							 | 
						
					
						
							
								
									
										
										
										
											2019-09-20 09:10:32 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								        - Prometheus Metrics: 'additional-features/prometheus-metrics.md'
							 | 
						
					
						
							
								
									
										
										
										
											2018-07-17 17:23:10 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								        - Reports: 'additional-features/reports.md'
							 | 
						
					
						
							
								
									
										
										
										
											2019-09-20 09:10:32 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								        - Tags: 'additional-features/tags.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Topology Maps: 'additional-features/topology-maps.md'
							 | 
						
					
						
							
								
									
										
										
										
											2018-07-17 17:23:10 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								        - Webhooks: 'additional-features/webhooks.md'
							 | 
						
					
						
							
								
									
										
										
										
											2018-07-20 15:26:01 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								    - Administration:
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Replicating NetBox: 'administration/replicating-netbox.md'
							 | 
						
					
						
							
								
									
										
										
										
											2018-12-04 09:19:32 -05:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								        - NetBox Shell: 'administration/netbox-shell.md'
							 | 
						
					
						
							
								
									
										
										
										
											2018-07-17 17:23:10 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								    - API:
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Overview: 'api/overview.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Authentication: 'api/authentication.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Working with Secrets: 'api/working-with-secrets.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Examples: 'api/examples.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								    - Development:
							 | 
						
					
						
							
								
									
										
										
										
											2018-07-27 13:42:18 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								        - Introduction: 'development/index.md'
							 | 
						
					
						
							
								
									
										
										
										
											2018-11-12 14:36:09 -05:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								        - Style Guide: 'development/style-guide.md'
							 | 
						
					
						
							
								
									
										
										
										
											2018-07-17 17:23:10 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								        - Utility Views: 'development/utility-views.md'
							 | 
						
					
						
							
								
									
										
										
										
											2018-11-12 13:59:58 -05:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								        - Extending Models: 'development/extending-models.md'
							 | 
						
					
						
							
								
									
										
										
										
											2018-08-02 11:53:31 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								        - Release Checklist: 'development/release-checklist.md'
							 | 
						
					
						
							
								
									
										
										
										
											2019-10-10 12:02:53 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								    - Release Notes:
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Version 2.6: 'release-notes/version-2.6.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Version 2.5: 'release-notes/version-2.5.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Version 2.4: 'release-notes/version-2.4.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Version 2.3: 'release-notes/version-2.3.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Version 2.2: 'release-notes/version-2.2.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Version 2.1: 'release-notes/version-2.1.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Version 2.0: 'release-notes/version-2.0.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Version 1.9: 'release-notes/version-1.9.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Version 1.8: 'release-notes/version-1.8.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Version 1.7: 'release-notes/version-1.7.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Version 1.6: 'release-notes/version-1.6.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Version 1.5: 'release-notes/version-1.5.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Version 1.4: 'release-notes/version-1.4.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Version 1.3: 'release-notes/version-1.3.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Version 1.2: 'release-notes/version-1.2.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Version 1.1: 'release-notes/version-1.1.md'
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								        - Version 1.0: 'release-notes/version-1.0.md'
							 | 
						
					
						
							
								
									
										
										
										
											2016-07-08 16:00:53 -04:00
										 
									 
								 
							 | 
							
								
									
										
									
								
							 | 
							
								
							 | 
							
							
								
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								markdown_extensions:
							 | 
						
					
						
							| 
								
							 | 
							
								
							 | 
							
								
							 | 
							
							
								    - admonition:
							 |