文档目录

三层网络

概览

三层网络:云主机使用的网络配置,包含了IP地址范围、网关、DNS、网络服务等。
  • IP地址范围包含起始和结束IP地址、子网掩码、网关等,例如可指定172.20.12.2172.20.12.255,子网掩码指定255.255.0.0,网关指定172.20.0.1;也可使用CIDR无域间路由来表示,例如192.168.1.0/24
  • DNS用于设置云主机网络的DNS解析服务。

公有网络

一般表示可直接连通互联网的网络,由于公有网络是一个逻辑概念,在无法连接互联网的环境中,用户也可以自定义该网络。在VPC网络中可以提供网络服务。
  • 可用于扁平网络创建使用公网的云主机;
  • 可用于VPC网络环境,单独创建使用公网的云主机。

系统网络

管理节点用于特定用途的网络。
  • 可用于部署配置相关资源的管理网络,例如部署物理机、主存储、镜像服务器、路由器等资源;
  • 可用于云主机迁移的迁移网络;
  • 如果网络资源不足,可与公有网络共用;
  • 独立的系统网络用于特定用途,例如管理路由器的网络;
  • 系统网络不能用于创建普通云主机。

私有网络

可称之为业务网络或接入网络,云主机使用的网络,一般情况下设置为私网。私有网络指定为云主机使用的网络,支持两种网络架构模型:扁平网络、VPC网络。

特定场景网络

  • 管理网络
    作为系统网络的一种,用于管理控制对应的物理资源。
    • 例如物理机、镜像服务器、主存储等需提供IP进行访问的资源时使用的网络;
    • 创建VPC路由器时需要VPC路由器存在管理节点互通的IP,以便部署agent及agent代理消息返回。
  • 存储网络

    用于表示共享存储指定的存储网络,可使用此存储网络来判断云主机健康状态;建议提前规划单独的存储网络,避免潜在风险。

  • VDI网络

    在创建集群时,可指定VDI网络的CIDR,此网络用于VDI连接的协议流量。如果不设置,VDI将默认使用管理网络。

  • 迁移网络

    在创建集群时,可指定迁移网络的CIDR,此网络用于云主机在当前云平台内迁移。如果不设置,云主机迁移将默认使用管理网络。

  • 镜像同步网络
    同一管理节点下的ImageStore类型的镜像服务器间镜像同步使用的网络。
    • 如果已部署镜像同步单独使用的网络,在添加镜像仓库时,可指定镜像同步网络的CIDR;
    • 如果不设置,镜像同步将默认使用管理网络;
    • 如果源镜像仓库和目标镜像仓库均设置镜像同步网络,起作用的是目标镜像仓库的镜像同步网络。
  • 数据网络
    计算节点和镜像服务器之间进行数据通讯的网络。
    • 使用单独的数据网络,可避免网络拥塞,提高传输效率;
    • 如果不设置,将默认使用管理网络。
  • 备份网络
    ZStack提供灾备服务高级功能。在本地灾备场景下,本地云主机/云盘/数据库备份到本地备份服务器、创建CDP任务、或恢复CDP数据时,均使用该备份网络。
    • 如果已部署本地灾备单独使用的网络,在添加本地备份服务器时,可指定备份网络的CIDR;
    • 使用单独的备份网络,可避免网络拥塞,提高传输效率;
    Note:

    灾备服务以单独的功能模块形式提供,需提前购买灾备服务模块许可证,且需在购买云平台许可证基础上使用,不可单独使用。

  • 流量网络:

    端口镜像的专用网络,用于将网卡的网络流量镜像到远端,不能作为其他网络使用,不能用于创建云主机。

注意事项

  • 创建云主机时,可指定多个网络。可指定多个扁平网络、或多个云路由网络、或多个VPC网络,或指定扁平网络、云路由网络、VPC网络的混合使用。
  • 支持多级网络,而且多级网络的二层网络可以实际通信,需要特别避免IP地址空间冲突的问题。
  • 一个二层网络可用于创建多个三层网络,若二层网络为HarewareVxlanNetwork类型,创建的私有网络仅支持扁平网络及相应网络服务,不支持云路由网络。

清单

