文档中心知识库API Explorer
文档中心›ZCF›ZStack Cloud›探索更多›CLI命令使用手册ZCF
文档目录

清单

物理机清单（Host Inventory）

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 0.6
name 请参见 资源属性 0.6
description 请参见 资源属性 是 0.6
zoneUuid 所在区域的uuid。请参见 zone 0.6
clusterUuid 父集群的uuid。 请参见 cluster 0.6
managementIp 请参见 management ip 0.6
hypervisorType 请参见 cluster hypervisor type 0.6
state 请参见 state
  • Enabled
  • Disabled
  • PreMaintenance
  • Maintenance
 0.6
status 请参见 status
  • Connecting
  • Connected
  • Disconnected
 0.6
createDate 请参见 资源属性 0.6
lastOpDate 请参见 资源属性 0.6
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 0.6
systemTags 系统标签， 请参见 创建系统标签(CreateSystemTag) 是 0.6
cpuNum VCPU数目, 请参见 CPU capacity 0.6
cpuSockets 0.6
availableCpuCapacity 0.6
availableMemoryCapacity 0.6
totalCpuCapacity 0.6
totalMemoryCapacity 0.6

示例

{
    "inventories": [
        {
            "architecture": "x86_64",
            "availableCpuCapacity": 40,
            "availableMemoryCapacity": 10231848960,
            "clusterUuid": "9f49c605acd74e32912e59eb0c94733c",
            "cpuNum": 4,
            "cpuSockets": 1,
            "createDate": "Jun 19, 2023 11:59:42 AM",
            "hypervisorType": "KVM",
            "ipmiPort": 623,
            "ipmiPowerStatus": "UN_CONFIGURED",
            "lastOpDate": "Jun 19, 2023 2:13:45 PM",
            "managementIp": "172.20.10.172",
            "name": "Host-1",
            "osDistribution": "helix",
            "osRelease": "Core",
            "osVersion": "7.9",
            "sshPort": 22,
            "state": "Enabled",
            "status": "Connected",
            "totalCpuCapacity": 40,
            "totalMemoryCapacity": 10231848960,
            "username": "root",
            "uuid": "5cc3cf9146cb40a6be0a9574a664d2ca",
            "zoneUuid": "40975d61bc534ba09a0ed98696c21dc8"
        }
    ],
    "success": true
}

物理机Bond信息清单(HostNetworkBonding Inventory)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 3.9.0
hostUuid 物理机UUID 3.9.0
bondingName Bond名称 3.9.0
mode Bond模式 3.9.0
xmitHashPolicy 哈希策略 3.9.0
miiStatus mii状态 3.9.0
mac MAC地址 3.9.0
ipAddresses IP地址 3.9.0
miimon mii监控间隔 3.9.0
allSlavesActive 3.9.0
groupBy 以字段分组，相当于MySQL中的group by关键字。例如groupBy=type 是 3.9.0
createDate 请参见 资源属性 3.9.0
lastOpDate 请参见 资源属性 3.9.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.9.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.9.0
示例
{
  "inventories": [
    {
      "uuid": "2e2226e18e853f20a5791684a1b644c8",
      "hostUuid": "903696c585a639bb8049713b98d93437",
      "bondingName": "bond0",
      "mode": "active-backup 1",
      "xmitHashPolicy": "layer2 0",
      "miiStatus": "up",
      "mac": "ac:1f:6b:93:6c:8c",
      "ipAddresses": [
        "172.20.0.116/16"
      ],
      "miimon": 100.0,
      "allSlavesActive": true,
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM",
      "slaves": [
        {
          "uuid": "17a40aa475cf322494ea82e09066892e",
          "hostUuid": "903696c585a639bb8049713b98d93437",
          "bondingUuid": "2e2226e18e853f20a5791684a1b644c8",
          "interfaceName": "eno1",
          "interfaceType": "bondingSlave",
          "speed": 1000.0,
          "slaveActive": true,
          "carrierActive": true,
          "mac": "ac:1f:6b:93:6c:8c",
          "createDate": "Nov 14, 2017 10:20:57 PM",
          "lastOpDate": "Nov 14, 2017 10:20:57 PM"
        },
        {
          "uuid": "c3716c87b9173cbb8315e7d7f3645bc4",
          "hostUuid": "903696c585a639bb8049713b98d93437",
          "bondingUuid": "2e2226e18e853f20a5791684a1b644c8",
          "interfaceName": "eno2",
          "interfaceType": "bondingSlave",
          "speed": 1000.0,
          "slaveActive": false,
          "carrierActive": false,
          "mac": "ac:1f:6b:93:6c:8c",
          "createDate": "Nov 14, 2017 10:20:57 PM",
          "lastOpDate": "Nov 14, 2017 10:20:57 PM"
        }
      ]
    }
  ]
}

