Netskope NPA MCP 服务器

一个模型上下文协议 (MCP) 服务器，用于通过大型语言模型 (LLM) 管理 Netskope 网络专用访问 (NPA) 基础设施。

警告

所有 50 个工具要实现可操作还需要做大量工作，我强烈建议不要在任何生产环境中使用它。

演示

https://github.com/johnneerdael/netskope-mcp/raw/refs/heads/main/demo.mov

安装

选项 1：NPM 包

使用 npm 安装包：

npm install @johnneerdael/netskope-mcp

选项 2：本地开发

克隆存储库并安装依赖项：

git clone https://github.com/johnneerdael/netskope-mcp.git
cd netskope-mcp
npm install
npm run build

MCP 配置

将以下配置添加到您的 MCP 设置文件：

Windows with WSL

对于 NPM 安装：

{
  "mcpServers": {
    "netskope-mcp": {
      "command": "wsl.exe",
      "args": [
        "bash",
        "-c",
        "source ~/.nvm/nvm.sh && NETSKOPE_BASE_URL=https://your-tenant.goskope.com NETSKOPE_API_KEY=your-token npx -y @johnneerdael/netskope-mcp"
      ]
    }
  }
}

对于本地开发：

{
  "mcpServers": {
    "netskope-mcp": {
      "command": "wsl.exe",
      "args": [
        "bash",
        "-c",
        "cd /path/to/netskope-mcp && NETSKOPE_BASE_URL=https://your-tenant.goskope.com NETSKOPE_API_KEY=your-token node dist/cli.js"
      ]
    }
  }
}

Linux 和 macOS

对于 NPM 安装：

{
  "mcpServers": {
    "netskope-mcp": {
      "command": "npx",
      "args": ["-y", "@johnneerdael/netskope-mcp"],
      "env": {
        "NETSKOPE_BASE_URL": "https://your-tenant.goskope.com",
        "NETSKOPE_API_KEY": "your-token"
      }
    }
  }
}

对于本地开发：

{
  "mcpServers": {
    "netskope-mcp": {
      "command": "node",
      "args": ["dist/cli.js"],
      "cwd": "/path/to/netskope-mcp",
      "env": {
        "NETSKOPE_BASE_URL": "https://your-tenant.goskope.com",
        "NETSKOPE_API_KEY": "your-token"
      }
    }
  }
}

环境变量

Netskope NPA MCP 服务器需要配置以下环境变量才能正常运行：

必需变量

• NETSKOPE_BASE_URL

  • 描述: 您的 Netskope 租户的基本 URL
  • 格式: 包含协议的完整 URL
  • 示例: https://your-tenant.goskope.com
  • 用法: 用于与您的 Netskope 租户的所有 API 通信
  • 注意: 必须是完整的租户 URL，不包含任何路径组件

• NETSKOPE_API_KEY

  • 描述: 用于 Netskope 服务身份验证的 API 令牌
  • 格式: 来自 Netskope 管理控制台的字符串令牌
  • 示例: 030f31f7d57fd94834af57a3edc4bbda
  • 用法: 用于验证所有 API 请求
  • 安全提示: 确保此令牌的安全，切勿将其提交到版本控制

配置示例

开发环境

export NETSKOPE_BASE_URL="https://dev-tenant.goskope.com"
export NETSKOPE_API_KEY="your-development-token"

生产环境

export NETSKOPE_BASE_URL="https://prod-tenant.goskope.com"
export NETSKOPE_API_KEY="your-production-token"

AlertsTools

• getAlertConfig

  • 描述: 检索发布者的当前警报配置设置，包括各种事件（例如升级和连接状态更改）的通知首选项。
  • 必需参数: 无
  • 响应模式:

    {
      adminUsers: string[],      // 要通知的管理员用户电子邮件数组
      eventTypes: string[],      // 要监视的事件类型数组
      selectedUsers: string      // 要通知的其他用户
    }
    

  • 事件类型:
    • UPGRADE_WILL_START: 在发布者升级开始之前发出通知
    • UPGRADE_STARTED: 在升级过程启动时发出通知
    • UPGRADE_SUCCEEDED: 成功完成升级后发出通知
    • UPGRADE_FAILED: 如果升级过程失败，则发出通知
    • CONNECTION_FAILED: 当发布者连接出现问题时发出通知
  • 使用示例:
    1. "检查哪些管理员配置为接收升级通知：使用 getAlertConfig 返回当前管理员用户列表及其通知首选项。"
    2. "在计划的维护窗口之前验证警报配置：使用 getAlertConfig 确保正确的团队成员将收到升级事件的通知。"
    3. "审核发布者监控设置：使用 getAlertConfig 显示正在跟踪哪些关键事件以及谁收到通知。"

