nautobot 2.4.0__py3-none-any.whl → 2.4.0b1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of nautobot might be problematic. Click here for more details.

Files changed (592) hide show
  1. nautobot/apps/__init__.py +1 -1
  2. nautobot/apps/api.py +8 -8
  3. nautobot/apps/change_logging.py +2 -2
  4. nautobot/apps/choices.py +4 -4
  5. nautobot/apps/events.py +3 -3
  6. nautobot/apps/factory.py +2 -2
  7. nautobot/apps/filters.py +1 -1
  8. nautobot/apps/forms.py +20 -20
  9. nautobot/apps/graphql.py +2 -2
  10. nautobot/apps/jobs.py +8 -8
  11. nautobot/apps/models.py +19 -19
  12. nautobot/apps/tables.py +1 -1
  13. nautobot/apps/testing.py +10 -10
  14. nautobot/apps/ui.py +2 -2
  15. nautobot/apps/utils.py +7 -7
  16. nautobot/apps/views.py +7 -7
  17. nautobot/circuits/api/serializers.py +0 -1
  18. nautobot/circuits/api/views.py +8 -4
  19. nautobot/circuits/tables.py +1 -2
  20. nautobot/circuits/templates/circuits/circuit_create.html +7 -1
  21. nautobot/circuits/views.py +3 -3
  22. nautobot/cloud/api/views.py +10 -6
  23. nautobot/cloud/models.py +1 -1
  24. nautobot/cloud/views.py +16 -0
  25. nautobot/core/api/fields.py +5 -5
  26. nautobot/core/api/filter_backends.py +9 -3
  27. nautobot/core/api/schema.py +2 -13
  28. nautobot/core/api/serializers.py +34 -40
  29. nautobot/core/api/views.py +4 -56
  30. nautobot/core/celery/log.py +4 -4
  31. nautobot/core/celery/schedulers.py +1 -1
  32. nautobot/core/choices.py +2 -2
  33. nautobot/core/events/__init__.py +3 -3
  34. nautobot/core/filters.py +16 -21
  35. nautobot/core/fixtures/user-data.json +59 -0
  36. nautobot/core/forms/__init__.py +19 -19
  37. nautobot/core/forms/fields.py +11 -14
  38. nautobot/core/forms/forms.py +2 -33
  39. nautobot/core/graphql/types.py +1 -1
  40. nautobot/core/jobs/__init__.py +7 -28
  41. nautobot/core/jobs/cleanup.py +12 -48
  42. nautobot/core/jobs/groups.py +1 -1
  43. nautobot/core/management/commands/validate_models.py +1 -1
  44. nautobot/core/models/__init__.py +1 -1
  45. nautobot/core/models/query_functions.py +2 -2
  46. nautobot/core/models/tree_queries.py +3 -6
  47. nautobot/core/settings.py +2 -29
  48. nautobot/core/settings.yaml +0 -21
  49. nautobot/core/tables.py +60 -74
  50. nautobot/core/templates/inc/media.html +0 -3
  51. nautobot/core/templates/inc/nav_menu.html +0 -1
  52. nautobot/core/templates/nautobot_config.py.j2 +0 -13
  53. nautobot/core/templates/search.html +0 -7
  54. nautobot/core/templates/utilities/render_jinja2.html +1 -1
  55. nautobot/core/templates/utilities/templatetags/tag.html +1 -1
  56. nautobot/core/templates/utilities/theme_preview.html +0 -7
  57. nautobot/core/templatetags/helpers.py +2 -11
  58. nautobot/core/testing/__init__.py +8 -8
  59. nautobot/core/testing/api.py +15 -170
  60. nautobot/core/testing/filters.py +2 -25
  61. nautobot/core/testing/forms.py +0 -2
  62. nautobot/core/testing/mixins.py +2 -7
  63. nautobot/core/testing/views.py +29 -44
  64. nautobot/core/tests/integration/test_app_home.py +1 -0
  65. nautobot/core/tests/integration/test_app_navbar.py +1 -0
  66. nautobot/core/tests/integration/test_filters.py +2 -0
  67. nautobot/core/tests/integration/test_home.py +1 -0
  68. nautobot/core/tests/integration/test_navbar.py +1 -0
  69. nautobot/core/tests/integration/test_view_authentication.py +0 -1
  70. nautobot/core/tests/runner.py +1 -1
  71. nautobot/core/tests/test_api.py +1 -98
  72. nautobot/core/tests/test_csv.py +3 -25
  73. nautobot/core/tests/test_forms.py +0 -1
  74. nautobot/core/tests/test_jobs.py +1 -303
  75. nautobot/core/tests/test_settings_schema.py +0 -7
  76. nautobot/core/tests/test_tables.py +0 -100
  77. nautobot/core/tests/test_utils.py +1 -63
  78. nautobot/core/tests/test_views.py +3 -30
  79. nautobot/core/ui/nav.py +0 -1
  80. nautobot/core/ui/object_detail.py +1 -15
  81. nautobot/core/urls.py +0 -11
  82. nautobot/core/utils/lookup.py +8 -11
  83. nautobot/core/utils/requests.py +9 -24
  84. nautobot/core/views/__init__.py +0 -42
  85. nautobot/core/views/generic.py +176 -78
  86. nautobot/core/views/mixins.py +34 -94
  87. nautobot/core/views/renderers.py +6 -6
  88. nautobot/dcim/api/serializers.py +62 -54
  89. nautobot/dcim/api/views.py +113 -47
  90. nautobot/dcim/filters/__init__.py +2 -31
  91. nautobot/dcim/forms.py +17 -36
  92. nautobot/dcim/graphql/types.py +2 -2
  93. nautobot/dcim/models/__init__.py +1 -1
  94. nautobot/dcim/models/device_component_templates.py +2 -2
  95. nautobot/dcim/models/device_components.py +20 -22
  96. nautobot/dcim/models/devices.py +1 -10
  97. nautobot/dcim/models/locations.py +3 -3
  98. nautobot/dcim/models/power.py +5 -6
  99. nautobot/dcim/models/racks.py +4 -4
  100. nautobot/dcim/tables/__init__.py +3 -3
  101. nautobot/dcim/tables/devices.py +5 -7
  102. nautobot/dcim/tables/devicetypes.py +2 -2
  103. nautobot/dcim/tables/racks.py +1 -1
  104. nautobot/dcim/templates/dcim/controller_create.html +7 -1
  105. nautobot/dcim/templates/dcim/controller_retrieve.html +9 -1
  106. nautobot/dcim/templates/dcim/controllermanageddevicegroup_create.html +0 -2
  107. nautobot/dcim/templates/dcim/controllermanageddevicegroup_retrieve.html +0 -5
  108. nautobot/dcim/templates/dcim/device.html +9 -1
  109. nautobot/dcim/templates/dcim/device_edit.html +37 -36
  110. nautobot/dcim/templates/dcim/location.html +9 -1
  111. nautobot/dcim/templates/dcim/location_edit.html +7 -1
  112. nautobot/dcim/templates/dcim/rack.html +9 -1
  113. nautobot/dcim/templates/dcim/rack_edit.html +7 -1
  114. nautobot/dcim/templates/dcim/rackreservation.html +9 -1
  115. nautobot/dcim/templates/dcim/virtualdevicecontext_retrieve.html +9 -1
  116. nautobot/dcim/templates/dcim/virtualdevicecontext_update.html +7 -1
  117. nautobot/dcim/tests/test_api.py +3 -16
  118. nautobot/dcim/tests/test_filters.py +0 -33
  119. nautobot/dcim/tests/test_forms.py +2 -51
  120. nautobot/dcim/tests/test_graphql.py +0 -52
  121. nautobot/dcim/tests/test_models.py +5 -34
  122. nautobot/dcim/tests/test_views.py +83 -21
  123. nautobot/dcim/views.py +13 -1
  124. nautobot/extras/api/customfields.py +2 -2
  125. nautobot/extras/api/serializers.py +85 -90
  126. nautobot/extras/api/views.py +27 -22
  127. nautobot/extras/constants.py +0 -2
  128. nautobot/extras/filters/__init__.py +6 -8
  129. nautobot/extras/forms/base.py +2 -2
  130. nautobot/extras/forms/forms.py +31 -139
  131. nautobot/extras/forms/mixins.py +5 -13
  132. nautobot/extras/group_sync.py +3 -3
  133. nautobot/extras/health_checks.py +2 -1
  134. nautobot/extras/jobs.py +12 -70
  135. nautobot/extras/managers.py +1 -3
  136. nautobot/extras/migrations/0018_joblog_data_migration.py +9 -7
  137. nautobot/extras/models/__init__.py +1 -1
  138. nautobot/extras/models/contacts.py +1 -1
  139. nautobot/extras/models/customfields.py +11 -12
  140. nautobot/extras/models/groups.py +9 -11
  141. nautobot/extras/models/jobs.py +4 -23
  142. nautobot/extras/models/models.py +2 -2
  143. nautobot/extras/plugins/__init__.py +2 -13
  144. nautobot/extras/plugins/marketplace_manifest.yml +79 -84
  145. nautobot/extras/plugins/tables.py +14 -16
  146. nautobot/extras/plugins/views.py +69 -65
  147. nautobot/extras/registry.py +1 -1
  148. nautobot/extras/secrets/__init__.py +2 -2
  149. nautobot/extras/tables.py +5 -7
  150. nautobot/extras/templates/extras/dynamicgroup.html +9 -1
  151. nautobot/extras/templates/extras/job_detail.html +0 -16
  152. nautobot/extras/templates/extras/job_edit.html +0 -1
  153. nautobot/extras/templates/extras/jobqueue_retrieve.html +9 -1
  154. nautobot/extras/templates/extras/marketplace.html +11 -29
  155. nautobot/extras/templates/extras/plugin_detail.html +15 -32
  156. nautobot/extras/templates/extras/plugins_tiles.html +10 -21
  157. nautobot/extras/test_jobs/api_test_job.py +1 -1
  158. nautobot/extras/test_jobs/atomic_transaction.py +2 -2
  159. nautobot/extras/test_jobs/dry_run.py +1 -1
  160. nautobot/extras/test_jobs/fail.py +5 -5
  161. nautobot/extras/test_jobs/file_output.py +1 -1
  162. nautobot/extras/test_jobs/file_upload_fail.py +1 -1
  163. nautobot/extras/test_jobs/file_upload_pass.py +1 -1
  164. nautobot/extras/test_jobs/ipaddress_vars.py +1 -3
  165. nautobot/extras/test_jobs/jobs_module/jobs_submodule/jobs.py +1 -1
  166. nautobot/extras/test_jobs/location_with_custom_field.py +1 -1
  167. nautobot/extras/test_jobs/log_redaction.py +1 -1
  168. nautobot/extras/test_jobs/log_skip_db_logging.py +1 -1
  169. nautobot/extras/test_jobs/modify_db.py +1 -1
  170. nautobot/extras/test_jobs/object_var_optional.py +1 -1
  171. nautobot/extras/test_jobs/object_var_required.py +1 -1
  172. nautobot/extras/test_jobs/object_vars.py +1 -1
  173. nautobot/extras/test_jobs/pass.py +3 -3
  174. nautobot/extras/test_jobs/profiling.py +1 -1
  175. nautobot/extras/test_jobs/relative_import.py +3 -3
  176. nautobot/extras/test_jobs/soft_time_limit_greater_than_time_limit.py +1 -1
  177. nautobot/extras/test_jobs/task_queues.py +1 -1
  178. nautobot/extras/tests/integration/test_plugin_banner.py +2 -0
  179. nautobot/extras/tests/test_api.py +13 -13
  180. nautobot/extras/tests/test_customfields.py +1 -1
  181. nautobot/extras/tests/test_datasources.py +1 -2
  182. nautobot/extras/tests/test_dynamicgroups.py +1 -1
  183. nautobot/extras/tests/test_filters.py +6 -6
  184. nautobot/extras/tests/test_forms.py +1 -20
  185. nautobot/extras/tests/test_jobs.py +19 -160
  186. nautobot/extras/tests/test_models.py +10 -10
  187. nautobot/extras/tests/test_plugins.py +9 -62
  188. nautobot/extras/tests/test_relationships.py +9 -120
  189. nautobot/extras/tests/test_views.py +191 -52
  190. nautobot/extras/utils.py +2 -3
  191. nautobot/extras/views.py +98 -30
  192. nautobot/ipam/api/fields.py +3 -3
  193. nautobot/ipam/api/serializers.py +33 -41
  194. nautobot/ipam/api/views.py +117 -68
  195. nautobot/ipam/factory.py +1 -1
  196. nautobot/ipam/filters.py +2 -3
  197. nautobot/ipam/lookups.py +62 -101
  198. nautobot/ipam/models.py +16 -66
  199. nautobot/ipam/querysets.py +2 -2
  200. nautobot/ipam/tables.py +7 -23
  201. nautobot/ipam/templates/ipam/ipaddress.html +9 -1
  202. nautobot/ipam/templates/ipam/ipaddress_bulk_add.html +7 -1
  203. nautobot/ipam/templates/ipam/ipaddress_edit.html +7 -1
  204. nautobot/ipam/templates/ipam/prefix.html +9 -1
  205. nautobot/ipam/templates/ipam/prefix_edit.html +7 -1
  206. nautobot/ipam/templates/ipam/vlan.html +9 -1
  207. nautobot/ipam/templates/ipam/vlan_edit.html +7 -1
  208. nautobot/ipam/templates/ipam/vrf_edit.html +7 -1
  209. nautobot/ipam/tests/test_api.py +3 -416
  210. nautobot/ipam/tests/test_forms.py +47 -49
  211. nautobot/ipam/tests/test_migrations.py +30 -30
  212. nautobot/ipam/tests/test_models.py +34 -95
  213. nautobot/ipam/tests/test_querysets.py +1 -63
  214. nautobot/ipam/tests/test_views.py +0 -3
  215. nautobot/ipam/utils/__init__.py +6 -36
  216. nautobot/ipam/views.py +87 -61
  217. nautobot/project-static/bootstrap-3.4.1-dist/css/bootstrap-theme.css.map +1 -1
  218. nautobot/project-static/bootstrap-3.4.1-dist/css/bootstrap-theme.min.css.map +1 -1
  219. nautobot/project-static/bootstrap-3.4.1-dist/css/bootstrap.css +2 -40
  220. nautobot/project-static/bootstrap-3.4.1-dist/css/bootstrap.css.map +1 -1
  221. nautobot/project-static/bootstrap-3.4.1-dist/css/bootstrap.min.css +1 -1
  222. nautobot/project-static/bootstrap-3.4.1-dist/css/bootstrap.min.css.map +1 -1
  223. nautobot/project-static/docs/404.html +4 -46
  224. nautobot/project-static/docs/apps/index.html +4 -46
  225. nautobot/project-static/docs/apps/nautobot-apps.html +6 -47
  226. nautobot/project-static/docs/assets/_mkdocstrings.css +1 -25
  227. nautobot/project-static/docs/assets/javascripts/{bundle.88dd0f4e.min.js → bundle.83f73b43.min.js} +2 -2
  228. nautobot/project-static/docs/assets/javascripts/{bundle.88dd0f4e.min.js.map → bundle.83f73b43.min.js.map} +2 -2
  229. nautobot/project-static/docs/code-reference/nautobot/apps/__init__.html +10 -62
  230. nautobot/project-static/docs/code-reference/nautobot/apps/admin.html +7 -59
  231. nautobot/project-static/docs/code-reference/nautobot/apps/api.html +122 -374
  232. nautobot/project-static/docs/code-reference/nautobot/apps/change_logging.html +18 -90
  233. nautobot/project-static/docs/code-reference/nautobot/apps/choices.html +21 -95
  234. nautobot/project-static/docs/code-reference/nautobot/apps/config.html +6 -53
  235. nautobot/project-static/docs/code-reference/nautobot/apps/constants.html +5 -52
  236. nautobot/project-static/docs/code-reference/nautobot/apps/datasources.html +17 -79
  237. nautobot/project-static/docs/code-reference/nautobot/apps/events.html +28 -102
  238. nautobot/project-static/docs/code-reference/nautobot/apps/exceptions.html +21 -108
  239. nautobot/project-static/docs/code-reference/nautobot/apps/factory.html +38 -131
  240. nautobot/project-static/docs/code-reference/nautobot/apps/filters.html +65 -239
  241. nautobot/project-static/docs/code-reference/nautobot/apps/forms.html +165 -581
  242. nautobot/project-static/docs/code-reference/nautobot/apps/graphql.html +36 -109
  243. nautobot/project-static/docs/code-reference/nautobot/apps/jobs.html +167 -453
  244. nautobot/project-static/docs/code-reference/nautobot/apps/models.html +211 -493
  245. nautobot/project-static/docs/code-reference/nautobot/apps/querysets.html +8 -60
  246. nautobot/project-static/docs/code-reference/nautobot/apps/secrets.html +15 -71
  247. nautobot/project-static/docs/code-reference/nautobot/apps/tables.html +55 -407
  248. nautobot/project-static/docs/code-reference/nautobot/apps/testing.html +205 -585
  249. nautobot/project-static/docs/code-reference/nautobot/apps/ui.html +412 -858
  250. nautobot/project-static/docs/code-reference/nautobot/apps/urls.html +7 -59
  251. nautobot/project-static/docs/code-reference/nautobot/apps/utils.html +186 -448
  252. nautobot/project-static/docs/code-reference/nautobot/apps/views.html +147 -365
  253. nautobot/project-static/docs/development/apps/api/configuration-view.html +4 -46
  254. nautobot/project-static/docs/development/apps/api/database-backend-config.html +4 -46
  255. nautobot/project-static/docs/development/apps/api/models/django-admin.html +4 -46
  256. nautobot/project-static/docs/development/apps/api/models/global-search.html +4 -46
  257. nautobot/project-static/docs/development/apps/api/models/graphql.html +4 -46
  258. nautobot/project-static/docs/development/apps/api/models/index.html +4 -46
  259. nautobot/project-static/docs/development/apps/api/nautobot-app-config.html +4 -46
  260. nautobot/project-static/docs/development/apps/api/platform-features/custom-validators.html +4 -46
  261. nautobot/project-static/docs/development/apps/api/platform-features/filter-extensions.html +4 -46
  262. nautobot/project-static/docs/development/apps/api/platform-features/git-repository-content.html +4 -46
  263. nautobot/project-static/docs/development/apps/api/platform-features/index.html +4 -46
  264. nautobot/project-static/docs/development/apps/api/platform-features/jinja2-filters.html +4 -46
  265. nautobot/project-static/docs/development/apps/api/platform-features/jobs.html +4 -46
  266. nautobot/project-static/docs/development/apps/api/platform-features/populating-extensibility-features.html +4 -46
  267. nautobot/project-static/docs/development/apps/api/platform-features/secrets-providers.html +4 -46
  268. nautobot/project-static/docs/development/apps/api/platform-features/table-extensions.html +7 -68
  269. nautobot/project-static/docs/development/apps/api/platform-features/uniquely-identify-objects.html +4 -46
  270. nautobot/project-static/docs/development/apps/api/prometheus.html +4 -46
  271. nautobot/project-static/docs/development/apps/api/setup.html +4 -46
  272. nautobot/project-static/docs/development/apps/api/testing.html +4 -46
  273. nautobot/project-static/docs/development/apps/api/ui-extensions/banners.html +4 -46
  274. nautobot/project-static/docs/development/apps/api/ui-extensions/home-page.html +4 -46
  275. nautobot/project-static/docs/development/apps/api/ui-extensions/index.html +4 -46
  276. nautobot/project-static/docs/development/apps/api/ui-extensions/navigation.html +4 -46
  277. nautobot/project-static/docs/development/apps/api/ui-extensions/object-views.html +4 -46
  278. nautobot/project-static/docs/development/apps/api/views/base-template.html +4 -46
  279. nautobot/project-static/docs/development/apps/api/views/core-view-overrides.html +4 -46
  280. nautobot/project-static/docs/development/apps/api/views/django-generic-views.html +4 -46
  281. nautobot/project-static/docs/development/apps/api/views/help-documentation.html +4 -46
  282. nautobot/project-static/docs/development/apps/api/views/index.html +4 -46
  283. nautobot/project-static/docs/development/apps/api/views/nautobot-generic-views.html +4 -46
  284. nautobot/project-static/docs/development/apps/api/views/nautobotuiviewset.html +4 -46
  285. nautobot/project-static/docs/development/apps/api/views/nautobotuiviewsetrouter.html +4 -46
  286. nautobot/project-static/docs/development/apps/api/views/notes.html +4 -46
  287. nautobot/project-static/docs/development/apps/api/views/rest-api.html +6 -52
  288. nautobot/project-static/docs/development/apps/api/views/urls.html +4 -46
  289. nautobot/project-static/docs/development/apps/index.html +4 -46
  290. nautobot/project-static/docs/development/apps/migration/code-updates.html +4 -46
  291. nautobot/project-static/docs/development/apps/migration/dependency-updates.html +4 -46
  292. nautobot/project-static/docs/development/apps/migration/from-v1.html +4 -46
  293. nautobot/project-static/docs/development/apps/migration/model-updates/dcim.html +4 -46
  294. nautobot/project-static/docs/development/apps/migration/model-updates/extras.html +4 -46
  295. nautobot/project-static/docs/development/apps/migration/model-updates/global.html +4 -46
  296. nautobot/project-static/docs/development/apps/migration/model-updates/ipam.html +4 -46
  297. nautobot/project-static/docs/development/apps/migration/ui-component-framework/best-practices.html +8 -50
  298. nautobot/project-static/docs/development/apps/migration/ui-component-framework/custom-content.html +4 -46
  299. nautobot/project-static/docs/development/apps/migration/ui-component-framework/index.html +14 -211
  300. nautobot/project-static/docs/development/apps/migration/ui-component-framework/migration-steps.html +4 -46
  301. nautobot/project-static/docs/development/apps/porting-from-netbox.html +4 -46
  302. nautobot/project-static/docs/development/core/application-registry.html +4 -46
  303. nautobot/project-static/docs/development/core/best-practices.html +4 -46
  304. nautobot/project-static/docs/development/core/bootstrap-ui.html +4 -46
  305. nautobot/project-static/docs/development/core/caching.html +4 -46
  306. nautobot/project-static/docs/development/core/controllers.html +4 -46
  307. nautobot/project-static/docs/development/core/docker-compose-advanced-use-cases.html +74 -73
  308. nautobot/project-static/docs/development/core/generic-views.html +4 -46
  309. nautobot/project-static/docs/development/core/getting-started.html +224 -249
  310. nautobot/project-static/docs/development/core/homepage.html +7 -49
  311. nautobot/project-static/docs/development/core/index.html +4 -46
  312. nautobot/project-static/docs/development/core/{minikube-dev-environment-for-k8s-jobs.html → local-k8s.html} +168 -469
  313. nautobot/project-static/docs/development/core/model-checklist.html +12 -56
  314. nautobot/project-static/docs/development/core/model-features.html +4 -46
  315. nautobot/project-static/docs/development/core/natural-keys.html +4 -46
  316. nautobot/project-static/docs/development/core/navigation-menu.html +4 -46
  317. nautobot/project-static/docs/development/core/release-checklist.html +7 -49
  318. nautobot/project-static/docs/development/core/role-internals.html +4 -46
  319. nautobot/project-static/docs/development/core/settings.html +4 -46
  320. nautobot/project-static/docs/development/core/style-guide.html +7 -49
  321. nautobot/project-static/docs/development/core/templates.html +4 -46
  322. nautobot/project-static/docs/development/core/testing.html +4 -46
  323. nautobot/project-static/docs/development/core/ui-component-framework.html +273 -369
  324. nautobot/project-static/docs/development/core/user-preferences.html +4 -46
  325. nautobot/project-static/docs/development/index.html +4 -46
  326. nautobot/project-static/docs/development/jobs/index.html +122 -216
  327. nautobot/project-static/docs/development/jobs/migration/from-v1.html +4 -46
  328. nautobot/project-static/docs/index.html +23 -54
  329. nautobot/project-static/docs/objects.inv +0 -0
  330. nautobot/project-static/docs/overview/application_stack.html +7 -47
  331. nautobot/project-static/docs/overview/design_philosophy.html +4 -46
  332. nautobot/project-static/docs/release-notes/index.html +12 -52
  333. nautobot/project-static/docs/release-notes/version-1.0.html +193 -234
  334. nautobot/project-static/docs/release-notes/version-1.1.html +190 -231
  335. nautobot/project-static/docs/release-notes/version-1.2.html +265 -306
  336. nautobot/project-static/docs/release-notes/version-1.3.html +291 -332
  337. nautobot/project-static/docs/release-notes/version-1.4.html +377 -417
  338. nautobot/project-static/docs/release-notes/version-1.5.html +566 -605
  339. nautobot/project-static/docs/release-notes/version-1.6.html +447 -904
  340. nautobot/project-static/docs/release-notes/version-2.0.html +489 -528
  341. nautobot/project-static/docs/release-notes/version-2.1.html +324 -363
  342. nautobot/project-static/docs/release-notes/version-2.2.html +317 -356
  343. nautobot/project-static/docs/release-notes/version-2.3.html +352 -997
  344. nautobot/project-static/docs/release-notes/version-2.4.html +101 -417
  345. nautobot/project-static/docs/requirements.txt +2 -2
  346. nautobot/project-static/docs/search/search_index.json +1 -1
  347. nautobot/project-static/docs/sitemap.xml +287 -295
  348. nautobot/project-static/docs/sitemap.xml.gz +0 -0
  349. nautobot/project-static/docs/user-guide/administration/configuration/authentication/ldap.html +4 -46
  350. nautobot/project-static/docs/user-guide/administration/configuration/authentication/remote.html +4 -46
  351. nautobot/project-static/docs/user-guide/administration/configuration/authentication/sso.html +6 -48
  352. nautobot/project-static/docs/user-guide/administration/configuration/index.html +4 -46
  353. nautobot/project-static/docs/user-guide/administration/configuration/redis.html +4 -46
  354. nautobot/project-static/docs/user-guide/administration/configuration/settings.html +8 -110
  355. nautobot/project-static/docs/user-guide/administration/configuration/time-zones.html +4 -46
  356. nautobot/project-static/docs/user-guide/administration/guides/celery-queues.html +4 -46
  357. nautobot/project-static/docs/user-guide/administration/guides/docker.html +4 -46
  358. nautobot/project-static/docs/user-guide/administration/guides/health-checks.html +4 -46
  359. nautobot/project-static/docs/user-guide/administration/guides/permissions.html +4 -46
  360. nautobot/project-static/docs/user-guide/administration/guides/prometheus-metrics.html +4 -46
  361. nautobot/project-static/docs/user-guide/administration/guides/replicating-nautobot.html +4 -46
  362. nautobot/project-static/docs/user-guide/administration/guides/request-profiling.html +4 -46
  363. nautobot/project-static/docs/user-guide/administration/guides/s3-django-storage.html +6 -48
  364. nautobot/project-static/docs/user-guide/administration/guides/selinux-troubleshooting.html +4 -46
  365. nautobot/project-static/docs/user-guide/administration/installation/app-install.html +4 -46
  366. nautobot/project-static/docs/user-guide/administration/installation/external-authentication.html +4 -46
  367. nautobot/project-static/docs/user-guide/administration/installation/http-server.html +8 -66
  368. nautobot/project-static/docs/user-guide/administration/installation/index.html +4 -46
  369. nautobot/project-static/docs/user-guide/administration/installation/install_system.html +5 -47
  370. nautobot/project-static/docs/user-guide/administration/installation/nautobot.html +4 -46
  371. nautobot/project-static/docs/user-guide/administration/installation/services.html +4 -46
  372. nautobot/project-static/docs/user-guide/administration/migration/migrating-from-netbox.html +4 -46
  373. nautobot/project-static/docs/user-guide/administration/migration/migrating-from-postgresql.html +4 -46
  374. nautobot/project-static/docs/user-guide/administration/tools/nautobot-server.html +4 -46
  375. nautobot/project-static/docs/user-guide/administration/tools/nautobot-shell.html +4 -46
  376. nautobot/project-static/docs/user-guide/administration/upgrading/database-backup.html +4 -46
  377. nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/ipam/after-you-upgrade.html +4 -46
  378. nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/ipam/before-you-upgrade.html +4 -46
  379. nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/ipam/for-developers.html +4 -46
  380. nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/ipam/index.html +4 -46
  381. nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/ipam/whats-changed.html +8 -49
  382. nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/region-and-site-data-migration-guide.html +4 -46
  383. nautobot/project-static/docs/user-guide/administration/upgrading/from-v1/upgrading-from-nautobot-v1.html +4 -46
  384. nautobot/project-static/docs/user-guide/administration/upgrading/upgrading.html +4 -46
  385. nautobot/project-static/docs/user-guide/core-data-model/circuits/circuit.html +4 -46
  386. nautobot/project-static/docs/user-guide/core-data-model/circuits/circuittermination.html +4 -46
  387. nautobot/project-static/docs/user-guide/core-data-model/circuits/circuittype.html +4 -46
  388. nautobot/project-static/docs/user-guide/core-data-model/circuits/provider.html +4 -46
  389. nautobot/project-static/docs/user-guide/core-data-model/circuits/providernetwork.html +4 -46
  390. nautobot/project-static/docs/user-guide/core-data-model/cloud/cloud.html +4 -46
  391. nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudaccount.html +4 -46
  392. nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudnetwork.html +4 -46
  393. nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudnetworkprefixassignment.html +4 -46
  394. nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudresourcetype.html +4 -46
  395. nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudservice.html +4 -46
  396. nautobot/project-static/docs/user-guide/core-data-model/cloud/cloudservicenetworkassignment.html +4 -46
  397. nautobot/project-static/docs/user-guide/core-data-model/dcim/cable.html +4 -46
  398. nautobot/project-static/docs/user-guide/core-data-model/dcim/consoleport.html +4 -46
  399. nautobot/project-static/docs/user-guide/core-data-model/dcim/consoleporttemplate.html +4 -46
  400. nautobot/project-static/docs/user-guide/core-data-model/dcim/consoleserverport.html +4 -46
  401. nautobot/project-static/docs/user-guide/core-data-model/dcim/consoleserverporttemplate.html +4 -46
  402. nautobot/project-static/docs/user-guide/core-data-model/dcim/controller.html +4 -46
  403. nautobot/project-static/docs/user-guide/core-data-model/dcim/controllermanageddevicegroup.html +4 -46
  404. nautobot/project-static/docs/user-guide/core-data-model/dcim/device.html +4 -46
  405. nautobot/project-static/docs/user-guide/core-data-model/dcim/devicebay.html +4 -46
  406. nautobot/project-static/docs/user-guide/core-data-model/dcim/devicebaytemplate.html +4 -46
  407. nautobot/project-static/docs/user-guide/core-data-model/dcim/devicefamily.html +4 -46
  408. nautobot/project-static/docs/user-guide/core-data-model/dcim/deviceredundancygroup.html +4 -46
  409. nautobot/project-static/docs/user-guide/core-data-model/dcim/devicetype.html +4 -46
  410. nautobot/project-static/docs/user-guide/core-data-model/dcim/frontport.html +4 -46
  411. nautobot/project-static/docs/user-guide/core-data-model/dcim/frontporttemplate.html +4 -46
  412. nautobot/project-static/docs/user-guide/core-data-model/dcim/interface.html +4 -46
  413. nautobot/project-static/docs/user-guide/core-data-model/dcim/interfaceredundancygroup.html +4 -46
  414. nautobot/project-static/docs/user-guide/core-data-model/dcim/interfacetemplate.html +4 -46
  415. nautobot/project-static/docs/user-guide/core-data-model/dcim/inventoryitem.html +4 -46
  416. nautobot/project-static/docs/user-guide/core-data-model/dcim/location.html +4 -46
  417. nautobot/project-static/docs/user-guide/core-data-model/dcim/locationtype.html +4 -46
  418. nautobot/project-static/docs/user-guide/core-data-model/dcim/manufacturer.html +4 -46
  419. nautobot/project-static/docs/user-guide/core-data-model/dcim/module.html +4 -46
  420. nautobot/project-static/docs/user-guide/core-data-model/dcim/modulebay.html +4 -46
  421. nautobot/project-static/docs/user-guide/core-data-model/dcim/modulebaytemplate.html +4 -46
  422. nautobot/project-static/docs/user-guide/core-data-model/dcim/moduletype.html +4 -46
  423. nautobot/project-static/docs/user-guide/core-data-model/dcim/platform.html +4 -46
  424. nautobot/project-static/docs/user-guide/core-data-model/dcim/powerfeed.html +4 -46
  425. nautobot/project-static/docs/user-guide/core-data-model/dcim/poweroutlet.html +4 -46
  426. nautobot/project-static/docs/user-guide/core-data-model/dcim/poweroutlettemplate.html +4 -46
  427. nautobot/project-static/docs/user-guide/core-data-model/dcim/powerpanel.html +4 -46
  428. nautobot/project-static/docs/user-guide/core-data-model/dcim/powerport.html +4 -46
  429. nautobot/project-static/docs/user-guide/core-data-model/dcim/powerporttemplate.html +4 -46
  430. nautobot/project-static/docs/user-guide/core-data-model/dcim/rack.html +4 -46
  431. nautobot/project-static/docs/user-guide/core-data-model/dcim/rackgroup.html +4 -46
  432. nautobot/project-static/docs/user-guide/core-data-model/dcim/rackreservation.html +4 -46
  433. nautobot/project-static/docs/user-guide/core-data-model/dcim/rearport.html +4 -46
  434. nautobot/project-static/docs/user-guide/core-data-model/dcim/rearporttemplate.html +4 -46
  435. nautobot/project-static/docs/user-guide/core-data-model/dcim/softwareimagefile.html +4 -46
  436. nautobot/project-static/docs/user-guide/core-data-model/dcim/softwareversion.html +4 -46
  437. nautobot/project-static/docs/user-guide/core-data-model/dcim/virtualchassis.html +4 -46
  438. nautobot/project-static/docs/user-guide/core-data-model/dcim/virtualdevicecontext.html +4 -46
  439. nautobot/project-static/docs/user-guide/core-data-model/extras/configcontext.html +12 -50
  440. nautobot/project-static/docs/user-guide/core-data-model/extras/configcontextschema.html +4 -46
  441. nautobot/project-static/docs/user-guide/core-data-model/extras/contact.html +4 -46
  442. nautobot/project-static/docs/user-guide/core-data-model/extras/team.html +4 -46
  443. nautobot/project-static/docs/user-guide/core-data-model/ipam/ipaddress.html +4 -46
  444. nautobot/project-static/docs/user-guide/core-data-model/ipam/namespace.html +4 -46
  445. nautobot/project-static/docs/user-guide/core-data-model/ipam/prefix.html +4 -46
  446. nautobot/project-static/docs/user-guide/core-data-model/ipam/rir.html +4 -46
  447. nautobot/project-static/docs/user-guide/core-data-model/ipam/routetarget.html +4 -46
  448. nautobot/project-static/docs/user-guide/core-data-model/ipam/service.html +4 -46
  449. nautobot/project-static/docs/user-guide/core-data-model/ipam/vlan.html +4 -46
  450. nautobot/project-static/docs/user-guide/core-data-model/ipam/vlangroup.html +4 -46
  451. nautobot/project-static/docs/user-guide/core-data-model/ipam/vrf.html +4 -46
  452. nautobot/project-static/docs/user-guide/core-data-model/overview/introduction.html +7 -49
  453. nautobot/project-static/docs/user-guide/core-data-model/tenancy/tenant.html +4 -46
  454. nautobot/project-static/docs/user-guide/core-data-model/tenancy/tenantgroup.html +4 -46
  455. nautobot/project-static/docs/user-guide/core-data-model/virtualization/cluster.html +4 -46
  456. nautobot/project-static/docs/user-guide/core-data-model/virtualization/clustergroup.html +4 -46
  457. nautobot/project-static/docs/user-guide/core-data-model/virtualization/clustertype.html +4 -46
  458. nautobot/project-static/docs/user-guide/core-data-model/virtualization/virtualmachine.html +4 -46
  459. nautobot/project-static/docs/user-guide/core-data-model/virtualization/vminterface.html +4 -46
  460. nautobot/project-static/docs/user-guide/core-data-model/wireless/index.html +4 -46
  461. nautobot/project-static/docs/user-guide/core-data-model/wireless/radioprofile.html +4 -46
  462. nautobot/project-static/docs/user-guide/core-data-model/wireless/supporteddatarate.html +4 -46
  463. nautobot/project-static/docs/user-guide/core-data-model/wireless/wirelessnetwork.html +4 -46
  464. nautobot/project-static/docs/user-guide/feature-guides/contacts-and-teams.html +4 -46
  465. nautobot/project-static/docs/user-guide/feature-guides/custom-fields.html +4 -46
  466. nautobot/project-static/docs/user-guide/feature-guides/getting-started/creating-devices.html +4 -46
  467. nautobot/project-static/docs/user-guide/feature-guides/getting-started/creating-location-types-and-locations.html +4 -46
  468. nautobot/project-static/docs/user-guide/feature-guides/getting-started/index.html +4 -46
  469. nautobot/project-static/docs/user-guide/feature-guides/getting-started/interfaces.html +4 -46
  470. nautobot/project-static/docs/user-guide/feature-guides/getting-started/ipam.html +4 -46
  471. nautobot/project-static/docs/user-guide/feature-guides/getting-started/platforms.html +4 -46
  472. nautobot/project-static/docs/user-guide/feature-guides/getting-started/search-bar.html +4 -46
  473. nautobot/project-static/docs/user-guide/feature-guides/getting-started/tenants.html +4 -46
  474. nautobot/project-static/docs/user-guide/feature-guides/getting-started/vlans-and-vlan-groups.html +4 -46
  475. nautobot/project-static/docs/user-guide/feature-guides/git-data-source.html +7 -51
  476. nautobot/project-static/docs/user-guide/feature-guides/graphql.html +4 -46
  477. nautobot/project-static/docs/user-guide/feature-guides/ip-address-merge-tool.html +4 -46
  478. nautobot/project-static/docs/user-guide/feature-guides/relationships.html +4 -46
  479. nautobot/project-static/docs/user-guide/feature-guides/software-image-files-and-versions.html +7 -49
  480. nautobot/project-static/docs/user-guide/index.html +4 -46
  481. nautobot/project-static/docs/user-guide/platform-functionality/change-logging.html +4 -46
  482. nautobot/project-static/docs/user-guide/platform-functionality/computedfield.html +8 -50
  483. nautobot/project-static/docs/user-guide/platform-functionality/customfield.html +4 -46
  484. nautobot/project-static/docs/user-guide/platform-functionality/customlink.html +4 -46
  485. nautobot/project-static/docs/user-guide/platform-functionality/dynamicgroup.html +4 -46
  486. nautobot/project-static/docs/user-guide/platform-functionality/events.html +4 -46
  487. nautobot/project-static/docs/user-guide/platform-functionality/exporttemplate.html +4 -46
  488. nautobot/project-static/docs/user-guide/platform-functionality/externalintegration.html +4 -46
  489. nautobot/project-static/docs/user-guide/platform-functionality/gitrepository.html +4 -46
  490. nautobot/project-static/docs/user-guide/platform-functionality/graphql.html +4 -46
  491. nautobot/project-static/docs/user-guide/platform-functionality/graphqlquery.html +4 -46
  492. nautobot/project-static/docs/user-guide/platform-functionality/imageattachment.html +4 -46
  493. nautobot/project-static/docs/user-guide/platform-functionality/jobs/index.html +7 -50
  494. nautobot/project-static/docs/user-guide/platform-functionality/jobs/job-scheduling-and-approvals.html +4 -46
  495. nautobot/project-static/docs/user-guide/platform-functionality/jobs/jobbutton.html +7 -49
  496. nautobot/project-static/docs/user-guide/platform-functionality/jobs/jobhook.html +4 -46
  497. nautobot/project-static/docs/user-guide/platform-functionality/jobs/jobqueue.html +4 -46
  498. nautobot/project-static/docs/user-guide/platform-functionality/jobs/models.html +4 -46
  499. nautobot/project-static/docs/user-guide/platform-functionality/napalm.html +4 -46
  500. nautobot/project-static/docs/user-guide/platform-functionality/note.html +4 -46
  501. nautobot/project-static/docs/user-guide/platform-functionality/objectmetadata.html +4 -46
  502. nautobot/project-static/docs/user-guide/platform-functionality/relationship.html +5 -47
  503. nautobot/project-static/docs/user-guide/platform-functionality/rendering-jinja-templates.html +4 -46
  504. nautobot/project-static/docs/user-guide/platform-functionality/rest-api/authentication.html +4 -46
  505. nautobot/project-static/docs/user-guide/platform-functionality/rest-api/filtering.html +25 -94
  506. nautobot/project-static/docs/user-guide/platform-functionality/rest-api/overview.html +5 -74
  507. nautobot/project-static/docs/user-guide/platform-functionality/rest-api/ui-related-endpoints.html +4 -46
  508. nautobot/project-static/docs/user-guide/platform-functionality/role.html +4 -46
  509. nautobot/project-static/docs/user-guide/platform-functionality/savedview.html +4 -46
  510. nautobot/project-static/docs/user-guide/platform-functionality/secret.html +4 -46
  511. nautobot/project-static/docs/user-guide/platform-functionality/staticgroupassociation.html +4 -46
  512. nautobot/project-static/docs/user-guide/platform-functionality/status.html +4 -46
  513. nautobot/project-static/docs/user-guide/platform-functionality/tag.html +4 -46
  514. nautobot/project-static/docs/user-guide/platform-functionality/template-filters.html +4 -46
  515. nautobot/project-static/docs/user-guide/platform-functionality/users/objectpermission.html +4 -46
  516. nautobot/project-static/docs/user-guide/platform-functionality/users/token.html +4 -46
  517. nautobot/project-static/docs/user-guide/platform-functionality/webhook.html +4 -46
  518. nautobot/project-static/js/forms.js +1 -1
  519. nautobot/tenancy/api/views.py +13 -9
  520. nautobot/tenancy/views.py +2 -4
  521. nautobot/users/admin.py +1 -1
  522. nautobot/users/api/serializers.py +4 -5
  523. nautobot/users/api/views.py +3 -3
  524. nautobot/virtualization/api/serializers.py +4 -4
  525. nautobot/virtualization/api/views.py +24 -5
  526. nautobot/virtualization/filters.py +3 -20
  527. nautobot/virtualization/models.py +1 -1
  528. nautobot/virtualization/tables.py +2 -2
  529. nautobot/virtualization/templates/virtualization/cluster_edit.html +7 -1
  530. nautobot/virtualization/templates/virtualization/virtualmachine.html +9 -1
  531. nautobot/virtualization/templates/virtualization/virtualmachine_edit.html +8 -2
  532. nautobot/virtualization/tests/test_filters.py +0 -17
  533. nautobot/wireless/filters.py +2 -2
  534. nautobot/wireless/forms.py +1 -1
  535. nautobot/wireless/templates/wireless/wirelessnetwork_retrieve.html +9 -1
  536. nautobot/wireless/tests/test_filters.py +1 -29
  537. nautobot/wireless/views.py +10 -0
  538. {nautobot-2.4.0.dist-info → nautobot-2.4.0b1.dist-info}/METADATA +6 -6
  539. {nautobot-2.4.0.dist-info → nautobot-2.4.0b1.dist-info}/RECORD +543 -591
  540. {nautobot-2.4.0.dist-info → nautobot-2.4.0b1.dist-info}/WHEEL +1 -1
  541. nautobot/core/api/constants.py +0 -11
  542. nautobot/core/jobs/bulk_actions.py +0 -248
  543. nautobot/core/templates/about.html +0 -67
  544. nautobot/core/templates/inc/tenancy_form_panel.html +0 -9
  545. nautobot/core/templates/inc/tenant_table_row.html +0 -11
  546. nautobot/core/utils/querysets.py +0 -64
  547. nautobot/dcim/migrations/0067_controllermanageddevicegroup_tenant.py +0 -25
  548. nautobot/dcim/tests/integration/test_controller.py +0 -62
  549. nautobot/dcim/tests/integration/test_controller_managed_device_group.py +0 -71
  550. nautobot/dcim/tests/test_jobs.py +0 -118
  551. nautobot/extras/migrations/0120_job_is_singleton_job_is_singleton_override.py +0 -22
  552. nautobot/extras/migrations/0121_alter_team_contacts.py +0 -17
  553. nautobot/extras/test_jobs/singleton.py +0 -16
  554. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_edit.png +0 -0
  555. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_edit_button.png +0 -0
  556. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_list_nav.png +0 -0
  557. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_list_view.png +0 -0
  558. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_queue.png +0 -0
  559. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_queue_add.png +0 -0
  560. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_queue_config.png +0 -0
  561. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_result_completed.png +0 -0
  562. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_result_nav.png +0 -0
  563. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_result_pending.png +0 -0
  564. nautobot/project-static/docs/media/development/core/kubernetes/k8s_job_run_form.png +0 -0
  565. nautobot/project-static/docs/media/development/core/kubernetes/k8s_nautobot_login.png +0 -0
  566. nautobot/project-static/docs/media/development/core/kubernetes/k8s_run_job.png +0 -0
  567. nautobot/project-static/docs/media/development/core/kubernetes/k8s_run_scheduled_job_form.png +0 -0
  568. nautobot/project-static/docs/media/development/core/kubernetes/k8s_scheduled_job_result.png +0 -0
  569. nautobot/project-static/docs/media/development/core/ui-component-framework/buttons-example.png +0 -0
  570. nautobot/project-static/docs/media/development/core/ui-component-framework/cluster-type-before-after-example.png +0 -0
  571. nautobot/project-static/docs/media/development/core/ui-component-framework/object-fields-panel-example_2.png +0 -0
  572. nautobot/project-static/docs/media/development/core/ui-component-framework/stats-panel-example-code.png +0 -0
  573. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/central-mode.png +0 -0
  574. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/device-group-add.png +0 -0
  575. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/device-group-create-1.png +0 -0
  576. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/device-group-create-2.png +0 -0
  577. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/radio-profile-add.png +0 -0
  578. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/radio-profile-create.png +0 -0
  579. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/supported-data-rate-add.png +0 -0
  580. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/supported-data-rate-create.png +0 -0
  581. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/wireless-controller-add.png +0 -0
  582. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/wireless-controller-create-1.png +0 -0
  583. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/wireless-controller-create-2.png +0 -0
  584. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/wireless-network-add.png +0 -0
  585. nautobot/project-static/docs/user-guide/feature-guides/images/wireless/wireless-network-create.png +0 -0
  586. nautobot/project-static/docs/user-guide/feature-guides/wireless-networks-and-controllers.html +0 -9444
  587. nautobot/project-static/docs/user-guide/platform-functionality/jobs/kubernetes-job-support.html +0 -9722
  588. nautobot/wireless/tests/integration/__init__.py +0 -0
  589. nautobot/wireless/tests/integration/test_radio_profile.py +0 -42
  590. {nautobot-2.4.0.dist-info → nautobot-2.4.0b1.dist-info}/LICENSE.txt +0 -0
  591. {nautobot-2.4.0.dist-info → nautobot-2.4.0b1.dist-info}/NOTICE +0 -0
  592. {nautobot-2.4.0.dist-info → nautobot-2.4.0b1.dist-info}/entry_points.txt +0 -0