属性

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 0.6
name 请参见 资源属性 0.6
description 请参见 资源属性 0.6
zoneUuid 所在区域的uuid,请参见 zone 0.6
l2NetworkUuid 父L2网络的uuid, 请参见 L2 network 0.6
state 请参见 state
  • Enabled
  • Disabled
0.6
dnsDomain 请参见 domain 0.6
ipRanges 请参见 IP range列表 0.6
dns 请参见 l3Network DNS列表 0.6
networkServices 请参见 l3Network network service reference列表 0.6
type L3网络类型(L3 network type)
  • L3BasicNetwork
0.6
createDate 请参见 资源属性 0.6
lastOpDate 请参见 资源属性 0.6

示例

{
    "inventories": [
        {
            "category": "Private",
            "createDate": "Nov 2, 2017 1:21:40 PM",
            "dns": [
                "223.5.5.5"
            ],
            "ipRanges": [
                {
                    "createDate": "Nov 2, 2017 1:21:41 PM",
                    "endIp": "10.141.74.100",
                    "gateway": "10.141.0.1",
                    "l3NetworkUuid": "a0190782ed35439b92959844c96a7323",
                    "lastOpDate": "Nov 2, 2017 1:21:41 PM",
                    "name": "l3-bp",
                    "netmask": "255.255.0.0",
                    "networkCidr": "10.141.0.1/16",
                    "startIp": "10.141.74.1",
                    "uuid": "954f7884656e48a395a022935569b65d"
                }
            ],
            "l2NetworkUuid": "8f6a39152a72439b9ece210154de0339",
            "lastOpDate": "Nov 2, 2017 1:21:40 PM",
            "name": "l3-bp",
            "networkServices": [
                {
                    "l3NetworkUuid": "a0190782ed35439b92959844c96a7323",
                    "networkServiceProviderUuid": "a903477ad67746e8a4f773c5e28b5884",
                    "networkServiceType": "SecurityGroup"
                },
                {
                    "l3NetworkUuid": "a0190782ed35439b92959844c96a7323",
                    "networkServiceProviderUuid": "a963ab4a76384a4ab3b88fb39ef627fc",
                    "networkServiceType": "Eip"
                },
                {
                    "l3NetworkUuid": "a0190782ed35439b92959844c96a7323",
                    "networkServiceProviderUuid": "a963ab4a76384a4ab3b88fb39ef627fc",
                    "networkServiceType": "DHCP"
                },
                {
                    "l3NetworkUuid": "a0190782ed35439b92959844c96a7323",
                    "networkServiceProviderUuid": "a963ab4a76384a4ab3b88fb39ef627fc",
                    "networkServiceType": "Userdata"
                }
            ],
            "state": "Enabled",
            "system": false,
            "type": "L3BasicNetwork",
            "uuid": "a0190782ed35439b92959844c96a7323",
            "zoneUuid": "e59b71e99d8a4ea1952b578388b8cd1d"
        }
    ],
    "success": true
}

可用状态(State)

L3网络有两种可用状态:
  • Enabled:

    在这种状态下,允许创建新的云主机。

  • Disabled:

    在这种状态下,不允许创建新的云主机。

DNS域(DNS Domain)

DNS域用来将L3网络中主机的机器名扩展为FQDNs(完全合格的域名,Full Qualified Domain Name); 例如,云主机的主机名是vm1并且L3网络的DNS域是zstack.org, 主机名最终会被展开为vm1.zstack.org。

IP地址范围(IP Range)

ZStack Cloud当前版本仅支持IPv4 IP地址范围。

清单(Inventory)
名字 描述 可选的参数 可选的参数值 起始支持版本
uuid 请参见 资源属性 0.6
name 请参见 资源属性 0.6
description 请参见 资源属性 0.6
startIp 地址范围的起始IP 0.6
endIp 地址范围的结束IP 0.6
netmask 子网掩码 0.6
gateway 子网网关 0.6
createDate 请参见 资源属性 0.6
lastOpDate 请参见 资源属性 0.6
示例
{
    "inventories": [
        {
            "createDate": "Oct 30, 2017 3:59:06 PM",
            "endIp": "10.141.250.100",
            "gateway": "10.141.0.1",
            "l3NetworkUuid": "54bc8bea439a49dc82acbe302da05c66",
            "lastOpDate": "Oct 30, 2017 3:59:06 PM",
            "name": "L3-扁平",
            "netmask": "255.255.0.0",
            "networkCidr": "10.141.0.1/16",
            "startIp": "10.141.250.1",
            "uuid": "f0b8e83e4dc646c69c7f9a0ff53b6367"
        }
    ],
    "success": true
}

