后端网络数据建模【免费下载链接】netboxThe premier source of truth powering network automation. Open source under Apache 2. Try NetBox Cloud free: https://netboxlabs.com/products/free-netbox-cloud/项目地址https://gitcode.com/gh_mirrors/ne/netbox点击查看免费下载Custom Links自定义链接是 NetBox 提供的对象视图扩展机制允许你在站点Site、设备Device、前缀Prefix等任意对象详情页上渲染出指向外部系统如 NMS 监控平台、CMDB、工单系统的超链接并通过 Jinja2 模板把当前对象的属性动态注入链接文本与 URL。阅读本文后你将掌握自定义链接的创建、模板上下文、条件渲染、分组、表格列集成等全部实操技能并能结合源码理解其渲染与安全机制。什么是 Custom Links自定义链接用于在 NetBox 对象视图中显示指向外部内容的任意超链接典型用途是把 NetBox 中的记录与外部系统交叉引用。例如你可以为设备视图创建一个自定义链接跳转到网络监控系统NMS中对应的同一台设备从而免去在多个平台间手动查找的繁琐操作。自定义链接的创建入口是Customization自定义 Custom Links自定义链接。每条链接都绑定一个或多个特定的 NetBox 对象类型站点、设备、前缀等并在所有相关对象的视图上展示。每条链接包含显示文本link text和URL两部分二者均支持 Jinja2 模板代码通过变量object引用当前正在查看的对象通过object.cf引用其自定义字段custom fields。例如可以定义这样一条链接文本View NMSURLhttps://nms.example.com/nodes/?name{{ object.name }}当查看名为Router4的设备时这条链接会被渲染为a hrefhttps://nms.example.com/nodes/?nameRouter4View NMS/a自定义链接以按钮形式出现在页面右上角。可以使用数值型权重weight影响链接的排列顺序每条链接也可以被单独启用或禁用enabled。⚠️安全警告自定义链接依赖用户编写的代码生成任意 HTML 输出这可能是危险的。只应授予可信用户创建或修改自定义链接的权限。创建与管理自定义链接表单字段在Customization Custom Links中点击新增表单由CustomLinkForm定义见 netbox/extras/forms/model_forms.py字段集分为Custom Link链接属性与Templates模板代码两组。核心字段如下字段说明默认值 / 约束Name名称链接名称必填唯一max 100 字符Object types对象类型该链接应用到的对象类型多选仅列出支持custom_links特性的模型ObjectType.objects.with_feature(custom_links)Weight权重影响按钮排序的数值默认100PositiveSmallIntegerFieldGroup name分组名相同分组的链接合并为下拉菜单可选max 50 字符Button class按钮样式按钮颜色/样式默认 DEFAULT普通按钮另有 Gray/Black/White 等及ghost-dark无边框文字链接见 netbox/extras/choices.pyEnabled启用是否启用该链接默认TrueNew window新窗口是否在新窗口打开默认FalseLink text链接文本Jinja2 模板代码渲染为空则链接不显示等宽字体文本域Link URL链接 URLJinja2 模板代码等宽字体文本域模型与数据存储CustomLink模型定义于 netbox/extras/models/models.py关键设计如下object_types是与ContentType的多对多关系因此一条链接可以同时绑定多种对象类型模型默认排序为[group_name, weight, name]并建有同名索引这正是页面上链接排列顺序的来源clone_fields支持一键克隆Cloning对象类型、启用状态、权重、分组、按钮样式等属性链接支持通过批量导入CSV、批量编辑、批量重命名与批量删除进行维护对应视图位于 netbox/extras/views.py也可通过 REST APICustomLinkViewSet见 netbox/extras/api/views.py和 GraphQL 查询管理。渲染机制与源码解读自定义链接的渲染由模板标签custom_links完成实现位于 netbox/extras/templatetags/custom_links.py。其核心流程为通过CustomLink.objects.restrict(user, view)按当前用户的对象级权限过滤可用的自定义链接再过滤object_types匹配且enabledTrue的链接构造模板上下文object、debug、request、user、perms详见下文对每条链接调用CustomLink.render(context)得到渲染结果非分组的链接渲染为LINK_BUTTON模板a href{}{} classbtn btn-sm btn-{}{}/a分组的链接渲染为 Bootstrap 下拉菜单GROUP_BUTTONGROUP_LINK。CustomLink.render()netbox/extras/models/models.py的具体步骤是先渲染link_text并strip()若结果为空则返回空字典对应空文本链接不显示的行为渲染link_url若启用了new_window则附加target_blank用clean_html()对链接文本做 HTML 消毒仅允许ALLOWED_URL_SCHEMES中的协议见下文安全章节用urllib.parse.quote()对 URL 做编码保留/:?%[]#,;!等安全字符校验 URL 的 scheme 是否在允许列表内不在则置为空链接。渲染过程中若抛异常模板标签会捕获异常并以禁用按钮的形式输出错误提示带警告图标且异常信息与链接名称都会经过 HTML 转义避免 XSS对应测试见 netbox/extras/tests/test_templatetags.py 中的CustomLinkRenderErrorEscapingTest。模板上下文Context Data渲染链接文本或 URL 时模板中可用以下上下文变量变量说明object当前展示的 NetBox 对象debug布尔值表示是否启用了调试模式request当前请求的净化子集见下方说明user当前用户若已认证perms授予当前用户的 Django 权限其中上下文变量大多具有一致的属性但object是被查看对象的特定实例——不同模型拥有不同的字段与属性因此你可能需要调研特定对象类型可用的属性。一般做法是查询该对象的REST API 表示来确认可用属性也可以直接查阅 NetBox 源码获得完整字段清单。v4.7 安全变更request 对象被净化注意NetBox v4.7 变更出于安全考虑request不再暴露完整的 WSGI 请求对象仅保留一组安全的属性子集request.id、request.path、request.path_info、request.method、request.GET查询参数以及request.user用户名。Cookie、请求头、会话状态等敏感数据不再能从自定义链接模板中访问。该净化逻辑由get_safe_request_context()实现netbox/utilities/request.py它返回一个普通字典仅包含id由中间件分配的 UUID 字符串、path、path_info、method、GET以及user仅用户名而非用户实例。Jinja2 会通过 getitem 回退机制解析属性访问如request.path。对应测试CustomLinkRequestSanitizationTestnetbox/extras/tests/test_templatetags.py验证了三点request.COOKIES中的会话值不会泄露、request.META与request.headers不可访问而request.path、request.GET、request.user等安全属性仍然可用。条件渲染Conditional Rendering只有渲染出非空文本的链接才会出现在页面上。因此可以利用 Jinja2 条件逻辑精确控制链接的显示时机。例如只想对状态为active的设备显示链接可把链接文本设为{% if object.status active %}View NMS{% endif %}查看任何非 active 状态的设备时该链接都不会出现。再如只想显示属于某制造商的设备可以这样写{% if object.device_type.manufacturer.name Cisco %}View NMS{% endif %}只有制造商名称为 Cisco 的设备才会显示该链接。条件渲染同样适用于 URL 部分且可结合object.cf自定义字段与perms等上下文做更复杂的判断。链接分组Link Groups通过指定**分组名Group name**可以把链接组织为组。分组名相同的链接会渲染为单个按钮下的下拉菜单按钮文本即分组名分组内第一条链接的按钮样式button class会用于下拉按钮本身见 netbox/extras/models/models.py 的 help_text 说明。未分组的链接则各自渲染为独立按钮。从模板标签源码netbox/extras/templatetags/custom_links.py可以看到分组内的链接渲染为下拉项lia classdropdown-item ...整个分组包在 Bootstrapdropdown容器中组内某条链接渲染失败时该条目会以禁用样式降级显示而不影响其他链接。在表格中集成 Custom Links自定义链接还可以作为表格列出现在对象列表视图中在表格配置表单table configuration form中选择需要的链接即可。此时每个链接会为对应对象渲染一个超链接当表格导出如导出为 CSV时每列只导出链接的 URL。从源码看列表表格会按对象类型自动收集启用的自定义链接并生成列列名形如cl_{链接名称}见 netbox/netbox/tables/tables.py。相关测试netbox/extras/tests/test_views.py验证了自定义链接列默认隐藏可通过 URL 参数显式包含例如站点列表请求?include_columnscl_Test用户没有查看 CustomLink 的权限时即使显式请求该列也不会渲染对应 issue #22439渲染出错时错误元素存在但恶意载荷只会以转义形式出现。安全机制与权限控制由于自定义链接本质上是用户自定义代码生成 HTMLNetBox 从多个层面做了防护创建权限官方明确要求仅授予可信用户创建/修改自定义链接的权限对象级权限渲染时通过CustomLink.objects.restrict(user, view)过滤用户必须具备extras.view_customlink权限且链接落在其权限约束范围内才会显示测试见 netbox/extras/tests/test_templatetags.pyURL scheme 白名单渲染结果会校验 URL scheme仅允许ALLOWED_URL_SCHEMES配置项中列出的协议。该配置默认包含file、ftp、ftps、http、https、irc、mailto、sftp、ssh、tel、telnet、tftp、vnc、xmpp见 netbox/netbox/config/parameters.py从而阻断javascript:等危险协议HTML 消毒与 URL 编码链接文本经clean_html()消毒URL 经urllib.parse.quote()编码错误信息转义模板渲染抛错时的回退标记会转义链接名称与异常消息防止 XSS 注入NB-3004 / NB-3311。小结自定义链接是 NetBox 对外联动能力中成本最低、见效最快的扩展点你不需要写任何插件代码只需在管理界面配置一条 Jinja2 模板即可把任意对象视图与外部系统监控、CMDB、工单、Wiki 等的上下文无缝衔接。掌握object及其自定义字段object.cf的用法、条件渲染技巧与分组组织方式后即可构建出一套贴合自身运维工作流的跨系统跳转体系。若需深入了解可继续查阅仓库中的以下资源模型与渲染实现netbox/extras/models/models.py模板标签实现netbox/extras/templatetags/custom_links.py表单与视图netbox/extras/forms/model_forms.py、netbox/extras/views.py测试用例netbox/extras/tests/test_templatetags.py、netbox/extras/tests/test_views.py模型参考文档docs/models/extras/customlink.md赞分享后端网络数据建模【免费下载链接】netboxThe premier source of truth powering network automation. Open source under Apache 2. Try NetBox Cloud free: https://netboxlabs.com/products/free-netbox-cloud/项目地址https://gitcode.com/gh_mirrors/ne/netbox点击查看免费下载相关推荐SkyPilot 外部链接External Links日志 URL 自动识别与管理员自定义链接配置指南SkyPilot 外部链接External Links日志 URL 自动识别与管理员自定义链接配置指南 SkyPilot 的外部链接External L后端任务调度MLOps集群管理10分钟上手AngularUtils组件库从分页到面包屑的AngularJS开发效率神器10分钟上手AngularUtils组件库从分页到面包屑的AngularJS开发效率神器 你是否还在为AngularJS项目中的分页逻辑编写重复代码还在手文档静态站点开发工具Apache Airflow 自定义 Operator 附加链接Extra Links为任务 UI 增加外部系统入口Apache Airflow 自定义 Operator 附加链接Extra Links为任务 UI 增加外部系统入口 Apache Airflow 的 O后端任务调度工作流自动化数据编排批处理数据工程流程编排上一篇5分钟搭建Chat2DB自动化部署流水线GitLab CI/CD实战指南下一篇human-pose-estimation.pytorch简单而强大的人体姿态估计终极指南创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考