@@ -18,7 +18,7 @@
18
18
 
19
19
 
20
20
  <link rel="icon" href="../../../assets/favicon.ico">
21
- <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49">
21
+ <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.46">
22
22
 
23
23
 
24
24
 
@@ -2112,27 +2112,6 @@
2112
2112
 
2113
2113
 
2114
2114
 
2115
-
2116
-
2117
-
2118
-
2119
-
2120
-
2121
- <li class="md-nav__item">
2122
- <a href="../../../user-guide/feature-guides/wireless-networks-and-controllers.html" class="md-nav__link">
2123
-
2124
-
2125
- <span class="md-ellipsis">
2126
- Wireless Networks and Controllers
2127
- </span>
2128
-
2129
-
2130
- </a>
2131
- </li>
2132
-
2133
-
2134
-
2135
-
2136
2115
  </ul>
2137
2116
  </nav>
2138
2117
 
@@ -5152,27 +5131,6 @@
5152
5131
 
5153
5132
 
5154
5133
 
5155
- <li class="md-nav__item">
5156
- <a href="../../../user-guide/platform-functionality/jobs/kubernetes-job-support.html" class="md-nav__link">
5157
-
5158
-
5159
- <span class="md-ellipsis">
5160
- Kubernetes Job Support
5161
- </span>
5162
-
5163
-
5164
- </a>
5165
- </li>
5166
-
5167
-
5168
-
5169
-
5170
-
5171
-
5172
-
5173
-
5174
-
5175
-
5176
5134
  <li class="md-nav__item">