• updateAlertConfig

  • 描述: 更新发布者的警报配置设置，允许自定义各种系统事件（包括升级和连接状态更改）的通知首选项。
  • 必需参数:

    {
      adminUsers: string[],      // 接收通知的管理员用户电子邮件数组
      eventTypes: string[],      // 要监视的事件类型数组
      selectedUsers: string      // 接收通知的其他用户
    }
    

  • 响应模式: 与 getAlertConfig 相同
  • 使用示例:
    1. "配置通知：更新警报设置以确保正确监控关键事件。"
    2. "修改收件人：调整接收特定类型警报的管理员列表。"
    3. "事件选择：自定义哪些事件类型触发不同用户组的通知。"

LocalBrokerTools

• listLocalBrokers

  • 描述: 列出您的 Netskope 环境中所有已配置的本地代理。 本地代理用于本地零信任网络访问 (ZTNA) 场景，其中最终用户连接到本地代理而不是云代理来访问本地托管的私有应用程序。
  • 必需参数: 无
  • 可选参数:
    • fields: 要在响应中返回的特定字段数组
  • 响应模式:

    {
      status: 'success' | 'not found',
      total: number,
      data: Array<{
        id: number,              // 本地代理的唯一标识符
        name: string,            // 本地代理的显示名称
        common_name: string,     // 用于代理识别的通用名称
        registered: boolean      // 代理的注册状态
      }>
    }
    

  • 使用示例:
    1. "通过列出您的本地代理来监控您的本地代理部署，以获得所有已注册代理及其当前状态的概述。"
    2. "验证高可用性设置：通过查看已部署代理的列表，检查您是否为每个站点配置了多个本地代理。"
    3. "审核代理注册：列出所有本地代理以识别任何需要注意的未注册实例。"

• createLocalBroker

  • 描述: 创建一个新的本地代理实例来处理本地 ZTNA 流量。 这通常用于设置新站点或扩展现有位置的容量。
  • 必需参数:

    {
      name: string              // 新本地代理的名称
    }
    

  • 响应模式:

    {
      status: 'success' | 'not found',
      data: {
        id: number,             // 分配的唯一标识符
        name: string,           // 配置的代理名称
        common_name: string,    // 分配的通用名称
        registered: boolean     // 初始注册状态
      }
    }
    

  • 使用示例:
    1. "部署新站点：创建两次本地代理，以确保新办公地点的高可用性。"
    2. "扩展容量：通过创建新的代理实例来添加额外的本地代理以处理增加的本地流量。"
    3. "初始化 HA 设置：创建多个本地代理，其描述性名称指示其站点和角色。"

• getLocalBroker

  • 描述: 按 ID 检索有关特定本地代理的详细信息。 使用此功能来监控各个代理实例的状态和配置。
  • 必需参数:
    • id: 要检索的本地代理的数字标识符
  • 响应模式:

    {
      status: 'success' | 'not found',
      data: {
        id: number,             // 代理的唯一标识符
        name: string,           // 代理的显示名称
        common_name: string,    // 代理的通用名称
        registered: boolean     // 当前注册状态
      }
    }
    

  • 使用示例:
    1. "检查代理运行状况：检索特定代理详细信息以验证其注册状态和配置。"
    2. "排除连接故障：获取有关遇到问题的代理的详细信息。"
    3. "验证部署：通过检索其详细信息来确认新代理的成功创建。"

