Defines a vIP and lists the available operations for managing it.
A virtual IP (vIP) address is a statically configured IP address that is owned by a user.
The APIs and CLI provide operations for:
Use either the cloud infrastructure API actions or the cloud infrastructure CLI command to perform these operations.
Describes a virtual IP address and its lifecycle.
When creating a vServer, a cloud user assigns an allocated vIP address to the vServer. A vIP address can be allocated from a public network or private vNet. The allocated vIP address is bound to an account.
A vServer's vIP address remains bound to the vServer even when the vServer is stopped. vIP addresses are not disassociated until the vServer is deleted.
List the API action and CLI command for allocating a virtual IP address.
A cloud user allocates a vIP address from a public network or a private vNet.
| Cloud Infrastructure API Action | Cloud Infrastructure CLI Command |
|---|---|
Example 3-17 Allocating a vIP address using the Cloud Infrastructure API
https://<EnterpriseControllerHostname>/iaas/?Action=AllocateIpAddresses&AccessKeyId=AK_32&vnet=VNET-6ea466f5-6e6b-4159-adf3-8867473d4cf4&Version=1&Timestamp=1320342206808&Expires=1320342506808&SignatureMethod=SHA512withRSA&SignatureVersion=1&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST
Example 3-18 Allocating a vIP address using the Cloud Infrastructure CLI
iaas-allocate-ip-addresses --base-url https://<EnterpriseControllerHostname>/ -a ak.file --vnet VNET-9634972a-bcdd-4714-8c7f-b67d8010f13c
Lists the API action and CLI command for displaying vIP addresses.
A cloud user can get information about allocated vIP addresses and their assigned vServers. To view unallocated IP addresses associated with vServers, use the actions described in "Viewing vServer Information".
The cloud user can restrict the vIP addresses included in the result by specifying filters. The result includes the following details for each vIP address:
IP address
vNet ID
vServer ID
| Cloud Infrastructure API Action | Cloud Infrastructure CLI Command |
|---|---|
Example 3-19 Viewing vIP addresses using the Cloud Infrastructure API
https://<EnterpriseControllerHostname>/iaas/?Action=DescribeIpAddresses&AccessKeyId=AK_32&Version=1&Timestamp=1320339663115&Expires=1320339963115&SignatureMethod=SHA512withRSA&SignatureVersion=1&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST
Example 3-20 Viewing vIP addresses using the Cloud Infrastructure CLI
iaas-describe-ip-addresses --base-url https://<EnterpriseControllerHostname>/ -a ak.file
Lists the API action and CLI command for releasing an allocated virtual IP address.
A cloud user can release an allocated vIP address if the vIP address is not associated with a vServer.
| Cloud Infrastructure API Action | Cloud Infrastructure CLI Command |
|---|---|
Example 3-21 Deallocating a vIP address using the Cloud Infrastructure API
https://<EnterpriseControllerHostname>/iaas/?Action=ReleaseIpAddresses&AccessKeyId=AK_32&ipAddresses.2=192.0.2.10&ipAddresses.1=192.0.2.13&vnet=VNET-6ea466f5-6e6b-4159-adf3-8867473d4cf4&Version=1&Timestamp=1320341801846&Expires=1320342101846&SignatureMethod=SHA512withRSA&SignatureVersion=1&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST
Example 3-22 Deallocating a vIP address using the Cloud Infrastructure CLI
iaas-release-ip-addresses --base-url https://<EnterpriseControllerHostname>/ -a ak.file --vnet VNET-9634972a-bcdd-4714-8c7f-b67d8010f13c --ip-addresses 192.0.2.1
Lists the API action and CLI command for restricting a virtual IP address.
A cloud user can restrict an allocated vIP address so that it cannot be used for a vServer. The --owner parameter adds a string to the status to identify the cloud user or the purpose of the restriction.
| Cloud Infrastructure API Action | Cloud Infrastructure CLI Command |
|---|---|
Example 3-23 Blacklisting a vIP address using the Cloud Infrastructure API
https://<EnterpriseControllerHostname>/iaas/?Action=BlacklistIpAddresses&AccessKeyId=AK_32&ipAddresses.2=192.0.2.10&ipAddresses.1=192.0.2.13&vnet=VNET-6ea466f5-6e6b-4159-adf3-8867473d4cf4&Version=1&Timestamp=1320341801846&Expires=1320342101846&SignatureMethod=SHA512withRSA&SignatureVersion=1&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST
Example 3-24 Blacklisting a vIP address using the Cloud Infrastructure CLI
iaas-blacklist-ip-addresses --base-url https://<EnterpriseControllerHostname>/ -a ak.file --vnet VNET-9634972a-bcdd-4714-8c7f-b67d8010f13c --ip-addresses 192.0.2.1 --owner test
Lists the API action and CLI command for displaying restricted virtual IP addresses.
A cloud user can list all blacklisted vIP addresses or addresses that match the owner.
| Cloud Infrastructure API Action | Cloud Infrastructure CLI Command |
|---|---|
Example 3-25 Displaying a Blacklisted vIP addresses using the Cloud Infrastructure API
https://<EnterpriseControllerHostname>/iaas/?Action=DescribeBlacklistedIpAddresses&AccessKeyId=AK_32&ipAddresses.2=192.0.2.10&ipAddresses.1=192.0.2.13&vnet=VNET-6ea466f5-6e6b-4159-adf3-8867473d4cf4&Version=1&Timestamp=1320341801846&Expires=1320342101846&SignatureMethod=SHA512withRSA&SignatureVersion=1&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST
Example 3-26 Displaying Blacklisted vIP addresses using the Cloud Infrastructure CLI
iaas-describe-blacklisted-ip-addresses --base-url https://<EnterpriseControllerHostname>/ -a ak.file --owner test
Lists the API action and CLI command for releasing a virtual IP address from the blacklist.
A cloud user clears a blacklisted vIP address so that the address can be used for a vServer.
| Cloud Infrastructure API Action | Cloud Infrastructure CLI Command |
|---|---|
Example 3-27 Clearing a Blacklisted vIP address using the Cloud Infrastructure API
https://<EnterpriseControllerHostname>/iaas/?Action=ClearBlacklistIpAddresses&AccessKeyId=AK_32&ipAddresses.2=192.0.2.10&ipAddresses.1=192.0.2.13&vnet=VNET-6ea466f5-6e6b-4159-adf3-8867473d4cf4&Version=1&Timestamp=1320341801846&Expires=1320342101846&SignatureMethod=SHA512withRSA&SignatureVersion=1&Signature=SIGNATURE_HAS_BEEN_REMOVED_FOR_THE_READABILITY_OF_THE_REQUEST
Example 3-28 Clearing a Blacklisted vIP address using the Cloud Infrastructure CLI
iaas-clear-blacklisted-ip-addresses --base-url https://<EnterpriseControllerHostname>/ -a ak.file --vnet VNET-9634972a-bcdd-4714-8c7f-b67d8010f13c --ip-addresses 192.0.2.1