5177
5135
  <a href="../../../user-guide/platform-functionality/jobs/jobbutton.html" class="md-nav__link">
5178
5136
 
@@ -7443,15 +7401,6 @@
7443
7401
  </span>
7444
7402
  </a>
7445
7403
 
7446
- </li>
7447
-
7448
- <li class="md-nav__item">
7449
- <a href="#nautobot.apps.jobs.BaseJob.singleton_cache_key" class="md-nav__link">
7450
- <span class="md-ellipsis">
7451
- singleton_cache_key
7452
- </span>
7453
- </a>
7454
-
7455
7404
  </li>
7456
7405
 
7457
7406
  </ul>
@@ -8683,11 +8632,11 @@
8683
8632
 
8684
8633
 
8685
8634
  <li class="md-nav__item">
8686
- <a href="../../../development/core/minikube-dev-environment-for-k8s-jobs.html" class="md-nav__link">
8635
+ <a href="../../../development/core/local-k8s.html" class="md-nav__link">
8687
8636
 
8688
8637
 
8689
8638
  <span class="md-ellipsis">
8690
- Minikube Dev Environment for K8s Jobs
8639
+ Local Kubernetes Cluster
8691
8640
  </span>
8692
8641
 
8693
8642
 
@@ -9800,15 +9749,6 @@
9800
9749
  </span>