• updateLocalBroker

  • 描述: 更新现有本地代理的配置。 这允许您修改代理设置（例如其名称），同时保持其身份和连接。
  • 必需参数:

    {
      id: number,               // 要更新的代理的标识符
      name: string              // 代理的新名称
    }
    

  • 响应模式:

    {
      status: 'success' | 'not found',
      data: {
        id: number,             // 代理的标识符
        name: string,           // 更新的代理名称
        common_name: string,    // 代理的通用名称
        registered: boolean     // 当前注册状态
      }
    }
    

  • 使用示例:
    1. "为了清晰起见而重命名：更新代理的名称以更好地反映其在您的基础设施中的位置或角色。"
    2. "标准化命名：修改代理名称以遵循您组织中更新的命名约定。"
    3. "更新 HA 对：调整代理名称以清楚地指示主角色和辅助角色。"

• deleteLocalBroker

  • 描述: 从您的 Netskope 配置中删除本地代理。 在停用代理或清理未使用的实例时使用此功能。
  • 必需参数:
    • id: 要删除的本地代理的数字标识符
  • 响应模式:

    {
      status: 'success' | 'not found'
    }
    

  • 使用示例:
    1. "停用旧代理：删除不再需要或已被替换的代理。"
    2. "清理测试实例：删除为测试目的而创建的临时代理。"
    3. "站点整合：从已停用的位置删除代理，同时保持活动站点的服务。"

• getBrokerConfig

  • 描述: 检索本地代理的全局配置设置，包括影响所有代理实例的主机名配置。
  • 必需参数: 无
  • 响应模式:

    {
      status: 'success' | 'not found',
      data: {
        hostname: string        // 全局主机名配置
      }
    }
    

  • 使用示例:
    1. "查看全局设置：检查影响所有本地代理的当前主机名配置。"
    2. "准备更改：在计划更新之前验证现有配置。"
    3. "审核配置：确保主机名设置与您的网络架构一致。"

• updateBrokerConfig

  • 描述: 更新所有本地代理的全局配置设置，允许您修改系统范围的代理行为。
  • 必需参数:

    {
      hostname: string          // 新主机名配置
    }
    

  • 响应模式:

    {
      status: 'success' | 'not found',
      data: {
        hostname: string        // 更新的主机名配置
      }
    }
    

  • 使用示例:
    1. "修改全局设置：更新主机名配置以反映网络更改。"
    2. "基础设施更新：调整代理配置以适应新的网络要求。"
    3. "标准化设置：确保所有代理实例的主机名配置一致。"

• generateLocalBrokerRegistrationToken

  • 描述: 为特定本地代理生成新的注册令牌，从而实现与 Netskope 管理平面的安全注册。
  • 必需参数:
    • id: 本地代理的数字标识符
  • 响应模式:

    {
      status: 'success' | 'not found',
      data: {
        token: string          // 生成的注册令牌
      }
    }
    

  • 使用示例:
    1. "保护新代理：生成一个令牌以安全地注册新部署的本地代理。"
    2. "重新注册代理：在需要重新建立代理注册时创建一个新令牌。"
    3. "令牌轮换：生成新的注册令牌作为安全维护的一部分。"

PolicyTools

• listRules

  • 描述: 列出您的 Netskope 专用访问环境中配置的所有策略规则。 这些规则使用零信任网络访问 (ZTNA) 原则定义私有应用程序的访问控制。
  • 必需参数: 无
  • 可选参数:
    • fields: 要返回的特定字段的数组
    • filter: 规则的筛选条件
    • limit: 要返回的最大规则数
    • offset: 要跳过的规则数
    • sortby: 要排序的字段
    • sortorder: 排序方向（“asc”或“desc”）
  • 响应模式:

    {
      data: {
        rules: Array<{
          id: number,
          name: string,
          description?: string,
          enabled: boolean,
          action: 'allow' | 'block',
          policy_group_id: number,
          priority: number,
          conditions: Array<{
            type: 'private_app' | 'user' | 'group' | 'organization_unit' | 'location' | 'device',
            operator: 'in' | 'not_in' | 'equals' | 'not_equals' | 'contains' | 'not_contains' | 'starts_with' | 'ends_with',
            value: string | string[] | number | number[]
          }>,
          created_at: string,
          updated_at: string
        }>
      },
      status: 'success' | 'error',
      total: number
    }
    

  • 使用示例:
    1. "审核访问策略以查看所有已配置的规则及其条件，以确保正确的访问控制。"
    2. "确定规则优先级：按优先级对规则进行排序，以了解策略评估的顺序并识别潜在的冲突。"
    3. "筛选特定策略：使用筛选器参数检索与特定应用程序或用户组相关的规则。"