DNS

当DNS网络服务启用时,一个L3网络可以有一个或多个DNS起作用。

L2网络和L3网络(L2 Networks and L3 Networks)

类似于一个二层广播域可以包含多个子网, 可以在同一个L2网络中创建多个L3网络; 但由于这些L3网络没有被互相隔离,仍然可以被监听; 这样使用有一定的风险。

网络服务引用(Network Service References)

网络服务引用展现了L3网络上启用的网络服务以及网络服务提供者。

清单(Inventory)
名字 描述 可选的 可选的参数值 起始支持版本
l3NetworkUuid L3网络Uuid 0.6
networkServiceProviderUuid 网络服务提供模块的UUID 0.6
networkServiceType 网络服务类型
  • DHCP
  • DNS
  • SNAT
  • PortForwarding
  • EIP
  • SecurityGroup
  • Userdata
  • LoadBalancer
  • IPsec
  • CentralizedDNS
  • VRouterRoute
  • VipQos
0.6
示例
{
    "inventories": [
        {
            "l3NetworkUuid": "cdb7f3151c50453ba0e8c89356e250f6",
            "networkServiceProviderUuid": "a903477ad67746e8a4f773c5e28b5884",
            "networkServiceType": "SecurityGroup"
        },
        {
            "l3NetworkUuid": "cdb7f3151c50453ba0e8c89356e250f6",
            "networkServiceProviderUuid": "a963ab4a76384a4ab3b88fb39ef627fc",
            "networkServiceType": "Userdata"
        },
        {
            "l3NetworkUuid": "cdb7f3151c50453ba0e8c89356e250f6",
            "networkServiceProviderUuid": "a963ab4a76384a4ab3b88fb39ef627fc",
            "networkServiceType": "DHCP"
        }
    ],
    "success": true
}

地址池清单(AddressPool Inventory)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 请参见 资源属性 3.9.0
name 请参见 资源属性 3.9.0
description 请参见 资源属性 3.9.0
l3NetworkUuid 三层网络UUID 3.9.0
startIp 起始IP 3.9.0
endIp 结束IP 3.9.0
netmask 掩码 3.9.0
gateway 网关 3.9.0
networkCidr 网络CIDR 3.9.0
ipVersion ip协议号 3.9.0
addressMode IPv6地址分配模式 3.9.0
prefixLen 掩码长度 3.9.0
ipRangeType 网络段类型
  • Normal
  • AddressPool
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": [
    {
      "l3NetworkUuid": "81ce7828f3f63c0ea8a69dd9139bdaa0",
      "name": "Test-IPRange",
      "networkCidr": "192.168.10.0/24",
      "ipRangeType": "AddressPool"
    }
  ]
}

操作(Operations)

创建三层网络(CreateL3Network)

管理员可以使用CreateL3Network创建三层网络。例如:
CreateL3Network name=L3Network l2NetworkUuid=21fd3d1876594b79bab0f2f1dfa1d03c dnsDomain="site.net"

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
name 三层网络名称 0.6
description 三层网络的详细描述 0.6
type 三层网络类型 0.6
l2NetworkUuid 二层网络uuid 0.6
ipVersion IP协议号
  • 4
  • 6
4.6.21
system 是否用于系统云主机 0.6
dnsDomain DNS域 0.6
resourceUuid 资源uuid。若指定,三层网络会使用该字段值作为uuid 0.6
category 网络类型,需要与system标签搭配使用,system为false时可设置为Pubic、Private
  • Public
  • Private
  • System
