EIP

CreateEip

Creates an EIP. For example,

CreateEip name=eip1 vipUuid=3d782603854549398859e62e918f6757

Name	Description	Optional	Starting Version
name	The EIP name.		0.6
description	The detailed description of the EIP.	Yes	0.6
vipUuid	The VIP UUID.		0.6
vmNicUuid	The VM NIC UUID.	Yes	0.6
resourceUuid	The resource UUID.	Yes	0.6
userTags	The user tags. For more information, see CreateUserTag. The resource type is EipVO.	Yes	0.6
systemTags	The system tags. For more information, see CreateSystemTag. The resource type is EipVO.	Yes	0.6
timeout		Yes

Deletes an EIP. For example,

DeleteEip uuid=65b402f0f03443239cb5014e6859cd38

Name	Description	Optional	Valid Value	Starting Version
uuid	The EIP 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 EipVO.	Yes		0.6
systemTags	The system tags. For more information, see CreateSystemTag. The resource type is EipVO.	Yes		0.6
timeout		Yes

Queries an EIP. For example,

QueryEip uuid=83b6bba232a44038bd13f5ced9693f92

QueryEip vip.uuid=3d782603854549398859e62e918f6757

Field	Inventory	Description	Starting Version
vmNic	VM NIC Inventory		0.6
vip	VIP Inventory		0.6

Updates an EIP. For example,

UpdateEip uuid=83b6bba232a44038bd13f5ced9693f92

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

Changes the state of an EIP. For example,

ChangeEipState uuid=83b6bba232a44038bd13f5ced9693f92 stateEvent=enable

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

Obtains the VM NICs to which a specified EIP can be attached. For example,

GetEipAttachableVmNics eipUuid=83b6bba232a44038bd13f5ced9693f92

Name	Description	Optional	Starting Version
eipUuid	The EIP UUID.	Yes	0.6
vipUuid	The VIP UUID. Make sure that either eipUuid or vipUuid is not null.	Yes	0.6
userTags	The user tags. For more information, see CreateUserTag. The resource type is EipVO.	Yes	0.6
systemTags	The system tags. For more information, see CreateSystemTag. The resource type is EipVO.	Yes	0.6
timeout		Yes

Queries EIPs that can be attached to a VM NIC. For example,

GetVmNicAttachableEips vmNicUuid=83b6bba232a44038bd13f5ced9693f92

Name	Description	Optional	Starting Version
vmNicUuid	The VM NIC UUID.		4.4.6
ipVersion	The IP version.	Yes	4.4.6
limit	The limit of the returned results.	Yes	4.4.6
start	The start position of the query.	Yes	4.4.6
userTags	The user tags. For more information, see CreateUserTag. The resource type is EipVO.	Yes	4.4.6
systemTags	The system tags. For more information, see CreateSystemTag. The resource type is EipVO.	Yes	4.4.6
timeout		Yes

Attaches an EIP. For example,

AttachEip eipUuid=83b6bba232a44038bd13f5ced9693f92 vmNicUuid=3e6a4cc2eb0941edbac7af24e2ff932f

Name	Description	Optional	Starting Version
eipUuid	The EIP UUID.		0.6
vmNicUuid	The VM NIC UUID.		0.6
userTags	The user tags. For more information, see CreateUserTag. The resource type is EipVO.	Yes	0.6
systemTags	The system tags. For more information, see CreateSystemTag. The resource type is EipVO.	Yes	0.6
timeout		Yes

Detaches an EIP. For example,

DetachEip uuid=83b6bba232a44038bd13f5ced9693f9

Name	Description	Optional	Starting Version
uuid	The EIP UUID.		0.6
userTags	The user tags. For more information, see CreateUserTag. The resource type is EipVO.	Yes	0.6
systemTags	The system tags. For more information, see CreateSystemTag. The resource type is EipVO.	Yes	0.6
timeout		Yes