简介
本文档介绍在无法通过UI对服务器执行某些操作时发生争用时可能有用的API请求。
作者:思科TAC工程师Luis Uribe Rojas和技术主管Justin Pierce。
先决条件
要求
Cisco 建议您了解以下主题:
- Intersight
- 统一计算系统(UCS)服务器
- Intersight管理模式(IMM)
- 应用编程接口(API)
使用的组件
本文档中的信息基于以下软件和硬件版本:
- Cisco UCS 6454交换矩阵互联,固件4.2(1m)
- UCSB-B200-M5刀片服务器,固件4.2(1a)
- Intersight软件即服务(SaaS)
本文档中的信息都是基于特定实验室环境中的设备编写的。本文档中使用的所有设备最初均采用原始(默认)配置。如果您的网络处于活动状态,请确保您了解所有命令的潜在影响。
背景信息
Cisco Intersight提供基于云的RESTful API来管理多个数据中心内与Intersight连接的目标。Cisco Intersight基础设施服务包括对物理和虚拟基础设施的部署、监控、管理和支持。
如果无法通过Intersight的用户界面(UI)在Intersight托管服务器上执行某些操作,则由于选项灰显或对UI的访问不可用,API请求可以成为有用的替代方法。
来自Intersight SaaS或Intersight设备帐户的API请求
概述步骤
下面的示例遵循一致的结构,但具体参数和使用的值可能会有所不同。以下是相关步骤的简要总结:
登录到Intersight帐户。
对于SaaS环境,在浏览器中,导航到API Reference并使用您的帐户登录。
注意:对于设备环境,如Intersight Connected Virtual Appliance(CVA)或Intersight Private Virtual Appliance(PVA)在浏览器中,导航到https://<Appliance-Hostname>/apidocs/apirefs并使用设备凭证登录。
- 查找所需的API请求,并使用
GET
使用已知字段值(如序列号、服务器配置文件、服务器名称、设备模块等)过滤呼叫。
- 请使用
PATCH
通过对应的操作进行呼叫,以执行所需的任务
提示:在“查询参数”中,请确保对键和值示例使用相同的精确字母以避免错误。
在《API参考》指南中,请查看 Response Model
选项卡,了解可在呼叫负载中使用的正确语法和所有支持的操作。例如,从 /api/v1/compute/BladeIdentities/,
支持的管理操作为 None
, Decommission
, Recommission
, Reack
, Remove
,和 Replace
.本文档中会使用此模型。
停用/停用服务器
在Intersight API参考文档中,查找 compute/BladeIdentities
请求,选择第一个 GET
调用,然后输入所需的查询参数。
本示例使用以下参数:
密钥 |
价值 |
使用率 |
$filter |
Serial Eq 'FLM2402001A' |
使用提供的序列号过滤到服务器的输出。 |
$select |
Moid |
从该对象中选择要显示的值。显示的值是服务器型号。 |
对此行 PATCH
通过所需操作进行呼叫。此示例使用:
{"AdminAction":"Decommission"}
提示:如果需要重新执行,请使用{"AdminAction":"Recommission"}。
取消分配服务器配置文件
查找Server/Profiles请求并选择第一个GET调用,然后输入所需的查询参数。
本示例使用以下参数:
密钥 |
价值 |
使用率 |
$filter |
Name Eq 'UCSX-Server-boot-SAN' |
过滤输出到已输入名称的服务器配置文件。 |
$select |
Moid,名称 |
从该对象中选择要显示的值。在这种情况下, |
通过所需操作应用PATCH调用。此示例使用:
{"Action":"Unassign"}
删除服务器
在Intersight API参考文档中,查找compute/BladeIdentities请求,然后选择第一个 GET
调用,然后输入所需的查询参数。
本示例使用以下参数:
密钥 |
价值 |
使用率 |
$filter |
Serial Eq 'FLM2402001A' |
要仅过滤提供序列号的服务器输出。 |
$select |
Moid |
从该对象中选择要显示的值。显示的值是服务器型号。 |
通过所需操作应用PATCH调用。此示例使用:
{"AdminAction":"Remove"}
警告:此请求会导致从清单中删除服务器。要将服务器重新添加到域的资产中,需要执行新的发现。这可以通过物理重置服务器或机箱重新发现任务触发。
通过设备控制台中的API资源管理器排除操作故障
通过Device Console,您可以监控设备的运行状况及其与Intersight的连接状态。您可以生成包含诊断信息的技术支持捆绑包,以排除故障和分析问题。此外,设备控制台还能够启动API资源管理器以对服务器执行基于Redfish™的操作。
如果Intersight或设备之间失去连接,设备控制台中的API Explorer也可用于执行一些基本的故障排除操作。
1)打开设备控制台,导航到交换矩阵互联IP地址之一,然后选择Inventory选项卡。
2)导航到需要排除故障的特定设备,选择设备右侧的三个点,然后选择 Launch API Explorer
.API资源管理器仅针对该设备启动,而不针对其他设备。
重新启动服务器的CIMC管理控制器
启动服务器的API资源管理器:
在{ManagerID}中键入CIMC并应用POST Managers/{ManagerId}/Actions/Manager.Reset调用并添加重置的类型。
此示例使用:
{"ResetType": "ForceRestart"}
重新启动I/O模块(IOM)
启动IOM的API资源管理器:
在{ManagerID}中键入CMC并应用POST Managers/{ManagerId}/Actions/Manager.Reset调用并添加重置类型。此示例使用:
{"ResetType": "ForceRestart"}
要重新启动对等IOM,请执行以下操作:ManagerID}字段,输入 PeerCMC
与之前相同的呼叫。
相关信息
Intersight API概述
设备控制台概述