2.2
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 L3NetworkVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 L3NetworkVO 0.6
tagUuids 标签UUID列表 4.6.21
enableIPAM IP地址管理是否启用 4.6.21
timeout
Note:
  • ZStack Cloud创建三层网络时支持指定端口镜像网络,SystemTags增加mirrorNetwork选项。
    • 选项格式为:mirrorNetwork::{L3NetworkVOUuid}
    • 例如:mirrorNetwork::1c707a63817b4f29b1235fa1f76c0ccc
  • ZStack Cloud创建三层网络时支持记录vpc网关关联的华为sdn虚拟路由uuid,SystemTags增加logicalRouterUuid选项。
    • 选项格式为:logicalRouterUuid::{%s}
    • 例如:logicalRouterUuid::ecb4a71e0e32476da948a583ea0a220d

删除三层网络(DeleteL3Network)

管理员可以使用DeleteL3Network删除三层网络。例如:
DeleteL3Network uuid=18874dbd1f0c4e8abd399776ae914401

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 三层网络uuid 0.6
deleteMode 请参见 删除资源(Delete Resources)
  • Permissive
  • Enforcing
0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 L3NetworkVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 L3NetworkVO 0.6
timeout

查询三层网络(QueryL3Network)

管理员可以使用QueryL3Network查询三层网络。例如:
QueryL3Network uuid=9082f45fce9c46f19b2ab5ff117511d6
QueryL3Network vmNic.l3NetworkUuid=9082f45fce9c46f19b2ab5ff117511d6

原生域查询(Primitive Fields of Query)

请参见 L3 network inventory