物理机网卡清单(HostNetworkInterface Inventory)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 3.9.0
hostUuid 物理机UUID 3.9.0
bondingUuid Bond UUID 3.9.0
interfaceName 网卡名称 3.9.0
interfaceUuid 物理网口Uuid 5.0.0
mode LLDP工作模式 5.0.0
interfaceType 网卡应用状态，有nomaster、bridgeSlave、bondSlave 3.9.0
speed 网卡速率 3.9.0
slaveActive Bond链路状态 3.9.0
carrierActive 物理链路状态 3.9.0
ipAddresses IP地址 3.9.0
mac MAC地址 3.9.0
pciDeviceAddress 网卡PCI地址 3.9.0
neighborDevice 5.0.0
groupBy 以字段分组，相当于MySQL中的group by关键字。例如groupBy=type 是 3.9.0
createDate 请参见 资源属性 3.9.0
lastOpDate 请参见 资源属性 3.9.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 3.9.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 3.9.0
lldp 请参见lldp清单 (lldp inventory) 5.0.0
示例
{
  "inventories": [
    {
      "uuid": "310ca8ce7010363ca7ac83d37373238f",
      "hostUuid": "7f8d05522f01397e97f60d84f5ffa2b9",
      "bondingUuid": "6fbe88605eed35ba95399687585be3d1",
      "interfaceName": "eno1",
      "interfaceType": "bondingSlave",
      "speed": 1000.0,
      "slaveActive": true,
      "carrierActive": true,
      "mac": "98:03:9b:00:ea:f1",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    },
    {
      "uuid": "3213802883d13c72b54c084233c4de2a",
      "hostUuid": "7f8d05522f01397e97f60d84f5ffa2b9",
      "bondingUuid": "6fbe88605eed35ba95399687585be3d1",
      "interfaceName": "eno2",
      "interfaceType": "bondingSlave",
      "speed": 1000.0,
      "slaveActive": false,
      "carrierActive": false,
      "mac": "98:03:9b:00:ea:f1",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    },
    {
      "uuid": "3015b6b0c74d316699ebe09dc60e1001",
      "hostUuid": "7f8d05522f01397e97f60d84f5ffa2b9",
      "interfaceName": "ens2f0",
      "interfaceType": "noMaster",
      "speed": 1000.0,
      "slaveActive": true,
      "carrierActive": true,
      "ipAddresses": [
        "169.254.0.115/24"
      ],
      "mac": "98:03:9b:00:ea:f2",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    },
    {
      "uuid": "e3b513e177a1313a93b32b290643f849",
      "hostUuid": "7f8d05522f01397e97f60d84f5ffa2b9",
      "interfaceName": "ens2f1",
      "interfaceType": "bridgeSlave",
      "speed": 1000.0,
      "slaveActive": false,
      "carrierActive": false,
      "mac": "98:03:9b:00:ea:f3",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM"
    }
  ]
}

物理机操作系统类型清单（HostOsCategory Inventory）

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 4.6.21
architecture 物理机架构，比如x86_64 4.6.21
osReleaseVersion 物理机操作系统版本 4.6.21
groupBy 以字段分组，相当于MySQL中的group by关键字。例如groupBy=type 4.6.21
createDate 请参见 资源属性 4.6.21
lastOpDate 请参见 资源属性 4.6.21
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 4.6.21
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 4.6.21
metadataList 4.6.21
示例
{
    "inventories": [
        {
            "architecture": "x86_64",
            "createDate": "Apr 11, 2023 11:45:15 AM",
            "lastOpDate": "Apr 11, 2023 11:45:15 AM",
            "metadataList": [
                {
                    "categoryUuid": "230d5035fedb40ec88fc6387bdc7040f",
                    "createDate": "Apr 11, 2023 12:19:36 PM",
                    "hypervisor": "qemu-kvm",
                    "lastOpDate": "Apr 11, 2023 12:19:36 PM",
                    "managementNodeUuid": "4b75c8ae293637baa3b8688c59686665",
                    "uuid": "781bc1e9ec6143be85a701876a7b7923",
                    "version": "4.2.0-635.gf5486e8.el7"
                },
                {
                    "categoryUuid": "230d5035fedb40ec88fc6387bdc7040f",
                    "createDate": "Apr 11, 2023 11:45:15 AM",
                    "hypervisor": "qemu-kvm",
                    "lastOpDate": "Apr 11, 2023 11:45:15 AM",
                    "managementNodeUuid": "eeedf0fe0c8837a48c4094f819229358",
                    "uuid": "8eb9084240ee4d2a8ad2bca26afcc8de",
                    "version": "4.2.0-635.gf5486e8.el7"
                },
                {
                    "categoryUuid": "230d5035fedb40ec88fc6387bdc7040f",
                    "createDate": "Apr 11, 2023 12:18:01 PM",
                    "hypervisor": "qemu-kvm",
                    "lastOpDate": "Apr 11, 2023 12:18:01 PM",
                    "managementNodeUuid": "8941fa368a2b35bbbe6317338667dfdb",
                    "uuid": "e191e9995878443cad6780e2a7fbbb65",
                    "version": "4.2.0-635.gf5486e8.el7"
                }
            ],
            "osReleaseVersion": "helix Core 7.6.1810",
            "uuid": "230d5035fedb40ec88fc6387bdc7040f"
        }
    ],
    "success": true
}

