OCI Virtual IP resources provide failover protection in Oracle Cloud Infrastructure (OCI) environments by reassigning a private virtual IP address to the new active node’s VNIC during failover.
Resource Type: comm/ocivip
Aliases: ocivip
Subcommands
OCI Virtual IP resources are managed by commands of the form:
lkcli resource comm/ocivip <subcommand> [flags]
| Subcommand | Description | Required Role |
|---|---|---|
create
|
Create a new OCI Virtual IP resource | admin |
extend
|
Extend to a standby server | admin |
get-property
|
Read a resource property | guest |
set-property
|
Update an editable resource property | admin |
create
lkcli resource comm/ocivip create --interface=<string> --ip-address=<string> [flags]
| Flag | Short | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|---|
--interface
|
— | string | Yes | — | — | Network interface to assign the virtual IP to |
--ip-address
|
— | string | Yes | — | — | Virtual IP address to protect |
--verify-environment
|
— | bool | No | true
|
— | Verify OCI environment prerequisites during creation |
--tag
|
— | string | No | Auto-generated | — | Resource tag name |
--switchback
|
— | enum | No | INTELLIGENT
|
INTELLIGENT, AUTOMATIC
|
Switchback type |
extend
lkcli resource comm/ocivip extend \
--interface=<string> --primary-sys=<string> --primary-tag=<string> [flags]| Flag | Short | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|---|
--interface
|
— | string | Yes | — | — | Network interface on the standby server |
--primary-sys
|
— | string | Yes | — | — | Hostname of the server the existing resource is extended from |
--primary-tag
|
— | string | Yes | — | — | Tag of the existing resource to extend |
--standby-sys
|
— | string | No | Value of --host (defaults to localhost)
|
— | Hostname of the standby server |
--switchback
|
— | enum | No | INTELLIGENT
|
INTELLIGENT, AUTOMATIC
|
Switchback type |
--primary-priority
|
— | int | No | Defaults to the current priority of the --primary-sys server, or 1 if the resource has not yet been extended
|
min: 1, max: 999 | Failover priority for the primary server |
--standby-priority
|
— | int | No | Defaults to an unused value which is computed dynamically based on the priority values currently in-use | min: 1, max: 999 | Failover priority for the standby server |
get-property / set-property
lkcli resource comm/ocivip get-property --tag=<string> --property=<string>
lkcli resource comm/ocivip set-property --tag=<string> --property=<string> --value=<string>| Flag | Short | Type | Required | Description |
|---|---|---|---|---|
--tag
|
-t
|
string | Yes | Resource tag name |
--property
|
-p
|
string | Yes | Property name (see Properties table below) |
--value
|
-v
|
string | Yes (set-property only)
|
New property value |
Properties
| Property | Type | Constraints | Editable | Description |
|---|---|---|---|---|
interface
|
string | — | No | Network interface name |
ip-address
|
string | — | No | The protected IP address |
vnic-id
|
string | — | No | OCI VNIC identifier |
kit-name
|
string | — | No | Recovery kit name |
quickcheck-interval
|
int | min: 0, max: 604800 | Yes | Quickcheck interval in seconds (default: 180) |
local-recovery
|
enum | enabled, disabled
|
Yes | Enable or disable local recovery |
switchback
|
enum | INTELLIGENT, AUTOMATIC
|
Yes | Switchback type |
Example Usage
# Create an OCI Virtual IP resource
lkcli resource comm/ocivip create \
--host=server1 \
--interface=ens3 \
--ip-address=10.0.1.50 \
--tag=ocivip-10.0.1.50
# Extend to server2
lkcli resource comm/ocivip extend \
--primary-sys=server1 \
--primary-tag=ocivip-10.0.1.50 \
--standby-sys=server2 \
--interface=ens3
Post your comment on this topic.