• getRule

  • 描述: 按 ID 检索有关特定策略规则的详细信息。 使用此功能来检查各个规则配置和条件。
  • 必需参数:
    • id: 策略规则的数字标识符
  • 可选参数:
    • fields: 要返回的特定字段的数组
  • 响应模式:

    {
      data: {
        id: number,
        name: string,
        description?: string,
        enabled: boolean,
        action: 'allow' | 'block',
        policy_group_id: number,
        priority: number,
        conditions: Array<{
          type: 'private_app' | 'user' | 'group' | 'organization_unit' | 'location' | 'device',
          operator: 'in' | 'not_in' | 'equals' | 'not_equals' | 'contains' | 'not_contains' | 'starts_with' | 'ends_with',
          value: string | string[] | number | number[]
        }>,
        created_at: string,
        updated_at: string
      },
      status: 'success' | 'error'
    }
    

  • 使用示例:
    1. "排除访问问题：检查特定规则详细信息以了解为什么可能阻止或允许访问。"
    2. "验证规则条件：检查为关键访问策略配置的确切条件。"
    3. "查看规则历史记录：检查创建和更新时间戳以跟踪策略更改。"

• createRule

  • 描述: 创建新的策略规则以控制对私有应用程序的访问。 规则可以基于各种条件，包括用户身份、设备状态和位置。
  • 必需参数:

    {
      name: string,                // 规则名称
      description?: string,        // 可选规则描述
      enabled: boolean,            // 规则状态
      action: 'allow' | 'block',   // 访问操作
      policy_group_id: number,     // 关联的策略组
      priority: number,            // 规则优先级
      conditions: Array<{
        type: 'private_app' | 'user' | 'group' | 'organization_unit' | 'location' | 'device',
        operator: 'in' | 'not_in' | 'equals' | 'not_equals' | 'contains' | 'not_contains' | 'starts_with' | 'ends_with',
        value: string | string[] | number | number[]
      }>
    }
    

  • 使用示例:
    1. "实施最小权限访问：创建仅根据用户角色和设备状态授予对特定应用程序的访问权限的规则。"
    2. "设置基于位置的策略：定义基于用户位置限制访问的规则以满足合规性要求。"
    3. "配置基于组的访问：创建允许特定用户组访问指定的私有应用程序的规则。"

• updateRule

  • 描述: 更新现有策略规则的配置。 使用此功能来修改访问控制、条件或规则属性。
  • 必需参数:
    • id: 要更新的规则的数字标识符
    • data: 更新的规则配置，遵循与 create_rule 相同的模式
  • 响应模式:

    {
      data: {
        // 更新的规则详细信息（与 get_rule 响应相同）
      },
      status: 'success' | 'error'
    }
    

  • 使用示例:
    1. "调整访问条件：修改规则条件以适应新的安全要求或组织变更。"
    2. "更新规则优先级：更改规则的优先级以确保正确的策略评估顺序。"
    3. "启用/禁用规则：在维护期间或实施策略更改时切换规则状态。"

• deleteRule

  • 描述: 从您的配置中删除策略规则。 请谨慎使用，因为这会永久删除访问控制策略。
  • 必需参数:
    • id: 要删除的规则的数字标识符
  • 响应模式:

    {
      status: 'success' | 'error'
    }
    

  • 使用示例:
    1. "清理过时的策略：删除不再需要或已被新策略取代的规则。"
    2. "策略整合：合并策略配置后删除冗余规则。"
    3. "删除临时规则：清理为特定项目或维护创建的临时访问策略。"

PrivateAppsTools