9801
9750
  </a>
9802
9751
 
9803
- </li>
9804
-
9805
- <li class="md-nav__item">
9806
- <a href="#nautobot.apps.jobs.BaseJob.singleton_cache_key" class="md-nav__link">
9807
- <span class="md-ellipsis">
9808
- singleton_cache_key
9809
- </span>
9810
- </a>
9811
-
9812
9752
  </li>
9813
9753
 
9814
9754
  </ul>
@@ -10170,12 +10110,7 @@
10170
10110
 
10171
10111
  <div class="doc doc-contents first">
10172
10112
 
10173
- <p>Nautobot Jobs API.</p>
10174
-
10175
-
10176
-
10177
-
10178
-
10113
+ <p>Nautobot Jobs API.</p>
10179
10114
 
10180
10115
 
10181
10116
 
@@ -10202,7 +10137,7 @@
10202
10137
  <div class="doc doc-contents ">
10203
10138
 
10204
10139
 
10205
- <p>Base model for jobs.</p>
10140
+ <p>Base model for jobs.</p>
10206
10141
  <p>Users can subclass this directly if they want to provide their own base class for implementing multiple jobs
10207
10142
  with shared functionality; if no such sharing is required, use Job class instead.</p>
10208
10143
  <p>Jobs must define at minimum a run method.</p>
@@ -10210,11 +10145,6 @@ with shared functionality; if no such sharing is required, use Job class instead
10210
10145
 
10211
10146
 
10212
10147
 
10213
-
10214
-
10215
-
10216
-
10217
-
10218
10148
  <div class="doc doc-children">
10219
10149
 
10220
10150
 
@@ -10238,28 +10168,20 @@ with shared functionality; if no such sharing is required, use Job class instead
10238
10168
  <div class="doc doc-contents ">
10239
10169
 
10240
10170
 
10241
- <p>Metaclass attributes - subclasses can define any or all of the following attributes:</p>
10171
+ <p>Metaclass attributes - subclasses can define any or all of the following attributes:</p>
10242
10172
  <ul>
10243
10173
  <li>name (str)</li>
10244
10174
  <li>description (str)</li>
10245
- <li>approval_required (bool)</li>
10246
- <li>dryrun_default (bool)</li>
10247
- <li>field_order (list)</li>
10248
- <li>has_sensitive_variables (bool)</li>
10249
10175
  <li>hidden (bool)</li>
10176
+ <li>field_order (list)</li>
10177
+ <li>approval_required (bool)</li>
10250
10178
  <li>soft_time_limit (int)</li>
10251
- <li>task_queues (list)</li>
10252
- <li>template_name (str)</li>
10253
10179
  <li>time_limit (int)</li>
10254
- <li>is_singleton (bool)</li>
10180
+ <li>has_sensitive_variables (bool)</li>
10181
+ <li>task_queues (list)</li>
10255
10182
  </ul>
10256
10183
 
10257
10184
 
10258
-
10259
-
10260
-
10261
-
10262
-
10263
10185
  </div>
10264
10186
 
10265
10187
  </div>
@@ -10276,7 +10198,7 @@ with shared functionality; if no such sharing is required, use Job class instead
10276
10198
 
10277
10199
  <div class="doc doc-contents ">
10278
10200
 
10279
- <p>Handler called after the task returns.</p>
10201
+ <p>Handler called after the task returns.</p>
10280
10202
 
10281
10203
 
10282
10204
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -10291,11 +10213,9 @@ with shared functionality; if no such sharing is required, use Job class instead
10291
10213
  </thead>
10292
10214
  <tbody>
10293
10215
  <tr class="doc-section-item">
10216
+ <td><code>status</code></td>
10294
10217
  <td>
10295
- <code>status</code>
10296
- </td>
10297
- <td>
10298
- <code>str</code>
10218
+ <code><autoref identifier="str" optional>str</autoref></code>
10299
10219
  </td>
10300
10220
  <td>
10301
10221
  <div class="doc-md-description">
@@ -10307,11 +10227,9 @@ with shared functionality; if no such sharing is required, use Job class instead
10307
10227
  </td>
10308
10228
  </tr>
10309
10229
  <tr class="doc-section-item">
10230
+ <td><code>retval</code></td>
10310
10231
  <td>
10311
- <code>retval</code>
10312
- </td>
10313
- <td>
10314
- <code>Any</code>
10232
+ <code><autoref identifier="Any" optional>Any</autoref></code>
10315
10233
  </td>
10316
10234
  <td>
10317
10235
  <div class="doc-md-description">
@@ -10323,11 +10241,9 @@ with shared functionality; if no such sharing is required, use Job class instead
10323
10241
  </td>
10324
10242
  </tr>
10325
10243
  <tr class="doc-section-item">
10244
+ <td><code>task_id</code></td>
10326
10245
  <td>