资源虚拟化软件信息清单（KvmHypervisorInfo Inventory）

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 4.6.21
hypervisor 虚拟化软件名称，比如qemu-kvm 4.6.21
version 版本号，比如4.2.0-632.g6a6222b.el7 4.6.21
matchState 和预期版本号的匹配状态，可能的值为 Matched, Unmatched, Unknown 4.6.21
groupBy 以字段分组，相当于MySQL中的group by关键字。例如groupBy=type 4.6.21
createDate 请参见 资源属性 4.6.21
lastOpDate 请参见 资源属性 4.6.21
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 4.6.21
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 4.6.21
示例
{
    "inventories": [
        {
            "createDate": "Apr 11, 2023 12:03:48 PM",
            "hypervisor": "qemu-kvm",
            "lastOpDate": "Apr 11, 2023 12:03:48 PM",
            "matchState": "Matched",
            "uuid": "f5b560bcfc8e48aabae8c022d43812e8",
            "version": "4.2.0-635.gf5486e8.el7"
        }
    ],
    "success": true
}

管理IP（Management IP）

ZStack Cloud管理节点（ZStack Cloud management nodes）使用管理IP访问主机操作系统（虚拟机管理系统）；根据虚拟机管理系统类型的不同，可以有或者没有管理IP。
  • 例如， 在VMware中，访问ESXi主机的官方途径是使用VCenter服务器（VCenter Server）；在这种情况下就没有使用管理IP的必要；
  • 然而，在KVM主机中，ZStack Cloud需要通过管理IP来部署代理程序（agent）到Linux操作系统中。

管理网络（Management Network）

用于管理控制对应的物理资源，例如物理主机、镜像服务器、主存储等需提供IP进行访问的资源时使用的网络。
  • 由于管理节点需要通过管理网络发送命令到物理主机和其他的装置，运行ZStack Cloud管理节点的Linux服务器必须能够访问管理网络。
  • 涉及到特殊应用虚拟机（appliance VMs）时，将使用管理网络，在ZStack Cloud当前版本中这个特殊应用虚拟机是VPC路由器。

启用状态（State）

物理主机有三种可用状态：
  • Enabled（启用）：

    该状态下，允许在该物理主机上创建、启动云主机或迁移云主机到该物理主机上。

  • Disabled（启用）：

    该状态下，不允许在该物理主机上创建、启动云主机或迁移云主机到该物理主机上。

  • Maintenance Mode（维护模式）：

    该状态表明该物理主机在维护状态中。

    当管理员需要实施一些维护工作时可以将物理主机设置为维护模式。例如，安装更多的内存。当主机在维护模式中，不管是API操作还是ZStack Cloud内部任务都不会再在物理主机上执行任何操作。也就是说，类似启动云主机（API），停止云主机（API），挂载主存储（内部）的任务都不能在该物理主机上进行。ZStack Cloud将维护模式设计为两个可用模式： PreMaintenance和Maintenance。主机进入维护模式的顺序如下：
    1. 改变host的可用状态为PreMaintenance（预维护模式）中间态。在这个阶段，ZStack Cloud会尝试将所有运行在该物理主机上的云主机迁移到其他合适的物理主机上。如果迁移失败，ZStack Cloud将停止这些云主机。
    2. 当所有云主机都被迁移或者停止后，ZStack Cloud会将物理主机的可用状态改变为Maintenance。这时，管理员可以开始在物理主机上实施维护工作。

    维护工作结束后，管理员可以通过将物理主机设置为Enabled或Disabled，以使物理主机退出维护模式。

物理主机的可用状态转换图如图 1所示：

图 1. 物理主机可用状态转换图


连接状态（Status）

连接状态反映了物理主机和管理节点之间命令通道（command channel）的状态。命令通道是ZStack Cloud管理节点和物理主机通信并知会其执行操作的途径。
  • 例如， 在KVM管理节点中，命令通道是ZStack Cloud管理节点和运行在物理主机上的Python代理（agents）之间的HTTP连接；
  • 在VMware管理节点中， 命令通道是VCenter服务器和 ESXi主机之间的连接。