• createPrivateApp

  • 描述: 在您的 Netskope 环境中创建一个新的私有应用程序。 这允许您定义和配置将通过您的零信任网络访问 (ZTNA) 基础设施访问的应用程序。
  • 必需参数:

    {
      app_name: string,                    // 私有应用程序的名称
      host: string,                        // 应用程序的主机地址
      clientless_access: boolean,          // 启用无客户端访问
      is_user_portal_app: boolean,         // 在用户门户中显示
      protocols: Array<{
        port: string,                      // 端口号
        type: 'tcp' | 'udp'               // 协议类型
      }>,
      publisher_tags?: Array<{            // 可选发布者标签
        tag_name: string
      }>,
      publishers: Array<{                 // 关联的发布者
        publisher_id: string,
        publisher_name: string
      }>,
      trust_self_signed_certs: boolean,   // 信任自签名证书
      use_publisher_dns: boolean,         // 使用发布者 DNS
      allow_unauthenticated_cors?: boolean, // 可选 CORS 设置
      allow_uri_bypass?: boolean,         // 可选 URI 绕过
      bypass_uris?: string[],            // 可选绕过 URI
      real_host?: string,                // 可选真实主机
      app_option?: Record<string, unknown> // 其他选项
    }
    

  • 响应模式:

    {
      data: {
        allow_unauthenticated_cors: boolean,
        allow_uri_bypass: boolean,
        uribypass_header_value: string,
        bypass_uris: string[],
        app_option: Record<string, unknown>,
        clientless_access: boolean,
        host: string,
        id: number,
        is_user_portal_app: boolean,
        name: string,
        protocols: Array<{
          ports: string[],
          type: string
        }>,
        real_host: string,
        service_publisher_assignments: Array<{
          primary: boolean,
          publisher_id: number,
          publisher_name: string,
          reachability: {
            error_code: number,
            error_string: string,
            reachable: boolean
          },
          service_id: number
        }>,
        tags: Array<{
          tag_id: number,
          tag_name: string
        }>,
        trust_self_signed_certs: boolean,
        use_publisher_dns: boolean
      },
      status: 'success' | 'not found'
    }
    

  • 使用示例:
    1. "部署内部应用程序：为具有特定协议和安全设置的内部 Web 服务创建一个私有应用程序定义。"
    2. "配置高可用性：设置具有多个发布者以实现冗余的私有应用程序。"
    3. "启用安全访问：创建一个具有严格安全设置和特定绕过规则的私有应用程序。"

• updatePrivateApp

  • 描述: 更新现有私有应用程序的配置，允许修改访问设置、协议和安全参数。
  • 必需参数:

    {
      id: number,                         // 应用程序 ID
      // 所有其他字段与 create_private_app 相同
    }
    

  • 响应模式: 与 create_private_app 相同
  • 使用示例:
    1. "修改安全设置：更新证书信任设置和 CORS 配置以增强安全性。"
    2. "调整访问参数：更新协议或绕过规则以适应不断变化的要求。"
    3. "重新分配发布者：修改处理应用程序流量的发布者列表。"

• deletePrivateApp

  • 描述: 从您的 Netskope 配置中删除私有应用程序。 此操作会永久删除应用程序定义和关联的访问控制。
  • 必需参数:
    • id: 私有应用程序的数字标识符
  • 响应模式:

    {
      status: number,
      result: string
    }
    

  • 使用示例:
    1. "停用服务：删除不再使用的私有应用程序。"
    2. "清理测试应用程序：删除用于测试的临时应用程序。"
    3. "删除已弃用的服务：在基础设施更新期间清理旧的应用程序定义。"

• getPrivateApp

  • 描述: 检索有关特定私有应用程序的详细配置信息。
  • 必需参数:
    • id: 私有应用程序的数字标识符
  • 响应模式: 与 create_private_app 响应相同
  • 使用示例:
    1. "审核配置：查看私有应用程序的详细设置以进行合规性检查。"
    2. "排除访问故障：检查应用程序配置以解决连接问题。"
    3. "验证设置：在更改应用程序后确认正确的配置。"