10327
- <code>task_id</code>
10328
- </td>
10329
- <td>
10330
- <code>str</code>
10246
+ <code><autoref identifier="str" optional>str</autoref></code>
10331
10247
  </td>
10332
10248
  <td>
10333
10249
  <div class="doc-md-description">
@@ -10339,11 +10255,9 @@ with shared functionality; if no such sharing is required, use Job class instead
10339
10255
  </td>
10340
10256
  </tr>
10341
10257
  <tr class="doc-section-item">
10258
+ <td><code>args</code></td>
10342
10259
  <td>
10343
- <code>args</code>
10344
- </td>
10345
- <td>
10346
- <code>tuple</code>
10260
+ <code><autoref identifier="tuple" optional>tuple</autoref></code>
10347
10261
  </td>
10348
10262
  <td>
10349
10263
  <div class="doc-md-description">
@@ -10355,11 +10269,9 @@ with shared functionality; if no such sharing is required, use Job class instead
10355
10269
  </td>
10356
10270
  </tr>
10357
10271
  <tr class="doc-section-item">
10272
+ <td><code>kwargs</code></td>
10358
10273
  <td>
10359
- <code>kwargs</code>
10360
- </td>
10361
- <td>
10362
- <code>dict</code>
10274
+ <code><autoref identifier="dict" optional>dict</autoref></code>
10363
10275
  </td>
10364
10276
  <td>
10365
10277
  <div class="doc-md-description">
@@ -10371,11 +10283,9 @@ with shared functionality; if no such sharing is required, use Job class instead
10371
10283
  </td>
10372
10284
  </tr>
10373
10285
  <tr class="doc-section-item">
10286
+ <td><code>einfo</code></td>
10374
10287
  <td>
10375
- <code>einfo</code>
10376
- </td>
10377
- <td>
10378
- <code><span title="billiard.einfo.ExceptionInfo">ExceptionInfo</span></code>
10288
+ <code><autoref identifier="billiard.einfo.ExceptionInfo" optional hover>ExceptionInfo</autoref></code>
10379
10289
  </td>
10380
10290
  <td>
10381
10291
  <div class="doc-md-description">
@@ -10431,7 +10341,7 @@ with shared functionality; if no such sharing is required, use Job class instead
10431
10341
 
10432
10342
  <div class="doc doc-contents ">
10433
10343
 
10434
- <p>Return a Django form suitable for populating the context data required to run this Job.</p>
10344
+ <p>Return a Django form suitable for populating the context data required to run this Job.</p>
10435
10345
  <p><code>approval_view</code> will disable all fields from modification and is used to display the form
10436
10346
  during a approval review workflow.</p>
10437
10347
 
@@ -10454,7 +10364,7 @@ during a approval review workflow.</p>
10454
10364
 
10455
10365
  <div class="doc doc-contents ">
10456
10366
 
10457
- <p>Dynamically generate a Django form class corresponding to the variables in this Job.</p>
10367
+ <p>Dynamically generate a Django form class corresponding to the variables in this Job.</p>
10458
10368
  <p>In most cases you should use <code>.as_form()</code> instead of calling this method directly.</p>
10459
10369
 
10460
10370
  </div>
@@ -10472,7 +10382,7 @@ during a approval review workflow.</p>
10472
10382
 
10473
10383
  <div class="doc doc-contents ">
10474
10384
 
10475
- <p>Handler called before the task starts.</p>
10385
+ <p>Handler called before the task starts.</p>
10476
10386
 
10477
10387
 
10478
10388
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -10487,11 +10397,9 @@ during a approval review workflow.</p>
10487
10397
  </thead>
10488
10398
  <tbody>
10489
10399
  <tr class="doc-section-item">
10400
+ <td><code>task_id</code></td>
10490
10401
  <td>
10491
- <code>task_id</code>
10492
- </td>
10493
- <td>
10494
- <code>str</code>
10402
+ <code><autoref identifier="str" optional>str</autoref></code>
10495
10403
  </td>
10496
10404
  <td>
10497
10405
  <div class="doc-md-description">
@@ -10503,11 +10411,9 @@ during a approval review workflow.</p>
10503
10411
  </td>
10504
10412
  </tr>
10505
10413
  <tr class="doc-section-item">
10414
+ <td><code>args</code></td>
10506
10415
  <td>
10507
- <code>args</code>
10508
- </td>
10509
- <td>
10510
- <code>Tuple</code>
10416
+ <code><autoref identifier="Tuple" optional>Tuple</autoref></code>
10511
10417
  </td>
10512
10418
  <td>
10513
10419
  <div class="doc-md-description">
@@ -10519,11 +10425,9 @@ during a approval review workflow.</p>
10519
10425
  </td>
10520
10426
  </tr>
10521
10427
  <tr class="doc-section-item">
10428
+ <td><code>kwargs</code></td>
10522
10429
  <td>
10523
- <code>kwargs</code>
10524
- </td>
10525
- <td>
10526
- <code>Dict</code>
10430
+ <code><autoref identifier="Dict" optional>Dict</autoref></code>
10527
10431
  </td>
10528
10432
  <td>
10529
10433
  <div class="doc-md-description">
@@ -10575,7 +10479,7 @@ during a approval review workflow.</p>
10575
10479
 
10576
10480
  <div class="doc doc-contents ">
10577
10481
 
10578
- <p>Unique identifier of a specific Job class, in the form <module_name>.<ClassName>.</p>
10482
+ <p>Unique identifier of a specific Job class, in the form <module_name>.<ClassName>.</p>
10579
10483
  <p>Examples:
10580
10484
  - my_script.MyScript - Local Job
10581
10485
  - nautobot.core.jobs.MySystemJob - System Job
@@ -10597,7 +10501,7 @@ during a approval review workflow.</p>
10597
10501
 
10598
10502
  <div class="doc doc-contents ">
10599
10503
 
10600
- <p>Dotted class_path, suitable for use in things like Python logger names.</p>
10504
+ <p>Dotted class_path, suitable for use in things like Python logger names.</p>
10601
10505
  <p>Deprecated as of Nautobot 2.0: just use .class_path instead.</p>
10602
10506
 
10603
10507
  </div>
@@ -10615,7 +10519,7 @@ during a approval review workflow.</p>
10615
10519
 
10616
10520
  <div class="doc doc-contents ">
10617
10521
 
10618
- <p>Escape various characters so that the class_path can be used as a jQuery selector.</p>
10522
+ <p>Escape various characters so that the class_path can be used as a jQuery selector.</p>
10619
10523
 
10620
10524
  </div>
10621
10525
 
@@ -10632,7 +10536,7 @@ during a approval review workflow.</p>
10632
10536
 
10633
10537
  <div class="doc doc-contents ">
10634
10538
 
10635
- <p>Create a file that can later be downloaded by users.</p>
10539
+ <p>Create a file that can later be downloaded by users.</p>
10636
10540
 
10637
10541
 
10638
10542
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -10647,11 +10551,9 @@ during a approval review workflow.</p>
10647
10551
  </thead>
10648
10552
  <tbody>
10649
10553
  <tr class="doc-section-item">
10554
+ <td><code>filename</code></td>
10650
10555
  <td>
10651
- <code>filename</code>
10652
- </td>
10653
- <td>
10654
- <code>str</code>
10556
+ <code><autoref identifier="str" optional>str</autoref></code>
10655
10557
  </td>
10656
10558
  <td>
10657
10559
  <div class="doc-md-description">
@@ -10663,11 +10565,9 @@ during a approval review workflow.</p>
10663
10565
  </td>
10664
10566
  </tr>
10665
10567
  <tr class="doc-section-item">
10568
+ <td><code>content</code></td>
10666
10569
  <td>
10667
- <code>content</code>
10668
- </td>
10669
- <td>
10670
- <code>(str, bytes)</code>
10570
+ <code>(<autoref identifier="str" optional>str</autoref>, <autoref identifier="bytes" optional>bytes</autoref>)</code>
10671
10571
  </td>
10672
10572
  <td>
10673
10573
  <div class="doc-md-description">
@@ -10693,7 +10593,7 @@ during a approval review workflow.</p>
10693
10593
  <tbody>
10694
10594
  <tr class="doc-section-item">
10695
10595
  <td>
10696
- <code>ValueError</code>
10596
+ <code><autoref identifier="ValueError" optional>ValueError</autoref></code>
10697
10597
  </td>
10698
10598
  <td>
10699
10599
  <div class="doc-md-description">
@@ -10716,7 +10616,7 @@ during a approval review workflow.</p>
10716
10616
  <tbody>
10717
10617
  <tr class="doc-section-item">
10718
10618
  <td>
10719
- <code><span title="nautobot.extras.models.FileProxy">FileProxy</span></code>
10619
+ <code><autoref identifier="nautobot.extras.models.FileProxy" optional hover>FileProxy</autoref></code>
10720
10620
  </td>
10721
10621
  <td>
10722
10622
  <div class="doc-md-description">
@@ -10746,7 +10646,7 @@ during a approval review workflow.</p>
10746
10646
 
10747
10647
  <div class="doc doc-contents ">
10748
10648
 
10749
- <p>Given data input for a job execution, deserialize it by resolving object references using defined variables.</p>
10649
+ <p>Given data input for a job execution, deserialize it by resolving object references using defined variables.</p>
10750
10650
  <p>This converts a list of pk's back into a QuerySet for MultiObjectVar instances and single pk values into
10751
10651
  model instances for ObjectVar.</p>
10752
10652
  <p>Note that when resolving querysets or model instances by their PK, we do not catch DoesNotExist
@@ -10768,7 +10668,7 @@ path would consider this a failure of the job execution, as described in <code>n
10768
10668
 
10769
10669
  <div class="doc doc-contents ">
10770
10670
 
10771
- <p>Deprecated as of Nautobot 2.2.3.</p>
10671
+ <p>Deprecated as of Nautobot 2.2.3.</p>
10772
10672
 
10773
10673
  </div>
10774
10674
 
@@ -10785,7 +10685,7 @@ path would consider this a failure of the job execution, as described in <code>n
10785
10685
 
10786
10686
  <div class="doc doc-contents ">
10787
10687
 
10788
- <p>Return data from a JSON file</p>
10688
+ <p>Return data from a JSON file</p>
10789
10689
 
10790
10690
  </div>
10791
10691
 
@@ -10802,7 +10702,7 @@ path would consider this a failure of the job execution, as described in <code>n
10802
10702
 
10803
10703
  <div class="doc doc-contents ">
10804
10704
 
10805
- <p>Return data from a YAML file</p>
10705
+ <p>Return data from a YAML file</p>
10806
10706
 
10807
10707
  </div>
10808
10708
 
@@ -10819,7 +10719,7 @@ path would consider this a failure of the job execution, as described in <code>n
10819
10719
 
10820
10720
  <div class="doc doc-contents ">
10821
10721
 
10822
- <p>Error handler.</p>
10722
+ <p>Error handler.</p>
10823
10723
  <p>This is run by the worker when the task fails.</p>
10824
10724
 
10825
10725
 
@@ -10835,11 +10735,9 @@ path would consider this a failure of the job execution, as described in <code>n
10835
10735
  </thead>
10836
10736
  <tbody>
10837
10737
  <tr class="doc-section-item">
10738
+ <td><code>exc</code></td>
10838
10739
  <td>
10839
- <code>exc</code>
10840
- </td>
10841
- <td>
10842
- <code>Exception</code>
10740
+ <code><autoref identifier="Exception" optional>Exception</autoref></code>
10843
10741
  </td>
10844
10742
  <td>
10845
10743
  <div class="doc-md-description">
@@ -10851,11 +10749,9 @@ path would consider this a failure of the job execution, as described in <code>n
10851
10749
  </td>
10852
10750
  </tr>
10853
10751
  <tr class="doc-section-item">
10752
+ <td><code>task_id</code></td>
10854
10753
  <td>
10855
- <code>task_id</code>
10856
- </td>
10857
- <td>
10858
- <code>str</code>
10754
+ <code><autoref identifier="str" optional>str</autoref></code>
10859
10755
  </td>
10860
10756
  <td>
10861
10757
  <div class="doc-md-description">
@@ -10867,11 +10763,9 @@ path would consider this a failure of the job execution, as described in <code>n
10867
10763
  </td>
10868
10764
  </tr>
10869
10765
  <tr class="doc-section-item">
10766
+ <td><code>args</code></td>
10870
10767
  <td>
10871
- <code>args</code>
10872
- </td>
10873
- <td>
10874
- <code>Tuple</code>
10768
+ <code><autoref identifier="Tuple" optional>Tuple</autoref></code>
10875
10769
  </td>
10876
10770
  <td>
10877
10771
  <div class="doc-md-description">
@@ -10883,11 +10777,9 @@ path would consider this a failure of the job execution, as described in <code>n
10883
10777
  </td>
10884
10778
  </tr>
10885
10779
  <tr class="doc-section-item">
10780
+ <td><code>kwargs</code></td>
10886
10781
  <td>
10887
- <code>kwargs</code>
10888
- </td>
10889
- <td>
10890
- <code>Dict</code>
10782
+ <code><autoref identifier="Dict" optional>Dict</autoref></code>
10891
10783
  </td>
10892
10784
  <td>
10893
10785
  <div class="doc-md-description">
@@ -10899,11 +10791,9 @@ path would consider this a failure of the job execution, as described in <code>n
10899
10791
  </td>
10900
10792
  </tr>
10901
10793
  <tr class="doc-section-item">
10794
+ <td><code>einfo</code></td>
10902
10795
  <td>
10903
- <code>einfo</code>
10904
- </td>
10905
- <td>
10906
- <code>~<span title="billiard.einfo.ExceptionInfo">ExceptionInfo</span></code>
10796
+ <code>~<autoref identifier="billiard.einfo.ExceptionInfo" optional hover>ExceptionInfo</autoref></code>
10907
10797
  </td>
10908
10798
  <td>
10909
10799
  <div class="doc-md-description">
