SIOS TECHNOLOGY CORP.

Managing IP Address Resources from the Command Line (LKCLI)

IP Address resources provide failover protection for network connectivity between cluster nodes. When configured as a virtual IP address resource, LifeKeeper transfers the same virtual IP address to the backup server during failover, automatically redirecting client traffic to the new active server. When configured as a real IP address resource, LifeKeeper protects the server-specific IP address assigned to each node. In this configuration, the IP address used by clients changes after failover, and the resource is typically used in conjunction with a DNS or Route 53 resource to redirect client connections to the active server.

Resource Type: comm/ip
Aliases: ip

Subcommands

IP Address resources are managed by commands of the form:

lkcli resource comm/ip <subcommand> [flags]

Subcommand Description Required Role
create Create a new IP Address resource on the target server admin
extend Extend an existing IP Address resource to a standby server admin
get-property Read the value of a resource property guest
set-property Update the value of an editable resource property admin

create

lkcli resource comm/ip create --ip-type=<virtual_ip|real_ip> --ip-address=<string> [flags]

Flag Short Type Required Default Constraints Description
--ip-address — string Yes — — IP address to protect
--ip-type — enum Yes — real_ip, virtual_ip IP address type
--interface — string Conditional — — Network interface; required when --ip-type=virtual_ip
--netmask — string Conditional — — Network mask; required when --ip-type=virtual_ip
--tag — string No Auto-generated — Resource tag name
--switchback — enum No INTELLIGENT INTELLIGENT, AUTOMATIC Switchback type
--local-recovery — enum No enabled enabled, disabled Enable local recovery
--quickcheck-interval — int No 180 min: 0, max: 604800 Quickcheck interval in seconds
--deepcheck-interval — int No 300 min: 0, max: 604800 Deepcheck interval in seconds

extend

lkcli resource comm/ip extend --primary-sys=<string> --primary-tag=<string> --standby-sys=<string> [flags]

Flag Short Type Required Default Constraints Description
--primary-sys — string Yes — — Hostname of the server the existing resource is being 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 server to extend the resource to
--interface — string Conditional — — Network interface on standby server; required when extending a virtual_ip resource
--ip-address — string Conditional — — IP address on standby server; required when extending a real_ip resource
--netmask — string No Matches primary — Network mask on standby server
--restore-mode — enum No enabled enabled, disabled Controls IP activation on in-service
--switchback — enum No INTELLIGENT INTELLIGENT, AUTOMATIC Switchback type
--local-recovery — enum No enabled enabled, disabled Enable local recovery
--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/ip get-property --tag=<string> --property=<string>
lkcli resource comm/ip 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
ip-address string — No The protected IP address
ip-type enum real_ip, virtual_ip No IP address type
interface string — No Network interface for the IP address
netmask string — No Network mask for the IP address
kit-name string — No Recovery kit name
restore-mode enum enabled, disabled Yes Controls whether the IP is activated when the resource comes in-service locally. Set to disabled for WAN configurations where servers are on different subnets.
switchback enum INTELLIGENT, AUTOMATIC Yes Switchback type
quickcheck-interval int min: 0, max: 604800 Yes Quickcheck interval in seconds (default: 180)
deepcheck-interval int min: 0, max: 604800 Yes Deepcheck interval in seconds (default: 300)

Example Usage

# Create a virtual IP resource on server1
lkcli resource comm/ip create \
  --host=server1 \
  --ip-type=virtual_ip \
  --ip-address=192.168.1.100 \
  --netmask=255.255.255.0 \
  --interface="Ethernet 2" \
  --tag=ip-192.168.1.100

# Extend the resource to server2 (the request is sent to the standby server)
lkcli resource comm/ip extend \
  --primary-sys=server1 \
  --primary-tag=ip-192.168.1.100 \
  --standby-sys=server2 \
  --interface="Ethernet 2"

# Protect a statically assigned IP address (using the 'ip' alias)
  lkcli resource ip create \
    --ip-type=real_ip \
    --ip-address=10.0.10.1 \
    --tag=realip.0

# Extend a real IP resource to standby server
  lkcli resource ip extend \
    --primary-sys=server1 \
    --primary-tag=realip.0 \
    --standby-sys=server2 \
    --ip-address=10.0.10.2

# Get the current switchback setting
lkcli resource comm/ip get-property \
  --host=server1 \
  --tag=ip-192.168.1.100 \
  --property=switchback

# Change switchback to AUTOMATIC
lkcli resource comm/ip set-property \
  --host=server1 \
  --tag=ip-192.168.1.100 \
  --property=switchback \
  --value=AUTOMATIC

Feedback

Was this helpful?

Yes No
You indicated this topic was not helpful to you ...
Could you please leave a comment telling us why? Thank you!
Thanks for your feedback.

Post your comment on this topic.

Post Comment