• listPrivateApps

  • 描述: 检索所有已配置的私有应用程序及其配置的列表。
  • 必需参数: 无
  • 可选参数:
    • fields: 要返回的特定字段
    • filter: 筛选条件
    • query: 搜索查询
    • limit: 最大结果数
    • offset: 要跳过的结果数
  • 响应模式:

    {
      data: Array<{
        // 与 get_private_app 响应相同的字段
      }>,
      status: 'success' | 'not found',
      total: number
    }
    

  • 使用示例:
    1. "清点应用程序：获取所有私有应用程序的完整列表以进行审核。"
    2. "按条件筛选：搜索具有特定配置或标签的应用程序。"
    3. "分页查看：以可管理的分块检索应用程序以进行大规模部署。"

• getPrivateAppTags

  • 描述: 检索与私有应用程序关联的所有标签，这对于组织和分类应用程序非常有用。
  • 必需参数: 无
  • 可选参数:
    • query: 标签的搜索查询
    • limit: 最大标签数
    • offset: 要跳过的标签数
  • 响应模式:

    {
      data: Array<{
        tag_id: number,
        tag_name: string
      }>,
      status: 'success' | 'not found'
    }
    

  • 使用示例:
    1. "列出类别：检索所有标签以了解应用程序分类。"
    2. "搜索标签：查找与特定条件匹配的特定标签。"
    3. "标签清点：查看所有可用标签以进行标准化。"

• createPrivateAppTags

  • 描述: 将新标签与私有应用程序关联，以实现更好的组织和管理。
  • 必需参数:
    • id: 应用程序标识符
    • tags: 标签对象数组
  • 使用示例:
    1. "分类应用程序：添加组织标签以对相关应用程序进行分组。"
    2. "环境标记：根据应用程序的部署环境标记应用程序。"
    3. "团队分配：添加标签以指示哪个团队拥有或管理应用程序。"

• updatePrivateAppTags

  • 描述: 更新与一个或多个私有应用程序关联的标签。
  • 必需参数:
    • ids: 应用程序标识符数组
    • tags: 更新的标签对象数组
  • 使用示例:
    1. "批量标签更新：同时修改多个应用程序的标签。"
    2. "标签标准化：更新标签以符合新的命名约定。"
    3. "所有权变更：更新标签以反映新的团队分配。"

• updatePrivateAppPublishers

  • 描述: 更新私有应用程序的发布者分配，控制哪些发布者处理应用程序流量。
  • 必需参数:

    {
      private_app_ids: string[],          // 应用程序 ID
      publisher_ids: string[]             // 发布者 ID
    }
    

  • 使用示例:
    1. "负载平衡：在多个发布者之间分配应用程序流量。"
    2. "发布者迁移：将应用程序移动到新的或不同的发布者。"
    3. "HA 配置：添加备份发布者以实现高可用性。"

• deletePrivateAppPublishers

  • 描述: 从私有应用程序中删除发布者分配。
  • 必需参数:

    {
      private_app_ids: string[],          // 应用程序 ID
      publisher_ids: string[]             // 要删除的发布者 ID
    }
    

  • 使用示例:
    1. "停用发布者：从应用程序配置中删除旧的发布者。"
    2. "清理分配：删除不必要的发布者分配。"
    3. "重新配置路由：在流量流更新期间删除发布者。"

• getDiscoverySettings

  • 描述: 检索私有应用程序的当前发现设置，这些设置控制如何发现和监控应用程序。
  • 必需参数: 无
  • 使用示例:
    1. "查看发现：检查当前应用程序发现配置。"
    2. "审核设置：验证发现参数以符合合规性。"
    3. "监控配置：检查如何发现和跟踪应用程序。"

• getPolicyInUse

  • 描述: 检索与指定的私有应用程序关联的活动策略。
  • 必需参数:
    • ids: 应用程序标识符数组
  • 使用示例:
    1. "策略审核：查看哪些策略正在影响特定应用程序。"
    2. "访问控制查看：验证策略分配以符合安全合规性。"
    3. "排除访问故障：在调查访问问题时检查策略。"

PublishersTools