@@ -10955,7 +10845,7 @@ path would consider this a failure of the job execution, as described in <code>n
10955
10845
 
10956
10846
  <div class="doc doc-contents ">
10957
10847
 
10958
- <p>Retry handler.</p>
10848
+ <p>Retry handler.</p>
10959
10849
  <p>This is run by the worker when the task is to be retried.</p>
10960
10850
 
10961
10851
 
@@ -10971,11 +10861,9 @@ path would consider this a failure of the job execution, as described in <code>n
10971
10861
  </thead>
10972
10862
  <tbody>
10973
10863
  <tr class="doc-section-item">
10864
+ <td><code>exc</code></td>
10974
10865
  <td>
10975
- <code>exc</code>
10976
- </td>
10977
- <td>
10978
- <code>Exception</code>
10866
+ <code><autoref identifier="Exception" optional>Exception</autoref></code>
10979
10867
  </td>
10980
10868
  <td>
10981
10869
  <div class="doc-md-description">
@@ -10987,11 +10875,9 @@ path would consider this a failure of the job execution, as described in <code>n
10987
10875
  </td>
10988
10876
  </tr>
10989
10877
  <tr class="doc-section-item">
10878
+ <td><code>task_id</code></td>
10990
10879
  <td>
10991
- <code>task_id</code>
10992
- </td>
10993
- <td>
10994
- <code>str</code>
10880
+ <code><autoref identifier="str" optional>str</autoref></code>
10995
10881
  </td>
10996
10882
  <td>
10997
10883
  <div class="doc-md-description">
@@ -11003,11 +10889,9 @@ path would consider this a failure of the job execution, as described in <code>n
11003
10889
  </td>
11004
10890
  </tr>
11005
10891
  <tr class="doc-section-item">
10892
+ <td><code>args</code></td>
11006
10893
  <td>
11007
- <code>args</code>
11008
- </td>
11009
- <td>
11010
- <code>Tuple</code>
10894
+ <code><autoref identifier="Tuple" optional>Tuple</autoref></code>
11011
10895
  </td>
11012
10896
  <td>
11013
10897
  <div class="doc-md-description">
@@ -11019,11 +10903,9 @@ path would consider this a failure of the job execution, as described in <code>n
11019
10903
  </td>
11020
10904
  </tr>
11021
10905
  <tr class="doc-section-item">
10906
+ <td><code>kwargs</code></td>
11022
10907
  <td>
11023
- <code>kwargs</code>
11024
- </td>
11025
- <td>
11026
- <code>Dict</code>
10908
+ <code><autoref identifier="Dict" optional>Dict</autoref></code>
11027
10909
  </td>
11028
10910
  <td>
11029
10911
  <div class="doc-md-description">
@@ -11035,11 +10917,9 @@ path would consider this a failure of the job execution, as described in <code>n
11035
10917
  </td>
11036
10918
  </tr>
11037
10919
  <tr class="doc-section-item">
10920
+ <td><code>einfo</code></td>
11038
10921
  <td>
11039
- <code>einfo</code>
11040
- </td>
11041
- <td>
11042
- <code>~<span title="billiard.einfo.ExceptionInfo">ExceptionInfo</span></code>
10922
+ <code>~<autoref identifier="billiard.einfo.ExceptionInfo" optional hover>ExceptionInfo</autoref></code>
11043
10923
  </td>
11044
10924
  <td>
11045
10925
  <div class="doc-md-description">
@@ -11091,7 +10971,7 @@ path would consider this a failure of the job execution, as described in <code>n
11091
10971
 
11092
10972
  <div class="doc doc-contents ">
11093
10973
 
11094
- <p>Success handler.</p>
10974
+ <p>Success handler.</p>
11095
10975
  <p>Run by the worker if the task executes successfully.</p>
11096
10976
 
11097
10977
 
@@ -11107,11 +10987,9 @@ path would consider this a failure of the job execution, as described in <code>n
11107
10987
  </thead>
11108
10988
  <tbody>
11109
10989
  <tr class="doc-section-item">
10990
+ <td><code>retval</code></td>
11110
10991
  <td>
11111
- <code>retval</code>
11112
- </td>
11113
- <td>
11114
- <code>Any</code>
10992
+ <code><autoref identifier="Any" optional>Any</autoref></code>
11115
10993
  </td>
11116
10994
  <td>
11117
10995
  <div class="doc-md-description">
@@ -11123,11 +11001,9 @@ path would consider this a failure of the job execution, as described in <code>n
11123
11001
  </td>
11124
11002
  </tr>
11125
11003
  <tr class="doc-section-item">
11004
+ <td><code>task_id</code></td>
11126
11005
  <td>
11127
- <code>task_id</code>
11128
- </td>
11129
- <td>
11130
- <code>str</code>
11006
+ <code><autoref identifier="str" optional>str</autoref></code>
11131
11007
  </td>
11132
11008
  <td>
11133
11009
  <div class="doc-md-description">
@@ -11139,11 +11015,9 @@ path would consider this a failure of the job execution, as described in <code>n
11139
11015
  </td>
11140
11016
  </tr>
11141
11017
  <tr class="doc-section-item">
11018
+ <td><code>args</code></td>
11142
11019
  <td>
11143
- <code>args</code>
11144
- </td>
11145
- <td>
11146
- <code>Tuple</code>
11020
+ <code><autoref identifier="Tuple" optional>Tuple</autoref></code>
11147
11021
  </td>
11148
11022
  <td>
11149
11023
  <div class="doc-md-description">
@@ -11155,11 +11029,9 @@ path would consider this a failure of the job execution, as described in <code>n
11155
11029
  </td>
11156
11030
  </tr>
11157
11031
  <tr class="doc-section-item">
11032
+ <td><code>kwargs</code></td>
11158
11033
  <td>
11159
- <code>kwargs</code>
11160
- </td>
11161
- <td>
11162
- <code>Dict</code>
11034
+ <code><autoref identifier="Dict" optional>Dict</autoref></code>
11163
11035
  </td>
11164
11036
  <td>
11165
11037
  <div class="doc-md-description">
@@ -11215,7 +11087,7 @@ path would consider this a failure of the job execution, as described in <code>n
11215
11087
 
11216
11088
  <div class="doc doc-contents ">
11217
11089
 
11218
- <p>Process dict and return kwargs that exist as ScriptVariables on this job.</p>
11090
+ <p>Process dict and return kwargs that exist as ScriptVariables on this job.</p>
11219
11091
 
11220
11092
  </div>
11221
11093
 
@@ -11232,7 +11104,7 @@ path would consider this a failure of the job execution, as described in <code>n
11232
11104
 
11233
11105
  <div class="doc doc-contents ">
11234
11106
 
11235
- <p>Return all relevant classproperties as a dict.</p>
11107
+ <p>Return all relevant classproperties as a dict.</p>
11236
11108
  <p>Used for convenient rendering into job_edit.html via the <code>json_script</code> template tag.</p>
11237
11109
 
11238
11110
  </div>
@@ -11250,7 +11122,7 @@ path would consider this a failure of the job execution, as described in <code>n
11250
11122
 
11251
11123
  <div class="doc doc-contents ">
11252
11124
 
11253
- <p>Deprecated - use class_path classproperty instead.</p>
11125
+ <p>Deprecated - use class_path classproperty instead.</p>
11254
11126
 
11255
11127
  </div>
11256
11128
 
@@ -11267,7 +11139,7 @@ path would consider this a failure of the job execution, as described in <code>n
11267
11139
 
11268
11140
  <div class="doc doc-contents ">
11269
11141
 
11270
- <p>Method invoked when this Job is run.</p>
11142
+ <p>Method invoked when this Job is run.</p>
11271
11143
 
11272
11144
  </div>
11273
11145
 
@@ -11288,7 +11160,7 @@ path would consider this a failure of the job execution, as described in <code>n
11288
11160
 
11289
11161
  <div class="doc doc-contents ">
11290
11162
 
11291
- <p>This method parses input data (from JobForm usually) and returns a dict which is safe to serialize</p>
11163
+ <p>This method parses input data (from JobForm usually) and returns a dict which is safe to serialize</p>
11292
11164
  <p>Here we convert the QuerySet of a MultiObjectVar to a list of the pk's and the model instance
11293
11165
  of an ObjectVar into the pk value.</p>
11294
11166
  <p>These are converted back during job execution.</p>
@@ -11297,23 +11169,6 @@ of an ObjectVar into the pk value.</p>
11297
11169
 
11298
11170
  </div>
11299
11171
 
11300
- <div class="doc doc-object doc-function">
11301
-
11302
-
11303
- <h3 id="nautobot.apps.jobs.BaseJob.singleton_cache_key" class="doc doc-heading">
11304
- <code class="highlight language-python"><span class="n">singleton_cache_key</span><span class="p">()</span></code>
11305
-
11306
- <a href="#nautobot.apps.jobs.BaseJob.singleton_cache_key" class="headerlink" title="Permanent link">&para;</a></h3>
11307
-
11308
-
11309
- <div class="doc doc-contents ">
11310
-
11311
- <p>Cache key for singleton jobs.</p>
11312
-
11313
- </div>
11314
-
11315
- </div>
11316
-
11317
11172
 
11318
11173
 
11319
11174
  </div>
@@ -11335,15 +11190,10 @@ of an ObjectVar into the pk value.</p>
11335
11190
 
11336
11191
  <div class="doc doc-contents ">
11337
11192
  <p class="doc doc-class-bases">
11338
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.ScriptVariable" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
11339
-
11340
-
11341
- <p>Boolean representation (true/false). Renders as a checkbox.</p>
11342
-
11343
-
11344
-
11193
+ Bases: <code><autoref identifier="nautobot.extras.jobs.ScriptVariable" optional hover>ScriptVariable</autoref></code></p>
11345
11194
 
11346
11195
 
11196
+ <p>Boolean representation (true/false). Renders as a checkbox.</p>
11347
11197
 
11348
11198
 
11349
11199
 
@@ -11379,10 +11229,10 @@ of an ObjectVar into the pk value.</p>
11379
11229
 
11380
11230
  <div class="doc doc-contents ">
11381
11231
  <p class="doc doc-class-bases">
11382
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.ScriptVariable" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
11232
+ Bases: <code><autoref identifier="nautobot.extras.jobs.ScriptVariable" optional hover>ScriptVariable</autoref></code></p>
11383
11233
 
11384
11234
 
