DocsKnowledge BaseAPI Explorer
Documentation›ZCF›ZStack Cloud›Explore more›CLI Command ManualZCF
Document navigation

VIP

CreateVip

Creates a VIP. For example,
CreateVip name=vip1 l3NetworkUuid=a3b2fce8f82b4422a575220a35d6ebbd

Parameters

Name Description Optional Valid Value Starting Version
name The VIP name. 0.6
description The detailed description of the VIP. Yes 0.6
l3NetworkUuid The UUID of the L3 network that uses the VIP service. 0.6
ipRangeUuid The IP range UUID. 3.9.0
allocatorStrategy The allocator strategy. Yes
  • DefaultHostAllocatorStrategy
  • LastHostPreferredAllocatorStrategy
  • LeastVmPreferredHostAllocatorStrategy
  • MinimumCPUUsageHostAllocatorStrategy
  • MinimumMemoryUsageHostAllocatorStrategy
  • MaxInstancePerHostHostAllocatorStrategy
  • DesignatedHostAllocatorStrategy
 0.6
requiredIp The required IP address. Yes 0.6
resourceUuid The resource UUID. Yes 0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is VipVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is VipVO. Yes 0.6
timeout Yes

DeleteVip

Deletes a VIP. For example,
DeleteVip uuid=a9cca051d90348a7b7acdabba96865e9

Parameters

Name Description Optional Valid Value Starting Version
uuid The VIP UUID. 0.6
deleteMode The delete mode. For more information, see Delete Resources. Yes
  • Permissive
  • Enforcing
 0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is VipVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is VipVO. Yes 0.6
timeout Yes

QueryVip

Queries a VIP. For example,
QueryVip l3NetworkUuid=a3b2fce8f82b4422a575220a35d6ebbd
QueryVip l3Network.uuid=a3b2fce8f82b4422a575220a35d6ebbd

Primitive Fields of Query

See VIP Inventory.

Nested and Expanded Fields of Query

Field Inventory Description Starting Version
l3Network L3 Network Inventory 0.6
eip EIP Address Inventory 0.6
loadBalancer Load Balancer Inventory 0.6
peerL3Network L3 Network Inventory 0.6
portForwarding Port Forwarding Inventory 0.6

CheckVipPortAvailability

Checks the VIP port availability, for example, 
CheckVipPortAvailability vipUuid=e6ac71f8cf433c51822bedea67cf4781 protocolType=TCP port=5

Parameters

Name Description Optional Valid Values Starting Version
vipUuid The VIP UUID. 4.7.21
protocolType The protocol type. 4.7.21
port The port to be checked. 4.7.21
timeout 是

GetVipAvailablePort

Gets the available ports of a VIP, for example, 
GetVipAvailablePort vipUuid=e6ac71f8cf433c51822bedea67cf4781 protocolType=TCP

Parameters

Name Description Optional Valid Values Starting Version
vipUuid The VIP UUID. 4.7.21
protocolType The protocol type. 4.7.21
start The query start point. 是
limit The query limit. 是
timeout 是

UpdateVip

Updates a VIP. For example,
UpdateVip uuid=bc6277e31a904c46a506e8031b1cef65

Parameters

Name Description Optional Valid Value Starting Version
uuid The VIP UUID. 0.6
name The VIP name. Yes 0.6
description The detailed description of the VIP. Yes 0.6
userTags The user tags. For more information, see CreateUserTag. The resourceUuid type is VipVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is VipVO. Yes 0.6
timeout Yes

ChangeVipState

Changes the state of a VIP. For example,
ChangeVipState uuid=bc6277e31a904c46a506e8031b1cef65 stateEvent=disable

Parameters

Name Description Optional Valid Value Starting Version
uuid The VIP UUID. 0.6
stateEvent The state event.
  • Enable
  • Disable
 0.6
userTags The user tags. For more information, see CreateUserTag. The resource type is VipVO. Yes 0.6
systemTags The system tags. For more information, see CreateSystemTag. The resource type is VipVO. Yes 0.6
timeout Yes

GetVipUsedPorts

Obtains all of the business ports of a VIP.
GetVipUsedPorts protocol=TCP uuid=8bf4d57854ec42dbbdcc5b1424a243d9

Parameters

Name Description Optional Valid Value Starting Version
uuid The VIP UUID. 2.2
protocol The network protocol.
  • TCP
  • UDP
 2.2
userTags The user tags. For more information, see CreateUserTag. The resource type is VipVO. Yes 2.2
systemTags The system tags. For more information, see CreateSystemTag. The resource type is VipVO. Yes 2.2
timeout Yes

SetVipQos

Sets a VIP QoS. For example,
SetVipQos uuid=0ba6619eaede41d1ab506e33f6125b34  \
outboundBandwidth=1048576 inboundBandwidth=1048576

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 2.3
port The port. Yes 2.3
outboundBandwidth The outbound bandwidth. Yes 2.3
inboundBandwidth The inbound bandwidth. Make sure that either inboundbandwidth, or outboundbandwidth is not null. Yes 2.3
userTags The user tags. For more information, see CreateUserTag. The resource type is VipVO. Yes 2.3
systemTags The system tags. For more information, see CreateSystemTag. The resource type is VipVO. Yes 2.3
timeout Yes

GetVipQos

Obtains a VIP QoS. For example,
GetVipQos uuid=5ffea72b469549a1bcb2ce0788cccb26

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 2.3
userTags The user tags. For more information, see CreateUserTag. The resource type is VipVO. Yes 2.3
systemTags The system tags. For more information, see CreateSystemTag. The resource type is VipVO. Yes 2.3
timeout Yes

DeleteVipQos

Deletes a VIP QoS. For example,
DeleteVipQos uuid=1dbb011e3fc24dba8831cc7d7cc702ce port=80

Parameters

Name Description Optional Valid Value Starting Version
uuid The resource UUID. 2.3
port The port. Yes 2.3
userTags The user tags. For more information, see CreateUserTag.The resource type is VipVO. Yes 2.3
systemTags The system tags. For more information, see CreateSystemTag. The resource type is VipVO. Yes 2.3
timeout Yes
Note:
  • If you configured a port for the VIP QoS rule, you could delete the VIP QoS by using the following format:
    DeleteVipQos uuid=xx port=xx
PreviousSecurity GroupNextEIP
CLI Command Manual | 4.8.38 | ZStack Cloud · ZCF | ZStack Resource Center