• listPublishers

  • 描述: 列出您的 Netskope 环境中配置的所有发布者。 发布者是处理私有应用程序流量的组件，需要进行适当的管理才能获得最佳性能。
  • 必需参数: 无
  • 可选参数:
    • fields: 要在响应中返回的特定字段
  • 响应模式:

    {
      data: {
        publishers: Array<{
          apps_count: number,
          assessment: {
            ca_certs_status: {
              hashes: string[],
              last_modified: number
            },
            eee_support: boolean,
            hdd_free: string,
            hdd_total: string,
            ip_address: string,
            latency: number,
            version: string
          },
          capabilities: {
            DTLS: boolean,
            EEE: boolean,
            auto_upgrade: boolean,
            nwa_ba: boolean,
            pull_nsconfig: {
              orgkey_exist: boolean,
              orguri_exist: boolean
            }
          },
          common_name: string,
          connected_apps: string[],
          id: number,
          lbrokerconnect: boolean,
          name: string,
          publisher_upgrade_profiles_id: number,
          registered: boolean,
          status: 'connected' | 'not registered',
          stitcher_id: number,
          sticher_pop: string,
          upgrade_request: boolean,
          upgrade_status: {
            upstat: string
          }
        }>
      },
      status: 'success' | 'not found',
      total: number
    }
    

  • 使用示例:
    1. "监控部署：列出所有发布者以检查其连接状态和功能。"
    2. "审核配置：查看发布者设置和关联的应用程序。"
    3. "容量规划：检查发布者上的应用程序数量和负载。"

• getPublisher

  • 描述: 检索有关特定发布者的详细信息，包括其配置、状态和功能。
  • 必需参数:
    • id: 发布者的数字标识符
  • 响应模式: 与 list_publishers 响应中的单个发布者相同
  • 使用示例:
    1. "运行状况检查：获取特定发布者的详细状态信息。"
    2. "排除连接故障：检查发布者的功能和连接状态。"
    3. "版本验证：检查发布者版本和升级状态。"

• createPublisher

  • 描述: 在您的 Netskope 环境中创建一个新的发布者实例。
  • 必需参数:

    {
      name: string,                        // 发布者名称
      lbrokerconnect?: boolean,           // 可选本地代理连接
      publisher_upgrade_profiles_id?: number // 可选升级配置文件分配
    }
    

  • 响应模式: 与 get_publisher 响应相同
  • 使用示例:
    1. "部署新发布者：为新的数据中心位置创建一个发布者。"
    2. "扩展容量：添加发布者以处理增加的应用程序流量。"
    3. "配置 HA：创建额外的发布者以实现高可用性设置。"

• patchPublisher

  • 描述: 部分更新发布者的配置，允许修改特定设置，同时保持其他设置不变。
  • 必需参数:

    {
      name: string,                        // 发布者名称
      id?: number,                        // 可选发布者 ID
      lbrokerconnect?: boolean,           // 可选本地代理连接
      publisher_upgrade_profiles_id?: number // 可选升级配置文件分配
    }
    

  • 响应模式: 与 get_publisher 响应相同
  • 使用示例:
    1. "更新名称：更改发布者名称以匹配新的命名约定。"
    2. "修改连接：更新本地代理连接设置。"
    3. "分配配置文件：将发布者链接到升级配置文件。"

• updatePublisher

  • 描述: 执行发布者的完整更新，将所有设置替换为提供的值。
  • 必需参数:

    {
      id: number,                         // 发布者 ID
      name: string,                       // 发布者名称
      lbrokerconnect?: boolean,          // 可选本地代理连接
      tags?: Array<{                     // 可选标签
        tag_id: number,
        tag_name: string
      }>
    }
    

  • 响应模式: 与 get_publisher 响应相同
  • 使用示例:
    1. "完全重新配置：一次更新所有发布者设置。"
    2. "标签管理：一起更新发布者标签和配置。"
    3. "重置设置：将现有配置替换为新值。"

• deletePublisher

  • 描述: 从您的 Netskope 配置中删除发布者。 请谨慎使用，因为这会影响应用程序访问。
  • 必需参数:
    • id: 要删除的发布者的数字标识符
  • 响应模式:

    {
      status: 'success' | 'error'
    }
    

  • 使用示例:
    1. "停用发布者：删除正在停用的发布者。"
    2. "清理测试实例：删除用于测试的发布者。"
    3. "删除未使用的：清理不再需要的发布者。"

• bulkUpgradePublishers