11385
- <p>Select one of several predefined static choices, passed as a list of two-tuples. Example:</p>
11235
+ <p>Select one of several predefined static choices, passed as a list of two-tuples. Example:</p>
11386
11236
  <div class="highlight"><pre><span></span><code>color = ChoiceVar(
11387
11237
  choices=(
11388
11238
  (&#39;#ff0000&#39;, &#39;Red&#39;),
@@ -11395,11 +11245,6 @@ of an ObjectVar into the pk value.</p>
11395
11245
 
11396
11246
 
11397
11247
 
11398
-
11399
-
11400
-
11401
-
11402
-
11403
11248
  <div class="doc doc-children">
11404
11249
 
11405
11250
 
@@ -11431,15 +11276,10 @@ of an ObjectVar into the pk value.</p>
11431
11276
 
11432
11277
  <div class="doc doc-contents ">
11433
11278
  <p class="doc doc-class-bases">
11434
- Bases: <code><span title="django.forms.FileField">FileField</span></code></p>
11435
-
11436
-
11437
- <p>Specialized <code>FileField</code> for use with <code>DatabaseFileStorage</code> storage backend.</p>
11438
-
11439
-
11440
-
11279
+ Bases: <code><autoref identifier="django.forms.FileField" optional hover>FileField</autoref></code></p>
11441
11280
 
11442
11281
 
11282
+ <p>Specialized <code>FileField</code> for use with <code>DatabaseFileStorage</code> storage backend.</p>
11443
11283
 
11444
11284
 
11445
11285
 
@@ -11475,15 +11315,10 @@ of an ObjectVar into the pk value.</p>
11475
11315
 
11476
11316
  <div class="doc doc-contents ">
11477
11317
  <p class="doc doc-class-bases">
11478
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.BooleanVar" href="#nautobot.apps.jobs.BooleanVar">BooleanVar</a></code></p>
11479
-
11480
-
11481
- <p>Special boolean variable that bypasses approval requirements if this is set to True on job execution.</p>
11482
-
11483
-
11484
-
11318
+ Bases: <code><autoref identifier="nautobot.extras.jobs.BooleanVar" optional hover>BooleanVar</autoref></code></p>
11485
11319
 
11486
11320
 
11321
+ <p>Special boolean variable that bypasses approval requirements if this is set to True on job execution.</p>
11487
11322
 
11488
11323
 
11489
11324
 
@@ -11519,15 +11354,10 @@ of an ObjectVar into the pk value.</p>
11519
11354
 
11520
11355
  <div class="doc doc-contents ">
11521
11356
  <p class="doc doc-class-bases">
11522
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.ScriptVariable" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
11523
-
11524
-
11525
- <p>An uploaded file.</p>
11526
-
11527
-
11528
-
11357
+ Bases: <code><autoref identifier="nautobot.extras.jobs.ScriptVariable" optional hover>ScriptVariable</autoref></code></p>
11529
11358
 
11530
11359
 
11360
+ <p>An uploaded file.</p>
11531
11361
 
11532
11362
 
11533
11363
 
@@ -11563,15 +11393,10 @@ of an ObjectVar into the pk value.</p>
11563
11393
 
11564
11394
  <div class="doc doc-contents ">
11565
11395
  <p class="doc doc-class-bases">
11566
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.Job" href="#nautobot.apps.jobs.Job">Job</a></code></p>
11567
-
11568
-
11569
- <p>System Job to perform a dry run on a Git repository.</p>
11570
-
11571
-
11572
-
11396
+ Bases: <code><autoref identifier="nautobot.extras.jobs.Job" optional hover>Job</autoref></code></p>
11573
11397
 
11574
11398
 
11399
+ <p>System Job to perform a dry run on a Git repository.</p>
11575
11400
 
11576
11401
 
11577
11402
 
@@ -11607,15 +11432,10 @@ of an ObjectVar into the pk value.</p>
11607
11432
 
11608
11433
  <div class="doc doc-contents ">
11609
11434
  <p class="doc doc-class-bases">
11610
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.Job" href="#nautobot.apps.jobs.Job">Job</a></code></p>
11611
-
11612
-
11613
- <p>System job to clone and/or pull a Git repository, then invoke <code>refresh_datasource_content()</code>.</p>
11614
-
11615
-
11616
-
11435
+ Bases: <code><autoref identifier="nautobot.extras.jobs.Job" optional hover>Job</autoref></code></p>
11617
11436
 
11618
11437
 
11438
+ <p>System job to clone and/or pull a Git repository, then invoke <code>refresh_datasource_content()</code>.</p>
11619
11439
 
11620
11440
 
11621
11441
 
@@ -11651,15 +11471,10 @@ of an ObjectVar into the pk value.</p>
11651
11471
 
11652
11472
  <div class="doc doc-contents ">
11653
11473
  <p class="doc doc-class-bases">
11654
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.ScriptVariable" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
11655
-
11656
-
11657
- <p>An IPv4 or IPv6 address without a mask.</p>
11658
-
11659
-
11660
-
11474
+ Bases: <code><autoref identifier="nautobot.extras.jobs.ScriptVariable" optional hover>ScriptVariable</autoref></code></p>
11661
11475
 
11662
11476
 
11477
+ <p>An IPv4 or IPv6 address without a mask.</p>
11663
11478
 
11664
11479
 
11665
11480
 
@@ -11695,15 +11510,10 @@ of an ObjectVar into the pk value.</p>
11695
11510
 
11696
11511
  <div class="doc doc-contents ">
11697
11512
  <p class="doc doc-class-bases">
11698
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.ScriptVariable" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
11699
-
11700
-
11701
- <p>An IPv4 or IPv6 address with a mask.</p>
11702
-
11703
-
11704
-
11513
+ Bases: <code><autoref identifier="nautobot.extras.jobs.ScriptVariable" optional hover>ScriptVariable</autoref></code></p>
11705
11514
 
11706
11515
 
11516
+ <p>An IPv4 or IPv6 address with a mask.</p>
11707
11517
 
11708
11518
 
11709
11519
 
@@ -11739,15 +11549,10 @@ of an ObjectVar into the pk value.</p>
11739
11549
 
11740
11550
  <div class="doc doc-contents ">
11741
11551
  <p class="doc doc-class-bases">
11742
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.ScriptVariable" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
11743
-
11744
-
11745
- <p>An IPv4 or IPv6 prefix.</p>
11746
-
11747
-
11748
-
11552
+ Bases: <code><autoref identifier="nautobot.extras.jobs.ScriptVariable" optional hover>ScriptVariable</autoref></code></p>
11749
11553
 
11750
11554
 
11555
+ <p>An IPv4 or IPv6 prefix.</p>
11751
11556
 
11752
11557
 
11753
11558
 
@@ -11783,15 +11588,10 @@ of an ObjectVar into the pk value.</p>
11783
11588
 
11784
11589
  <div class="doc doc-contents ">
11785
11590
  <p class="doc doc-class-bases">
11786
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.ScriptVariable" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
11787
-
11788
-
11789
- <p>Integer representation. Can enforce minimum/maximum values.</p>
11790
-
11791
-
11792
-
11591
+ Bases: <code><autoref identifier="nautobot.extras.jobs.ScriptVariable" optional hover>ScriptVariable</autoref></code></p>
11793
11592
 
11794
11593
 
11594
+ <p>Integer representation. Can enforce minimum/maximum values.</p>
11795
11595
 
11796
11596
 
11797
11597
 
@@ -11827,15 +11627,10 @@ of an ObjectVar into the pk value.</p>
11827
11627
 
11828
11628
  <div class="doc doc-contents ">
11829
11629
  <p class="doc doc-class-bases">
11830
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.ScriptVariable" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
11831
-
11832
-
11833
- <p>Like TextVar but with native serializing of JSON data.</p>
11834
-
11835
-
11836
-
11630
+ Bases: <code><autoref identifier="nautobot.extras.jobs.ScriptVariable" optional hover>ScriptVariable</autoref></code></p>
11837
11631
 
11838
11632
 
11633
+ <p>Like TextVar but with native serializing of JSON data.</p>
11839
11634
 
11840
11635
 
11841
11636
 
@@ -11871,15 +11666,10 @@ of an ObjectVar into the pk value.</p>
11871
11666
 
11872
11667
  <div class="doc doc-contents ">
11873
11668
  <p class="doc doc-class-bases">
11874
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.BaseJob" href="#nautobot.apps.jobs.BaseJob">BaseJob</a></code></p>
11875
-
11876
-
11877
- <p>Classes which inherit from this model will appear in the list of available jobs.</p>
11878
-
11879
-
11880
-
11669
+ Bases: <code><autoref identifier="nautobot.extras.jobs.BaseJob" optional hover>BaseJob</autoref></code></p>
11881
11670
 
11882
11671
 
11672
+ <p>Classes which inherit from this model will appear in the list of available jobs.</p>
11883
11673
 
11884
11674
 
11885
11675
 
@@ -11915,20 +11705,15 @@ of an ObjectVar into the pk value.</p>
11915
11705
 
11916
11706
  <div class="doc doc-contents ">
11917
11707
  <p class="doc doc-class-bases">
11918
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.Job" href="#nautobot.apps.jobs.Job">Job</a></code></p>
11708
+ Bases: <code><autoref identifier="nautobot.extras.jobs.Job" optional hover>Job</autoref></code></p>
11919
11709
 
11920
11710
 
11921
- <p>Base class for job button receivers. Job button receivers are jobs that are initiated
11711
+ <p>Base class for job button receivers. Job button receivers are jobs that are initiated
11922
11712
  from UI buttons and are not intended to be run from the job form UI or API like standard jobs.</p>
11923
11713
 
11924
11714
 
11925
11715
 
11926
11716
 
11927
-
11928
-
11929
-
11930
-
11931
-
11932
11717
  <div class="doc doc-children">
11933
11718
 
11934
11719
 
@@ -11950,7 +11735,7 @@ from UI buttons and are not intended to be run from the job form UI or API like
11950
11735
 
11951
11736
  <div class="doc doc-contents ">
11952
11737
 
11953
- <p>Method to be implemented by concrete JobButtonReceiver subclasses.</p>
11738
+ <p>Method to be implemented by concrete JobButtonReceiver subclasses.</p>
11954
11739
 
11955
11740
 
11956
11741
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -11965,11 +11750,9 @@ from UI buttons and are not intended to be run from the job form UI or API like
11965
11750
  </thead>
11966
11751
  <tbody>
11967
11752
  <tr class="doc-section-item">
11753
+ <td><code>obj</code></td>
11968
11754
  <td>
11969
- <code>obj</code>
11970
- </td>
11971
- <td>
11972
- <code><span title="django.db.models.Model">Model</span></code>
11755
+ <code><autoref identifier="django.db.models.Model" optional hover>Model</autoref></code>
11973
11756
  </td>
11974
11757
  <td>
11975
11758
  <div class="doc-md-description">
@@ -11998,7 +11781,7 @@ from UI buttons and are not intended to be run from the job form UI or API like
11998
11781
 
11999
11782
  <div class="doc doc-contents ">
12000
11783
 
12001
- <p>JobButtonReceiver subclasses generally shouldn't need to override this method.</p>
11784
+ <p>JobButtonReceiver subclasses generally shouldn't need to override this method.</p>
12002
11785
 
12003
11786
  </div>
12004
11787
 
@@ -12025,20 +11808,15 @@ from UI buttons and are not intended to be run from the job form UI or API like
12025
11808
 
12026
11809
  <div class="doc doc-contents ">
12027
11810
  <p class="doc doc-class-bases">
12028
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.Job" href="#nautobot.apps.jobs.Job">Job</a></code></p>
11811
+ Bases: <code><autoref identifier="nautobot.extras.jobs.Job" optional hover>Job</autoref></code></p>
12029
11812
 
12030
11813
 
12031
- <p>Base class for job hook receivers. Job hook receivers are jobs that are initiated
11814
+ <p>Base class for job hook receivers. Job hook receivers are jobs that are initiated
12032
11815
  from object changes and are not intended to be run from the UI or API like standard jobs.</p>
12033
11816
 
12034
11817
 
12035
11818
 
12036
11819
 
12037
-
12038
-
12039
-
12040
-
12041
-
12042
11820
  <div class="doc doc-children">
12043
11821
 
12044
11822
 
@@ -12060,7 +11838,7 @@ from object changes and are not intended to be run from the UI or API like stand
12060
11838
 
12061
11839
  <div class="doc doc-contents ">
12062
11840
 
12063
- <p>Method to be implemented by concrete JobHookReceiver subclasses.</p>
11841
+ <p>Method to be implemented by concrete JobHookReceiver subclasses.</p>
12064
11842
 
12065
11843
 
12066
11844
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -12075,11 +11853,9 @@ from object changes and are not intended to be run from the UI or API like stand
12075
11853
  </thead>
12076
11854
  <tbody>
12077
11855
  <tr class="doc-section-item">
11856
+ <td><code>change</code></td>
12078
11857
  <td>
12079
- <code>change</code>
12080
- </td>
12081
- <td>
12082
- <code><span title="nautobot.extras.models.ObjectChange">ObjectChange</span></code>
11858
+ <code><autoref identifier="nautobot.extras.models.ObjectChange" optional hover>ObjectChange</autoref></code>
12083
11859
  </td>
12084
11860
  <td>
12085
11861
  <div class="doc-md-description">
@@ -12091,11 +11867,9 @@ from object changes and are not intended to be run from the UI or API like stand
12091
11867
  </td>
12092
11868
  </tr>
12093
11869
  <tr class="doc-section-item">
11870
+ <td><code>action</code></td>
12094
11871
  <td>
12095
- <code>action</code>
12096
- </td>
12097
- <td>
12098
- <code>str</code>
11872
+ <code><autoref identifier="str" optional>str</autoref></code>
12099
11873
  </td>
12100
11874
  <td>
12101
11875
  <div class="doc-md-description">
@@ -12107,11 +11881,9 @@ from object changes and are not intended to be run from the UI or API like stand
12107
11881
  </td>
12108
11882
  </tr>
12109
11883
  <tr class="doc-section-item">
11884
+ <td><code>changed_object</code></td>
12110
11885
  <td>
12111
- <code>changed_object</code>
12112
- </td>
12113
- <td>
12114
- <code><span title="django.db.models.Model">Model</span></code>
11886
+ <code><autoref identifier="django.db.models.Model" optional hover>Model</autoref></code>
12115
11887
  </td>
12116
11888
  <td>
12117
11889
  <div class="doc-md-description">
@@ -12140,7 +11912,7 @@ from object changes and are not intended to be run from the UI or API like stand
12140
11912
 
12141
11913
  <div class="doc doc-contents ">
12142
11914
 
12143
- <p>JobHookReceiver subclasses generally shouldn't need to override this method.</p>
11915
+ <p>JobHookReceiver subclasses generally shouldn't need to override this method.</p>
12144
11916
 
12145
11917
  </div>
12146
11918
 
@@ -12167,15 +11939,10 @@ from object changes and are not intended to be run from the UI or API like stand
12167
11939
 
12168
11940
  <div class="doc doc-contents ">
12169
11941
  <p class="doc doc-class-bases">
12170
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.ChoiceVar" href="#nautobot.apps.jobs.ChoiceVar">ChoiceVar</a></code></p>
12171
-
12172
-
12173
- <p>Like ChoiceVar, but allows for the selection of multiple choices.</p>
12174
-
12175
-
12176
-
11942
+ Bases: <code><autoref identifier="nautobot.extras.jobs.ChoiceVar" optional hover>ChoiceVar</autoref></code></p>
12177
11943
 
12178
11944
 
11945
+ <p>Like ChoiceVar, but allows for the selection of multiple choices.</p>
12179
11946
 
12180
11947
 
12181
11948
 
@@ -12211,15 +11978,10 @@ from object changes and are not intended to be run from the UI or API like stand
12211
11978
 
12212
11979
  <div class="doc doc-contents ">
12213
11980
  <p class="doc doc-class-bases">
12214
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.ObjectVar" href="#nautobot.apps.jobs.ObjectVar">ObjectVar</a></code></p>
12215
-
12216
-
12217
- <p>Like ObjectVar, but can represent one or more objects.</p>
12218
-
12219
-
12220
-
11981
+ Bases: <code><autoref identifier="nautobot.extras.jobs.ObjectVar" optional hover>ObjectVar</autoref></code></p>
12221
11982
 
12222
11983
 
11984
+ <p>Like ObjectVar, but can represent one or more objects.</p>
12223
11985
 
12224
11986
 
12225
11987
 
@@ -12255,10 +12017,10 @@ from object changes and are not intended to be run from the UI or API like stand
12255
12017
 
12256
12018
  <div class="doc doc-contents ">
12257
12019
  <p class="doc doc-class-bases">
12258
- Bases: <code><span title="rest_framework.utils.encoders.JSONEncoder">JSONEncoder</span></code></p>
12020
+ Bases: <code><autoref identifier="rest_framework.utils.encoders.JSONEncoder" optional hover>JSONEncoder</autoref></code></p>
12259
12021
 
12260
12022
 
12261
- <p>Custom json encoder based on restframework's JSONEncoder that serializes objects that implement
12023
+ <p>Custom json encoder based on restframework's JSONEncoder that serializes objects that implement
12262
12024
  the <code>nautobot_serialize()</code> method via the <code>__nautobot_type__</code> interface. This is useful
12263
12025
  in passing special objects to and from Celery tasks.</p>
12264
12026
  <p>This pattern should generally be avoided by passing pointers to persisted objects to the
@@ -12274,11 +12036,6 @@ an actual instance of the class.</p>
12274
12036
 
12275
12037
 
12276
12038
 
12277
-
12278
-
12279
-
12280
-
12281
-
12282
12039
  <div class="doc doc-children">
12283
12040
 
12284
12041
 
@@ -12310,10 +12067,10 @@ an actual instance of the class.</p>
12310
12067
 
12311
12068
  <div class="doc doc-contents ">
12312
12069
  <p class="doc doc-class-bases">
12313
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.ScriptVariable" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
12070
+ Bases: <code><autoref identifier="nautobot.extras.jobs.ScriptVariable" optional hover>ScriptVariable</autoref></code></p>
12314
12071
 
12315
12072
 
12316
- <p>A single object within Nautobot.</p>
12073
+ <p>A single object within Nautobot.</p>
12317
12074
 
12318
12075
 
12319
12076
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -12328,11 +12085,9 @@ an actual instance of the class.</p>
12328
12085
  </thead>
12329
12086
  <tbody>
12330
12087
  <tr class="doc-section-item">
12088
+ <td><code>model</code></td>
12331
12089
  <td>
12332
- <code>model</code>
12333
- </td>
12334
- <td>
12335
- <code><span title="django.db.models.Model">Model</span></code>
12090
+ <code><autoref identifier="django.db.models.Model" optional hover>Model</autoref></code>
12336
12091
  </td>
12337
12092
  <td>
12338
12093
  <div class="doc-md-description">
@@ -12344,11 +12099,9 @@ an actual instance of the class.</p>
12344
12099
  </td>
12345
12100
  </tr>
12346
12101
  <tr class="doc-section-item">
12102
+ <td><code>display_field</code></td>
12347
12103
  <td>
12348
- <code>display_field</code>
12349
- </td>
12350
- <td>
12351
- <code>str</code>
12104
+ <code><autoref identifier="str" optional>str</autoref></code>
12352
12105
  </td>
12353
12106
  <td>
12354
12107
  <div class="doc-md-description">
@@ -12360,11 +12113,9 @@ an actual instance of the class.</p>
12360
12113
  </td>
12361
12114
  </tr>
12362
12115
  <tr class="doc-section-item">
12116
+ <td><code>query_params</code></td>
12363
12117
  <td>
12364
- <code>query_params</code>
12365
- </td>
12366
- <td>
12367
- <code>dict</code>
12118
+ <code><autoref identifier="dict" optional>dict</autoref></code>
12368
12119
  </td>
12369
12120
  <td>
12370
12121
  <div class="doc-md-description">
@@ -12376,11 +12127,9 @@ an actual instance of the class.</p>
12376
12127
  </td>
12377
12128
  </tr>
12378
12129
  <tr class="doc-section-item">
12130
+ <td><code>null_option</code></td>
12379
12131
  <td>
12380
- <code>null_option</code>
12381
- </td>
12382
- <td>
12383
- <code>str</code>
12132
+ <code><autoref identifier="str" optional>str</autoref></code>
12384
12133
  </td>
12385
12134
  <td>
12386
12135
  <div class="doc-md-description">
@@ -12397,11 +12146,6 @@ an actual instance of the class.</p>
12397
12146
 
12398
12147
 
12399
12148
 
12400
-
12401
-
12402
-
12403
-
12404
-
12405
12149
  <div class="doc doc-children">
12406
12150
 
12407
12151
 
@@ -12433,15 +12177,10 @@ an actual instance of the class.</p>
12433
12177
 
12434
12178
  <div class="doc doc-contents ">
12435
12179
  <p class="doc doc-class-bases">
12436
- Bases: <code>Exception</code></p>
12437
-
12438
-
12439
- <p>Celery task failed for some reason.</p>
12440
-
12441
-
12442
-
12180
+ Bases: <code><autoref identifier="Exception" optional>Exception</autoref></code></p>
12443
12181
 
12444
12182
 
12183
+ <p>Celery task failed for some reason.</p>
12445
12184
 
12446
12185
 
12447
12186
  </div>
@@ -12462,12 +12201,7 @@ an actual instance of the class.</p>
12462
12201
  <div class="doc doc-contents ">
12463
12202
 
12464
12203
 
12465
- <p>Base model for script variables</p>
12466
-
12467
-
12468
-
12469
-
12470
-
12204
+ <p>Base model for script variables</p>
12471
12205
 
12472
12206
 
12473
12207
 
@@ -12493,7 +12227,7 @@ an actual instance of the class.</p>
12493
12227
 
12494
12228
  <div class="doc doc-contents ">
12495
12229
 
12496
- <p>Render the variable as a Django form field.</p>
12230
+ <p>Render the variable as a Django form field.</p>
12497
12231
 
12498
12232
  </div>
12499
12233
 
@@ -12520,15 +12254,10 @@ an actual instance of the class.</p>
12520
12254
 
12521
12255
  <div class="doc doc-contents ">
12522
12256
  <p class="doc doc-class-bases">
12523
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.ScriptVariable" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
12524
-
12525
-
12526
- <p>Character string representation. Can enforce minimum/maximum length and/or regex validation.</p>
12527
-
12528
-
12529
-
12257
+ Bases: <code><autoref identifier="nautobot.extras.jobs.ScriptVariable" optional hover>ScriptVariable</autoref></code></p>
12530
12258
 
12531
12259
 
12260
+ <p>Character string representation. Can enforce minimum/maximum length and/or regex validation.</p>
12532
12261
 
12533
12262
 
12534
12263
 
@@ -12564,15 +12293,10 @@ an actual instance of the class.</p>
12564
12293
 
12565
12294
  <div class="doc doc-contents ">
12566
12295
  <p class="doc doc-class-bases">
12567
- Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.jobs.ScriptVariable" href="#nautobot.apps.jobs.ScriptVariable">ScriptVariable</a></code></p>
12568
-
12569
-
12570
- <p>Free-form text data. Renders as a <code>&lt;textarea&gt;</code>.</p>
12571
-
12572
-
12573
-
12296
+ Bases: <code><autoref identifier="nautobot.extras.jobs.ScriptVariable" optional hover>ScriptVariable</autoref></code></p>
12574
12297
 
12575
12298
 
12299
+ <p>Free-form text data. Renders as a <code>&lt;textarea&gt;</code>.</p>
12576
12300
 
12577
12301
 
12578
12302
 
@@ -12607,7 +12331,7 @@ an actual instance of the class.</p>
12607
12331
 
12608
12332
  <div class="doc doc-contents ">
12609
12333
 
12610
- <p>Find job hook(s) assigned to this changed object type + action and enqueue them to be processed.</p>
12334
+ <p>Find job hook(s) assigned to this changed object type + action and enqueue them to be processed.</p>
12611
12335
 
12612
12336
 
12613
12337
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -12622,11 +12346,9 @@ an actual instance of the class.</p>
12622
12346
  </thead>
12623
12347
  <tbody>
12624
12348
  <tr class="doc-section-item">
12349
+ <td><code>object_change</code></td>
12625
12350
  <td>
12626
- <code>object_change</code>
12627
- </td>
12628
- <td>
12629
- <code><span title="nautobot.extras.models.ObjectChange">ObjectChange</span></code>
12351
+ <code><autoref identifier="nautobot.extras.models.ObjectChange" optional hover>ObjectChange</autoref></code>
12630
12352
  </td>
12631
12353
  <td>
12632
12354
  <div class="doc-md-description">
@@ -12638,11 +12360,9 @@ an actual instance of the class.</p>
12638
12360
  </td>
12639
12361
  </tr>
12640
12362
  <tr class="doc-section-item">
12363
+ <td><code>may_reload_jobs</code></td>
12641
12364
  <td>
12642
- <code>may_reload_jobs</code>
12643
- </td>
12644
- <td>
12645
- <code>bool</code>
12365
+ <code><autoref identifier="bool" optional>bool</autoref></code>
12646
12366
  </td>
12647
12367
  <td>
12648
12368
  <div class="doc-md-description">
@@ -12654,11 +12374,9 @@ an actual instance of the class.</p>
12654
12374
  </td>
12655
12375
  </tr>
12656
12376
  <tr class="doc-section-item">
12377
+ <td><code>jobhook_queryset</code></td>
12657
12378
  <td>
12658
- <code>jobhook_queryset</code>
12659
- </td>
12660
- <td>
12661
- <code><span title="django.db.models.query.QuerySet">QuerySet</span></code>
12379
+ <code><autoref identifier="django.db.models.query.QuerySet" optional hover>QuerySet</autoref></code>
12662
12380
  </td>
12663
12381
  <td>
12664
12382
  <div class="doc-md-description">
@@ -12684,7 +12402,7 @@ an actual instance of the class.</p>
12684
12402
  <tbody>
12685
12403
  <tr class="doc-section-item">
12686
12404
  <td><code>result</code></td> <td>
12687
- <code>tuple[bool, <span title="django.db.models.query.QuerySet">QuerySet</span>]</code>
12405
+ <code><autoref identifier="tuple" optional>tuple</autoref>[<autoref identifier="bool" optional>bool</autoref>, <autoref identifier="django.db.models.query.QuerySet" optional hover>QuerySet</autoref>]</code>
12688
12406
  </td>
12689
12407
  <td>
12690
12408
  <div class="doc-md-description">
@@ -12710,7 +12428,7 @@ an actual instance of the class.</p>
12710
12428
 
12711
12429
  <div class="doc doc-contents ">
12712
12430
 
12713
- <p>Retrieve a specific job class by its class_path (<code>&lt;module_name&gt;.&lt;JobClassName&gt;</code>).</p>
12431
+ <p>Retrieve a specific job class by its class_path (<code>&lt;module_name&gt;.&lt;JobClassName&gt;</code>).</p>
12714
12432
  <p>May return None if the job can't be imported.</p>
12715
12433
 
12716
12434
 
@@ -12726,11 +12444,9 @@ an actual instance of the class.</p>
12726
12444
  </thead>
12727
12445
  <tbody>
12728
12446
  <tr class="doc-section-item">
12447
+ <td><code>reload</code></td>
12729
12448
  <td>
12730
- <code>reload</code>
12731
- </td>
12732
- <td>
12733
- <code>bool</code>
12449
+ <code><autoref identifier="bool" optional>bool</autoref></code>
12734
12450
  </td>
12735
12451
  <td>
12736
12452
  <div class="doc-md-description">
@@ -12760,7 +12476,7 @@ then refresh <strong>all</strong> such Jobs before retrieving the job class.</p>
12760
12476
 
12761
12477
  <div class="doc doc-contents ">
12762
12478
 
12763
- <p>Compile a dictionary of all Job classes available at this time.</p>
12479
+ <p>Compile a dictionary of all Job classes available at this time.</p>
12764
12480
 
12765
12481
 
12766
12482
  <p><span class="doc-section-title">Parameters:</span></p>
@@ -12775,11 +12491,9 @@ then refresh <strong>all</strong> such Jobs before retrieving the job class.</p>
12775
12491
  </thead>
12776
12492
  <tbody>
12777
12493
  <tr class="doc-section-item">
12494
+ <td><code>reload</code></td>
12778
12495
  <td>
12779
- <code>reload</code>
12780
- </td>
12781
- <td>
12782
- <code>bool</code>
12496
+ <code><autoref identifier="bool" optional>bool</autoref></code>
12783
12497
  </td>
12784
12498
  <td>
12785
12499
  <div class="doc-md-description">
@@ -12805,7 +12519,7 @@ then refresh <strong>all</strong> such Jobs before retrieving the job class.</p>
12805
12519
  <tbody>
12806
12520
  <tr class="doc-section-item">
12807
12521
  <td>
12808
- <code>dict</code>
12522
+ <code><autoref identifier="dict" optional>dict</autoref></code>
12809
12523
  </td>
12810
12524
  <td>
12811
12525
  <div class="doc-md-description">
@@ -12831,7 +12545,7 @@ then refresh <strong>all</strong> such Jobs before retrieving the job class.</p>
12831
12545
 
12832
12546
  <div class="doc doc-contents ">
12833
12547
 
12834
- <p>Returns True if the given object is a Job subclass.</p>
12548
+ <p>Returns True if the given object is a Job subclass.</p>
12835
12549
 
12836
12550
  </div>
12837
12551
 
@@ -12848,7 +12562,7 @@ then refresh <strong>all</strong> such Jobs before retrieving the job class.</p>
12848
12562
 
12849
12563
  <div class="doc doc-contents ">
12850
12564
 
12851
- <p>Returns True if the object is a ScriptVariable instance.</p>
12565
+ <p>Returns True if the object is a ScriptVariable instance.</p>
12852
12566
 
12853
12567
  </div>
12854
12568
 
@@ -12865,7 +12579,7 @@ then refresh <strong>all</strong> such Jobs before retrieving the job class.</p>
12865
12579
 
12866
12580
  <div class="doc doc-contents ">
12867
12581
 
12868
- <p>Method to register jobs - with Celery in Nautobot 2.0 through 2.2.2, with Nautobot itself in 2.2.3 and later.</p>
12582
+ <p>Method to register jobs - with Celery in Nautobot 2.0 through 2.2.2, with Nautobot itself in 2.2.3 and later.</p>
12869
12583
 
12870
12584
  </div>
12871
12585
 
@@ -13024,7 +12738,7 @@ then refresh <strong>all</strong> such Jobs before retrieving the job class.</p>
13024
12738
  <script id="__config" type="application/json">{"base": "../../..", "features": ["content.code.annotate", "content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
13025
12739
 
13026
12740
 
13027
- <script src="../../../assets/javascripts/bundle.88dd0f4e.min.js"></script>
12741
+ <script src="../../../assets/javascripts/bundle.83f73b43.min.js"></script>
13028
12742
 
13029
12743
  <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
13030
12744