嵌套和扩展域查询(Nested and Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
l2Network L2 network inventory 这个L3网络所属的L2网络 0.6
ipRanges ipRanges inventory 0.6
zone zone inventory 父区域 0.6
networkServices networkServices inventory 0.6
serviceProvider serviceProvider inventory 0.6
vmNic vmNic inventory 0.6
hostRoute hostRoute inventory 2.3

更新三层网络(UpdateL3Network)

管理员可以使用UpdateL3Network更新三层网络。例如:
UpdateL3Network name=test_L3Network uuid=3dbf30420a4b4da8bcd69f99df7fb631

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 三层网络uuid 0.6
name 三层网络名称 0.6
description 三层网络的详细描述 0.6
system 是否用于系统云主机 0.6
dnsDomain DNS域 2.6.0
category 网络类型,需要与system标签搭配使用,system为true时可设置为Pubic、Private
  • Public
  • Private
  • System
2.2
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 L3NetworkVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 L3NetworkVO 0.6
timeout

获取三层网络类型(GetL3NetworkTypes)

管理员可以使用GetL3NetworkTypes获取三层网络类型。返回示例:
{
    "l3NetworkTypes": [
        "L3BasicNetwork",
        "L3VpcNetwork"
    ]
}

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 L3NetworkVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 L3NetworkVO 0.6
timeout

改变三层网络状态(ChangeL3NetworkState)

管理员可以使用ChangeL3NetworkState改变三层网络状态。例如:
ChangeL3NetworkState uuid=3dbf30420a4b4da8bcd69f99df7fb631 stateEvent=disable

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 三层网络uuid 0.6
stateEvent 状态
  • enable
  • disable
0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 L3NetworkVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 L3NetworkVO 0.6
timeout

获取网络DHCP服务所用地址(GetL3NetworkDhcpIpAddress)

管理员可以使用GetL3NetworkDhcpIpAddress获取网络DHCP服务所用地址。例如:
GetL3NetworkDhcpIpAddress l3NetworkUuid=aa6ec2f40b93413aa843ee5d76ddf73e

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
l3NetworkUuid 三层网络uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 L3NetworkVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 L3NetworkVO 0.6
timeout

从三层网络移除DNS(RemoveDnsFromL3Network)

管理员可以使用RemoveDnsFromL3Network从三层网络移除DNS。例如:
RemoveDnsFromL3Network l3NetworkUuid=3dbf30420a4b4da8bcd69f99df7fb631 dns=114.114.114.114

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
l3NetworkUuid 三层网络uuid 0.6
dns DNS地址 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 L3NetworkVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 L3NetworkVO 0.6
timeout

向三层网络添加DNS(AddDnsToL3Network)

管理员可以使用AddDnsToL3Network向三层网络添加DNS。例如:
AddDnsToL3Network l3NetworkUuid=3dbf30420a4b4da8bcd69f99df7fb631 dns=114.114.114.114

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
l3NetworkUuid 三层网络uuid 0.6
dns DNS地址 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 L3NetworkVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 L3NetworkVO 0.6
timeout

向三层网络添加主机路由(AddHostRouteToL3Network)

管理员可以使用AddHostRouteToL3Network向三层网络添加主机路由。例如:
AddHostRouteToL3Network l3NetworkUuid=7dfdf976ef1334fba5c3b475104011b2 nexthop=192.168.1.254 prefix=169.254.169.254/32

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
l3NetworkUuid 三层网络uuid 0.6
nexthop 2.3
prefix 2.3
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 L3NetworkVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 L3NetworkVO 0.6
timeout

从三层网络移除主机路由(RemoveHostRouteFromL3Network)

管理员可以使用RemoveHostRouteFromL3Network从三层网络移除主机路由。例如:
RemoveHostRouteFromL3Network l3NetworkUuid=7dfdf976ef1334fba5c3b475104011b2 prefix=169.254.169.254/32

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
l3NetworkUuid 三层网络uuid 0.6
prefix 2.3
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 L3NetworkVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 L3NetworkVO 0.6
timeout

获取空闲IP(GetFreeIp)

管理员可以使用GetFreeIp获取空闲IP。例如:
GetFreeIp l3NetworkUuid=aa6ec2f40b93413aa843ee5d76ddf73e

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
l3NetworkUuid 三层网络uuid,l3NetworkUuid和ipRangeUuid二选一 0.6
ipRangeUuid IP段uuid,l3NetworkUuid和ipRangeUuid二选一 0.6
start 起始值 0.6
ipRangeType 地址类型
  • Normal
  • AddressPool
3.9.0
ipVersion IP地址版本号
  • 4
  • 6
3.10.0
limit 数量限制 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 L3NetworkVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 L3NetworkVO 0.6
timeout

检查IP可用性(CheckIpAvailability)

管理员可以使用CheckIpAvailability检查IP可用性。例如:
CheckIpAvailability ip=10.128.11.3 l3NetworkUuid=aa6ec2f40b93413aa843ee5d76ddf73e

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
l3NetworkUuid 三层网络uuid 0.6
ip IP地址 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 L3NetworkVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 L3NetworkVO 0.6
timeout
arpCheck 使用arping检测 5.1.0
ipRangeCheck 在数据库可用地址段内检测 5.1.0

获取IP网络地址容量(GetIpAddressCapacity)

管理员可以使用GetIpAddressCapacity获取IP网络地址容量。例如:
GetIpAddressCapacity ipRangeUuids=e6d4de6fe69a42b28363ffbc7b4a186f

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
zoneUuids 区域uuid 0.6
l3NetworkUuids 三层网络uuid 0.6
ipRangeUuids IP地址范围uuid。 ipRangeUuids,L3NetworkUuids,zoneUuids 至少一个不是为空列表,或者全部不为空 0.6
all 系统全局 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 L3NetworkVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 L3NetworkVO 0.6
timeout

添加IP地址范围(AddIpRange)

管理员可以使用AddIpRange添加IP地址范围。例如:
AddIpRange name=L3Network-1 l3NetworkUuid=ba076991c0f740be84ab7e9646dcfd56
startIp=10.128.33.10 endIp=10.128.33.20 netmask=255.0.0.0 gateway=10.0.0.1

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
name 三层网络名称 0.6
description 三层网络详细描述 0.6
l3NetworkUuid 三层网络uuid 0.6
startIp 起始IP 0.6
endIp 结束IP 0.6
gateway 网关 0.6
ipRangeType 地址类型
  • Normal
  • AddressPool
3.9.0
netmask 子网掩码 0.6
resourceUuid 资源uuid。若指定,三层网络会使用该字段值作为uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 L3NetworkVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 L3NetworkVO 0.6
timeout
Note:
  • ZStack Cloud添加IP地址范围时支持添加IP地址段的时候指定DHCP server地址功能,SystemTags增加DhcpServer选项。
    • 选项格式为:flatNetwork::DhcpServer::{%s}::ipUuid::{%s}
    • 例如:flatNetwork::DhcpServer::192.168.1.100::ipUuid::null

删除IP地址范围(DeleteIpRange)

管理员可以使用DeleteIpRange删除IP地址范围。例如:
DeleteIpRange uuid=32556158a15b421db215d1d4b0e846a6

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid IP地址范围的UUID 0.6
deleteMode 请参见 删除资源(Delete Resources)
  • Permissive
  • Enforcing
0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 L3NetworkVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 L3NetworkVO 0.6
timeout

查询IP地址范围(QueryIpRange)

管理员可以使用QueryIpRange查询IP地址范围。例如:
QueryIpRange uuid=bcdb86a63cef415c843ab02e9534a21b
QueryIpRange l3Network.l2NetworkUuid=96a3915e8c1a4fb6a7e14078e61b69b0

原生域查询(Primitive Fields of Query)

请参见IP Range inventory

嵌套和扩展域查询(Nested and Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
l3Network L3 network inventory 这个IP地址范围所属的L3网络 0.6

更新IP地址范围(UpdateIpRange)

管理员可以使用UpdateIpRange更新IP地址范围。例如:
UpdateIpRange uuid=b121aa49504749c39e541c434dff7303

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 三层网络uuid 0.6
name 三层网络名称 0.6
description 三层网络的详细描述 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 L3NetworkVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 L3NetworkVO 0.6
timeout

通过网络CIDR添加IP地址范围(AddIpRangeByNetworkCidr)

管理员可以使用AddIpRangeByNetworkCidr通过网络CIDR添加IP地址范围。例如:
AddIpRangeByNetworkCidr name=L3Network-1 l3NetworkUuid=ba076991c0f740be84ab7e9646dcfd56 \
networkCidr=10.128.33.1/24

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
name 三层网络名称 0.6
description 三层网络的详细描述 0.6
l3NetworkUuid 三层网络uuid 0.6
networkCidr 网络CIDR 0.6
gateway 网关 3.7.0
ipRangeType 地址类型
  • Normal
  • AddressPool
3.9.0
resourceUuid 资源uuid。若指定,三层网络会使用该字段值作为uuid 0.6
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 L3NetworkVO 0.6
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 L3NetworkVO 0.6
timeout
Note:
  • ZStack Cloud通过网络CIDR添加IP地址范围时支持添加IP地址段的时候指定DHCP server地址功能,SystemTags增加affinityGroup选项。
    • 选项格式为:flatNetwork::DhcpServer::{%s}::ipUuid::{%s}
    • 例如:flatNetwork::DhcpServer::192.168.1.100::ipUuid::null

获取三层网络Mtu值(GetL3NetworkMtu)

管理员可以使用GetL3NetworkMtu获取三层网络Mtu值。例如:
GetL3NetworkMtu l3NetworkUuid=87ce2c1d551f4fadb2f364d18af465a1

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
l3NetworkUuid 三层网络uuid 2.1
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 L3NetworkVO 2.1
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 L3NetworkVO 2.1
timeout

设置三层网络Mtu值(SetL3NetworkMtu)

管理员可以使用SetL3NetworkMtu设置三层网络Mtu值。例如:
SetL3NetworkMtu l3NetworkUuid=87ce2c1d551f4fadb2f364d18af465a1 mtu=1500

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
l3NetworkUuid 三层网络uuid 2.1
mtu 2.1
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 L3NetworkVO 2.1
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 L3NetworkVO 2.1
timeout

获取三层网络上路由器的接口地址(GetL3NetworkRouterInterfaceIp)

管理员可以使用GetL3NetworkRouterInterfaceIp获取三层网络上路由器的接口地址。例如:
GetL3NetworkRouterInterfaceIp l3NetworkUuid=87ce2c1d551f4fadb2f364d18af465a1

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
l3NetworkUuid 三层网络uuid 2.1
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 L3NetworkVO 2.1
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 L3NetworkVO 2.1
timeout

设置三层网络路由器接口IP(SetL3NetworkRouterInterfaceIp)

管理员可以使用SetL3NetworkRouterInterfaceIp设置三层网络路由器接口IP。例如:
SetL3NetworkRouterInterfaceIp l3NetworkUuid=87ce2c1d551f4fadb2f364d18af465a1 routerInterfaceIp=192.168.180.1

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
l3NetworkUuid 三层网络uuid 2.1
routerInterfaceIp 2.1
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 L3NetworkVO 2.1
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 L3NetworkVO 2.1
timeout

添加IPv6地址范围(AddIpv6Range)

用户可以使用AddIpv6Range添加IPv6地址范围。 例如:
AddIpv6Range l3NetworkUuid=8bea912e333a440fb61d81c0c7670b52 name=L3-ipv6 startIp=234e:0:4567::2 endIp=234e:0:4567:0:ffff:ffff:ffff:ffff gateway=234e:0:4567::1 prefixLen=64 addressMode=Stateful-DHCP

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
l3NetworkUuid 三层网络UUID 3.1.0
name 三层网络的名称 3.1.0
description 三层网络的详细描述 3.1.0
startIp 起始地址 3.1.0
endIp 结束地址 3.1.0
gateway 网关 3.1.0
prefixLen 前缀长度 3.1.0
addressMode IPv6地址分配模式
  • SLAAC
  • Stateful-DHCP
  • Stateless-DHCP
3.1.0
resourceUuid 资源UUID。若指定,三层网络会使用该字段值作为UUID 3.1.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.1.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.1.0
timeout
Note:
  • ZStack Cloud添加IPv6地址范围时支持指定DHCP server地址功能,SystemTags增加affinityGroup选项。
    • 选项格式为:flatNetwork::DhcpServer::{%s}::ipUuid::{%s}
    • 例如:flatNetwork::DhcpServer::192.168.1.100::ipUuid::null

通过网络CIDR添加IPv6地址范围(AddIpv6RangeByNetworkCidr)

用户可以使用AddIpv6RangeByNetworkCidr通过网络CIDR添加IPv6地址范围。 例如:
AddIpv6RangeByNetworkCidr l3NetworkUuid=8bea912e333a440fb61d81c0c7670b52 name=L3-ipv6 networkCidr=234e:0:4567::/64 addressMode=Stateful-DHCP

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
name 三层网络的名称 3.1.0
description 三层网络的详细描述 3.1.0
l3NetworkUuid 三层网络UUID 3.1.0
networkCidr 网络CIDR 3.1.0
addressMode IPv6地址分配模式
  • SLAAC
  • Stateful-DHCP
  • Stateless-DHCP
3.1.0
resourceUuid 资源UUID。若指定,三层网络会使用该字段值作为UUID 3.1.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.1.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.1.0
timeout
Note:
  • ZStack Cloud通过网络CIDR添加IPv6地址范围时支持指定DHCP server地址功能,SystemTags增加affinityGroup选项。
    • 选项格式为:flatNetwork::DhcpServer::{%s}::ipUuid::{%s}
    • 例如:flatNetwork::DhcpServer::192.168.1.100::ipUuid::null

查询IP地址(QueryIpAddress)

管理员可以使用QueryIpAddress查询IP地址。例如:
QueryIpAddress uuid=c0af96be01703fab84495059d3188230

原生域查询(Primitive Fields of Query)

请参见IpAddress inventory。

嵌套和扩展域查询(Nested And Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
l3Network L3 network inventory 这个IP地址范围所属的L3网络 3.1.0
vmNic vmNic inventory 0.6

获取三层网络IP地址使用情况统计(GetL3NetworkIpStatistic)

用户可以使用GetL3NetworkIpStatistic获取三层网络IP地址使用情况统计。 例如:
GetL3NetworkIpStatistic l3NetworkUuid=9bdd769f3e603f65bd368512ebe8b998

参数(Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
l3NetworkUuid 三层网络UUID 3.7.0
resourceType 统计资源类型
  • All
  • Vip
  • VM
3.7.0
ip 指定IP地址 3.7.0
sortBy 排序方式
  • Ip
  • CreateDate
3.7.0
sortDirection 排序方向
  • asc
  • desc
3.7.0
start 统计结果起始位置 3.7.0
limit 统计结果数量 3.7.0
replyWithCount 同时返回统计结果总数 3.7.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag) 3.7.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag) 3.7.0
timeout

查询IP地址池(QueryAddressPool)

管理员可以使用QueryAddressPool查询IP地址池。例如:
QueryAddressPool uuid=b86c9016b4f24953a9edefb53ca0678c

原生域查询(Primitive Fields of Query)

请参见 地址池清单(AddressPool Inventory)

嵌套和扩展域查询(Nested And Expanded Fields of Query)

域(Field) 清单(Inventory) 描述 起始支持版本
l3Network L3 network inventory 地址池相关公有网络 3.9.0

添加保留地址段(AddReservedIpRange)

管理员可以使用AddReservedIpRange添加保留地址段。例如:
AddReservedIpRange l3NetworkUuid=b7b719a4a3c140ed80fd680b71f66bb8 startIp=172.20.60.115 endIp=172.20.60.120

参数 (Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
l3NetworkUuid 三层网络uuid 5.1.0
startIp 起始IP 5.1.0
endIp 结束IP 5.1.0
resourceUuid 资源uuid。若指定,三层网络会使用该字段值作为uuid 5.1.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 L3NetworkVO 5.1.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 L3NetworkVO 5.1.0

删除保留地址段(DeleteReservedIpRange)

管理员可以使用DeleteReservedIpRange删除保留地址段。例如:
DeleteReservedIpRange uuid=cb2e0481b17f471b9fdcfab697abc7ce

参数 (Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
uuid 保留地址范围的UUID 5.1.0
deleteMode 请参见 删除资源(Delete Resources)
  • Permissive/Enforcing
  • Permissive
5.1.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 L3NetworkVO 5.1.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 L3NetworkVO 5.1.0
timeout

修改DHCP服务器地址(ChangeL3NetworkDhcpIpAddress)

管理员可以使用ChangeL3NetworkDhcpIpAddress修改DHCP服务器地址。例如:
ChangeL3NetworkDhcpIpAddress l3NetworkUuid=b7b719a4a3c140ed80fd680b71f66bb8 dhcpServerIp=172.20.60.115

参数 (Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
l3NetworkUuid 三层网络uuid 5.1.0
dhcpServerIp DHCP v4 服务器地址 5.1.0
dhcpv6ServerIp DHCP v6 服务器地址 5.1.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 L3NetworkVO 5.1.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 L3NetworkVO 5.1.0
timeout

删除IP地址(DeleteIpAddress)

管理员可以使用DeleteIpAddress删除IP地址。例如:
DeleteIpAddress l3NetworkUuid=b6e5c225bf553bc8bd5a5fcf3fac9fa3 deleteMode=Permissive

参数 (Parameters)

名字 描述 可选的 可选的参数值 起始支持版本
l3NetworkUuid 三层网络uuid 5.1.0
usedIpUuids 被删除地址Uuid 5.1.0
deleteMode 请参见 删除资源(Delete Resources)
  • Permissive/Enforcing
  • Permissive
5.1.0
systemTags 系统标签,请参见 创建系统标签(CreateSystemTag); 资源类型是 L3NetworkVO 5.1.0
userTags 用户标签,请参见 创建用户标签(CreateUserTag);资源类型是 L3NetworkVO 5.1.0
timeout

标签(Tags)

L3网络标签(L3 Network Tags)

用户可以使用resourceType=L3NetworkVO在L3网络上创建用户标签。 例如:
CreateUserTag resourceType=L3NetworkVO tag=web-tier-l3 \
resourceUuid=f6be73fa384a419986fc6d1b92f95be9

IP地址范围标签(IP Range Tags)

用户可以使用resourceType=IpRangeVO在IP地址范围上创建用户标签。例如:
CreateUserTag resourceType=IpRangeVO tag=web-tier-IP \
resourceUuid=8191d946954940428b7d003166fa641e

IP地址标签(IP Address Tags)

用户可以使用resourceType=IpAddressVO在IP地址上创建用户标签。例如:
CreateUserTag resourceType=IpAddressVO tag=web-tier-IPAddress \
resourceUuid=c0af96be01703fab84495059d3188230
CLI命令使用手册 | 5.5.30 | ZStack Cloud · ZCF | ZStack 资源中心