物理主机有三种连接状态：
  • Connecting：

    在这种状态时，一个ZStack Cloud管理节点正在尝试建立自己和物理主机之间的命令通道。这时还不能在物理主机上执行任何操作。

  • Connected：

    在这种状态时，ZStack Cloud管理节点和物理主机之间的命令通道已经被成功建立。可以在物理主机上执行操作，只有在这个状态下物理主机才能创建和启动云主机。

  • Disconnected：

    在这种状态时，ZStack Cloud管理节点和物理主机之间的命令通道丢失。这时不能在物理主机上执行任何操作。

在ZStack Cloud管理节点启动过程中会开始和管理的物理主机建立命令通道：
  • 在这个阶段，物理主机的状态是Connecting；
  • 命令通道建立完成后，物理主机的连接状态会变为Connected；
  • 如果管理节点建立命令通道失败， 或者之后某个时候命令通道丢失了，命令通道所对应的物理主机连接状态会变为Disconnected；
  • ZStack Cloud管理节点会周期性的向物理主机发送ping命令（ping commands）以检查命令通道的健康状态；一旦某个物理主机响应失败，或者ping命令超时，物理主机的连接状态就会变为Disconnected。

物理主机的连接状态转换图如图 2所示：

图 2. 物理主机连接状态转换图


电源状态（Power Status）

连接状态反映了反映物理机自身的上电状态。物理主机有以下电源状态：
  • IPMI未纳管：物理机添加至云平台后，默认处于 IPMI 未纳管状态，此时无法获取物理机电源开关机状态。
  • 更新物理机 IPMI 信息后，物理机通过 IPMI 纳管，可获取物理机电源开关机状态，包括开机、开机中、关机、关机中、未知。
物理主机的电源状态转换图如图 3所示：
图 3. 物理主机电源状态转换图


可用状态（State）、连接状态（Status）、电源状态（Power Status）

可用状态、连接状态、电源状态之间没有直接关系。可用状态代表了管理员针对物理主机的意愿，连接状态代表了物理主机的通信状况，而电源状态代表了物理机的上电状态。

lldp清单 (lldp inventory)

名字 描述 可选的 可选的参数值 起始支持版本
lldpUuid LLDP UUID 5.0.0
chassisId 机箱标识 5.0.0
timeToLive 生存时间 5.0.0
managementAddress 管理地址 5.0.0
systemName 系统名称 5.0.0
systemDescription 系统描述 5.0.0
systemCapabilities 系统能力 5.0.0
portId 端口标识 5.0.0
portDescription 端口描述 5.0.0
vlanId VLAN标识 5.0.0
aggregationPortId 聚合端口标识 5.0.0
mtu 最大传输单元 5.0.0
createDate 创建时间 5.0.0
lastOpDate 最后一次修改时间 5.0.0

HBA卡清单(HBA Device Inventory)

名字 描述 可选的 可选的参数值 起始支持版本
createDate 请参见 资源属性 5.3.0
groupBy 以字段分组，相当于MySQL中的group by关键字。例如groupBy=type 是 5.3.0
hbaType HBA卡的类型 5.3.0
hostUuid 物理机UUID 5.3.0
lastOpDate 请参见 资源属性 5.3.0
name 资源名称 5.3.0
nodeName 节点名称 5.3.0
portName 端口名称 5.3.0
portState 端口状态 5.3.0
speed 网卡速率 5.3.0
supportedClasses 服务类别 5.3.0
supportedSpeeds 支持的速度 5.3.0
symbolicName 符号名称 5.3.0
systemTags 系统标签，请参见 创建系统标签(CreateSystemTag) 是 5.3.0
userTags 用户标签，请参见 创建用户标签(CreateUserTag) 是 5.3.0
uuid 请参见 资源属性 3.9.0
示例
{
  "inventories": [
    {
      "portName": "10000090fab38778",
      "portState": "Online",
      "speed": "8 Gbit",
      "supportedSpeeds": "16 Gbit",
      "symbolicName": "QLE2692 FW:v9.07.00 DVR:v10.02.00.106-k",
      "supportedClasses": "Class 3",
      "uuid": "511a5ac34b423ac99a33d5c863531d2e",
      "name": "host",
      "hostUuid": "38e3ebc0b54e3cf8a99db5f7c80ee59e",
      "hbaType": "FC"
    }
  ]
}
上一篇概览下一篇操作（Operations）
CLI命令使用手册 | 5.5.30 | ZStack Cloud · ZCF | ZStack 资源中心