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