ksysmgr command

Purpose

The ksysmgr command provides a consistent interface to configure the controller system (KSYS) and to perform VM Recovery Manager HA operations. This command can be run from a terminal or a script.

Syntax

The basic format of the ksysmgr command follows:
ksysmgr [flags] ACTION CLASS [NAME] [ATTRIBUTES...]

For example: ksysmgr -t -l max discover host_group Austin_hg verify=yes

Alias usage

Alias is a shorthand definition for an operation and is defined by the most significant letters. The asterisk (*) in the aliases signify wildcard characters. For example, the alias value for the modify ACTION is mod*. If you type modd, the command still works. Aliases are provided for convenience from the command line and must not be used in scripts.

Log file

All ksysmgr command operations are logged in the /var/ksys/log/ksysmgr.oplog file, which includes the name of the command that was executed, start time, process ID for the ksysmgr operation, the command with arguments, and the overall return code. In addition, the /var/ksys/log/ksysmgr.log file tracks the internal activities of the ksysmgr command. The amount of information that is written to the ksysmgr.log file can be modified for each command by using the -l flag.

Notes:
  • You must have root authority to run the ksysmgr command.
  • Help information is available for the ksysmgr command from the command line. For example, when you run the ksysmgr command without any flags or parameters, a list of the available ACTIONs is displayed. If you enter ksysmgr ACTION in the command line without specifying any CLASS, the command results in a list of all the available CLASSes for the specified ACTION. Entering ksysmgr ACTION CLASS without specifying any NAME or ATTRIBUTES parameters might yield different results because some ACTION and CLASS combinations do not require any additional parameters. To display help information in this scenario, you can view the help information by appending the -h flag to the ksysmgr ACTION CLASS command.
  • You cannot display help information from the command line for each ATTRIBUTE of the ksysmgr command.

Flags

You can use the following flags with the ksysmgr command:

ACTION
Describes the action to be performed. The ACTION flags are not case-sensitive. All ACTION flags provide a shorter alias. The following ACTION flags are available:
  • add (alias: ad*, cr*, make, mk)
  • cleanup (alias: clean*)
  • delete (alias: de*, remov*, rm, er*)
  • discover (alias: di*)
  • help (alias: hel*, ?)
  • lpm (alias: none)
  • manage (alias: man*, mg)
  • modify (alias: mod*, ch*, set)
  • query (alias: q*, ls, get, sh*)
  • recover (alias: rec*)
  • report (alias: rep*)
  • restart (alias: resta*)
  • restore (alias: resto*)
  • sync (alias: syn*, pr*)
  • unmanage (alias: unman*, umg)
  • verify (alias: ver*, validate)
  • start (alias: none)
  • stop (alias: none)
  • refresh (alias: ref*)
  • trace (alias: none)
  • reset (alias: none)
CLASS
Specifies the type of object on which the ACTION is performed. The CLASS flags are not case-sensitive. The following CLASS flags are supported:
  • anti_collocation (alias: anti*)
  • collocation (alias: collo*)
  • event (alias: ev*)
  • hmc (alias: hmcs, hmces)
  • host (alias: serv*, mach*, cec*)
  • host_group (alias: hg, host_g*)
  • ksyscluster (alias: clu*, ksyscl*)
  • notify (alias: rn, remote_not*, noti*)
  • script (alias: scr*)
  • snapshot (alias: snap*)
  • system (alias: sys*)
  • version (alias: vers*)
  • viodisk (alias: viod*)
  • vios (alias: vios*)
  • vm (alias: lp*, vm*)
  • workgroup (alias: workg*, work_g*, wg)
  • app_dependency (alias: app_dep*)
  • app (alias: application)
NAME
Specifies a particular object, of type CLASS, on which the ACTION must be performed. The NAME flags are case-sensitive.
ATTRIBUTE=VALUE
Specifies an optional flag that has attribute pairs and value pairs that are specific to the ACTION and CLASS combination. Use these pairs to specify configuration settings or to run particular operations. Both the ATTRIBUTE and VALUE flags are case-sensitive.
-a {<ATTR#1>,<ATTR#2>,...}
Displays only the specified attributes. This flag must be used with the query ACTION flag. For example: ksysmgr -a name,sitetype query site.
-f
Overrides any interactive prompts and forces the current operation to be run.
-h
Displays help information.
-l low|med|max
Activates the following trace logging values:
low
Logs basic information for every ksysmgr operation. This is the default value of the -l flag.
med
Logs warning messages also.
max
Performs high tracing operations such as adding the routine function and the utility function. It also adds a transaction ID to the entry messages of each function.
All trace data is written in the ksysmgr.log file. This flag is ideal for troubleshooting problems.
-v
Displays maximum verbosity in the output.
-i
Skips the interactive prompts from the ksysmgr command.

Comprehensive list of ksysmgr operations

Use the following information to find the syntax for all possible ksysmgr operations:

KSYS cluster configuration
  • To create a KSYS cluster:
    ksysmgr add ksyscluster name ksysnodes=ksysnode1[,ksysnode2,..] type=HA
  • To verify the KSYS cluster:
    ksysmgr verify ksyscluster name
  • To synchronize the KSYS cluster:
    ksysmgr sync ksyscluster name
  • To create, verify, and synchronize a KSYS cluster:
    ksysmgr add ksyscluster name ksysnodes=ksysnode1[,ksysnode2,...] type=HA sync=yes
  • To query a KSYS cluster:
    ksysmgr query ksyscluster [name]
  • To delete a KSYS cluster:
    ksysmgr delete ksyscluster name
    Note: When you delete the KSYS cluster, the virtual machine (VM) agent daemon becomes inoperative. In such cases, you must manually start the VM agent daemon.
  • To modify a KSYS cluster:
    ksysmgr modify ksyscluster name add|remove ksysnodes=ksysnode1[,ksysnode2,..]
    Note: You cannot remove a node that is designated as managing node.
start of change

VM start time

  • To change the start time of the VM, run the following:
    ksysmgr modify vm <vm_name> vm_start_time=<start_time>
    The default value of the attribute is 5 (in minutes). You can set the value between 1 and 60 (in minutes). You cannot set the value to 0 (in minute).
end of change
start of change

vPMEM override

  • To enable the vPMEM flag for overriding physical memory. For example:
    ksysmgr modify sys vpmem_override=enable
  • To disable the vPMEM flag for overriding physical memory. For example:
    ksysmgr modify sys vpmem_override=disable
Note: By default, the value of vPMEM variable is disabled.
Note: You can use the vPMEM override in HMC 1050 and the firmware P10, or later, versions.
end of change
start of change

KSYS spooling

  • To query a KSYS spooling:
    ksysmgr q system
    An output that is similar to the following example is displayed:
    trace_file_size: not set
    ksys_spooling: not set
    spool_dest_dir: not set
    spool_dir_max_size: not set
  • To enable KSYS spooling:
    ksysmgr modify system ksys_spooling=enable
    Note: If you enable the ksys_spooling and the spool_dest_dir value is not set for the KSYS spooling, then spool_dest_dir will get a default value as /tmp/ksys/rm.
  • To modify the KSYS spool_dir_max_size:
    ksysmgr modify system spool_dir_max_size=<value>
    • Example:
      ksysmgr modify system spool_dir_max_size=10240
      An output that is similar to the following example is displayed:
      trace_file_size: 25 MB
      ksys_spooling: enable
      spool_dest_dir: /S1
      spool_dir_max_size: 10240 MB
      hmc_ping_timer: 0 seconds
      Note: You will get an error message if the spool_dir_max_size value is greater than 10240 MB (10 GB).
  • To modify the ksys_spooling, trace_file_size, and spool_dest_dir:
    ksysmgr modify system trace_file_size=<value>
    ksys_spooling=<enable/disable> spool_dest_dir=<path>
    An output that is similar to the following example is displayed:
    vlanmap: Not currently set
    vswitchmap: Not currently set
    drvlanmap: Not currently set
    drvswitchmap: Not currently set
    trace_file_size: 30 MB
    ksys_spooling: enable
    spool_dest_dir: /S1
end of change

HMC port number

start of changeend of change
start of change
  • To query a HMC port number:
    ksysmgr q system
    An output that is similar to the following example is displayed:
    auto_discovery_time:     00:00 hours
    notification_level:      low
    dup_event_processing:    yes
    hmc_port_number:         443
  • To get help message for HMC port number:
    ksysmgr modify system -h
    A help message that is similar to the following example is displayed:
    [hmc_port_number=<val>] 
      val - 443 or 12443
  • To modify the HMC port number:
    ksysmgr modify system hmc_port_number=12443
Note: By default, the HMC port number value is 443. You can modify the HMC port number value to 12443.
end of change
HMC management
  • To add an HMC:
    ksysmgr add hmc hmcname login=username [password=password] hostname|ip=hostname|ip
    You can run the command without specifying the password in the command line. If you do not specify the password, enter the password as hidden characters when the command prompts for the password. For example,
    ksysmgr add hmc PrimaryHmcName login=hscroot ip=86.xx.xx.xx
    Enter Password for hmc: *********** Re-Enter Password: ************
  • To modify the HMC details:
    
    ksysmgr modify hmc hmcname [login=new_username] [password=new_password] [hostname|ip=hostname|ip]
  • To query an HMC:
    ksysmgr query hmc [hmcname]
  • To delete an HMC:
    ksysmgr delete hmc hmcname
  • To sync updated HMC information:
    ksysmgr refresh hmc [<hmcname>|<ALL>]
Host management
  • To add a host:
    ksysmgr add host hostname [uuid=uuid] [hostname|ip=hostname|ip]  
  • To modify the host details:
    ksysmgr modify host hostname1|uuid1[,hostname2|uuid2,...]
          [uuid=<uuid>]
          [skip_power_on=<yes|no>]
          [proactiveha=<enable | disable>]
          [vm_failure_detection_speed=<>]
  • To query hosts:
    ksysmgr query host [hostname]
  • To delete a host:
    ksysmgr delete host hostname
    You must first delete the host group to which the host belongs before deleting a host.
  • To sync updated host information:
    ksysmgr refresh host [<hostname>|<ALL>]
Host group configuration
  • To add a host group:
    ksysmgr add host_group hgname hosts= host1[,host2,…] 
          [repo_disk=diskuuid] [ha_disk=diskuuid] [backup_repo_disk=diskuuid1, diskuuid2…] 
    You can use the ksysmgr query viodisk command to identify the free disks that can be used in this step.
  • To modify host group details:
    ksysmgr modify host_group <name> <add | remove | options>
          [<hosts=<host1>,<host2>...>| file=<filepath>]
          [memory_capacity=<(1-100) | minimum | current_desired | none | default>
            priority=<low | medium | high>]
          [cpu_capacity=<(1-100) | minimum | current_desired | none | default>
            priority=<low | medium | high>]
          [skip_power_on=<yes|no>]
          [ha_disk=<ViodiskID>]
          [repo_disk=<ViodiskID>]
          [backup_repo_disk=<ViodiskID1[,ViodiskID2...]> | backup_repo_disk=none]
          [ha_monitor=<enable | disable>]
          [proactiveha=<enable | disable>]
          [restart_policy=<auto | advisory_mode>]
          [vm_failure_detection_speed=<>]
          [host_failure_detection_time=<90-600>]
        modify => mod*, ch*, set
        host_group => hg, host_g*
  • To modify the repository disk and the HA disk that are associated with a host group:
    ksysmgr modify host_group hgname options
          [repo_disk=diskuuid] [ha_disk=diskuuid][backup_repo_disk=diskuuid1,diskuuid2…] 
    You cannot modify the HA disk after the discovery operation, because the KSYS subsystem does not support the HA disk modification after the SSP cluster is created.
  • To discover a host group:
    ksysmgr discover host_group hg_name
  • To verify a host group:
    ksysmgr verify host_group hg_name
  • To discovery and verify a host group:
    ksysmgr discover host_group hg_name verify=true
  • To query a specific host group or all host groups:
    ksysmgr query host_group [hg_name]
  • To delete a host group:
    ksysmgr delete host_group hg_name
Application dependency between virtual machines
  • To establish dependency between applications of a virtual machine within a host group, run the following command:
    ksysmgr add app_dependency <name>
          app_list=<vmname1:appname1,vmname2:appname2[,...]>
          type=<parent_child|primary_secondary>
        add => ad*, cr*, make, mk
        app_dependency => app_dep*
    Note: app_list should have only 2 vmname:appname pairs for primary_secondary type
    Note:
    • The app_list attribute must have only two vmname:appname pairs for the primary-secondary structure of applications across VMs.
  • To query application dependency:
    ksysmgr query app_dependency
    
  • To start an application:
    ksysmgr start app [name=<appname1,[appname2,...]>] vm=<vmname>
        vm => lp*, vm
    Note:
    • You can enter multiple application names as value of the name attribute. But, all applications must belong to the single virtual machine.
    • If you do not provide any application name, all applications in the virtual machine start.
  • To stop an application:
    ksysmgr stop app [name=<appname1,[appname2,...]>] vm=<vmname>
        vm => lp*, vm
    Note:
    • You can enter multiple application names as value of the name attribute. But, all applications must belong to the single virtual machine.
    • If you do not provide any application name, all applications in the virtual machine stop.
HA monitoring policies
  • To enable or disable HA management,
    • For a host group:
      ksysmgr modify host_group <HGname> options ha_monitor=enable|disable
    • For a virtual machine:
      ksysmgr modify vm <vmname> ha_monitor=enable|disable
  • To specify the time that KSYS waits on a non-responsive host before declaring the host to be in an inactive state:
    ksysmgr modify system|host_group name
       host_failure_detection_time=time_in_seconds
    The value of this attribute can be in the range 90 - 600 seconds. The default value is 90 seconds.
  • To specify the time that KSYS will wait before declaring the failure of a VM:
    ksysmgr modify system|host_group|host|vm name
    vm_failure_detection_speed=fast|normal|slow
    You can select one of the following options: fast (140 seconds), normal (190 seconds), or slow (240 seconds). The default value of the vm_failure_detection_speed attribute is normal.
  • To modify the allocation of memory and CPU resources to a virtual machine when a virtual machine is moved from a host to another host:
    ksysmgr modify host_group name options
         [memory_capacity=<(1-100) | minimum | current_desired | none | default> priority=<low|medium|high>]
         [cpu_capacity=<(1-100) | minimum | current_desired | none | default> priority=low|medium|high>]
    Capacity adjustment occurs only when the VM is moving to a host that is not its home-host. Also, capacity adjustment is not possible when VM is moved to another host by using the Live Partition Mobility (LPM) operation. Capacity value is accepted in percentage. For example, a value of 89 or 890 means 89.0% of the original capacity must be deployed on the backup host of the host group when a VM is relocated.
Affinity policies
  • To specify that the set of VMs must always be placed on the same host after relocation:
    ksysmgr add collocation name vm=<vm1,vm2[,..]>
  • To modify the affinity policy of VMs to be placed on the same host after relocation:
    ksysmgr modify collocation name policy=add|delete vm=<vm1[,..]>
  • To specify that the set of VMs must not be placed on the same host after relocation:
    ksysmgr add anticollocation name vm=<vm1,vm2[,...]>
    
  • To modify the affinity policy of VMs such that VMs are not placed on the same host after relocation:
    ksysmgr modify anticollocation name policy=add|delete vm=<vm1[,..]>
  • To prioritize the set of VMs within the assigned priority:
    ksysmgr add workgroup name vm=<vm1,vm2[,...]>
    
  • To modify the affinity policy to prioritize the set of VMs within the assigned priority:
    ksysmgr modify workgroup name policy=add|delete vm=<vm1[,...]>
  • To specify a list of hosts that must not be used for relocating a specific virtual machine during a failover operation:
    ksysmgr modify vm name blocklist_hosts=<host1[,..]> [policy=add|delete]
Virtual machines HA policies
  • To include or exclude specific VMs from the KSYS configuration settings:
    ksysmgr manage|unmanage vm <vmname|lparuuid,....>
    Note: When you stop managing a virtual machine, the VM agent daemon becomes inoperative. In such cases, you must manually start the VM agent daemon.
  • To include or exclude all VMs of a specific host or a specific host group from the KSYS configuration settings:
    ksysmgr manage|unmanage vm name=<vmname> host=<hostname> | uuid=<lparuuid> | ALL host=<hostname> | ALL host_group=<host_group_name>
  • To set the priority of a virtual machine or to specify the order of virtual machines for a specific operation:
    ksysmgr modify vm name1[,name2,…] | filepath=filepath  
    priority=high|medium|low
    where, the filepath parameter is an XML file that contains a list of virtual machines. An example of the XML file follows:
    <?xml version="1.0"?>
    <KSYSMGR><VM><NAME>VM1</NAME></VM>
    <VM><NAME>VM2</NAME></VM>
    <VM><NAME>VM3</NAME></VM>
    </KSYSMGR>
    For example, when you relocate all the VMs to another host, the priority of the VMs determines which VMs must be processed first.
  • To set the home-host of a virtual machine:
    ksysmgr modify vm name1[,name2...] homehost=hostname
  • To query a specific or all virtual machines:
    ksysmgr query VM [VM_name] [display_all=yes]
    When you specify the display_all attribute, the output of this command includes the virtual machines of hosts that are not added to the KSYS subsystem but are registered in the added HMCs.

    The State field in the output is a significant field that indicates the current status of the VM. If the HA_monitor option is enabled, the Heartbeating_with field indicates the VIOS name to which the VM is sending heartbeats. If the VM is not associated with any VIOS, this field will be not be available.

    This command also displays the progress of applications. The APP_UPDATE_IN_PROGRESS, APP_RECOVER_IN_PROGRESS, and APP_ACTION_IN_PROGRESS values of the vm_status attribute display the state of applications.
    #ksysmgr q vm
    Name: <VM Name>
    UUID: <UUID>
    State: INIT
    Host: <Host Name>
    Priority: Medium
    VM_failure_detection_speed: normal
    HA_monitor: enable
    Proactiveha: disable
    Homehost: <Home Host Name>
    status:<Status>
    VM_status: APP_ACTION_IN_PROGRESS
    Version_conflict: No
    AppMessaging: enable
  • To manually clean up a specific virtual machine after the move operations:
    ksysmgr [-f] cleanup vm <vmname1[,vmname2,...]> host=<hostname>
  • To restore a virtual machine:
    ksysmgr restore vm <vmname1,[vmname2,...]>
  • To query collocation:
    ksysmgr query collocation [<name>]
  • To query anticollocation:
    ksysmgr query anticollocation [<name>]
VIOS management
  • To query a specific VIOS or all virtual I/O servers:
    ksysmgr query vios [vios_name] [display_all=yes]  
    When you specify the display_all attribute, the output of this command includes the VIOS of hosts that are not added to the KSYS subsystem but are registered in the added HMCs.
  • To include or exclude a specific VIOS from the HA management:
    ksysmgr manage|unmanage vios viosname
  • To modify the VIOS logging level for specific components:
    ksysmgr modify vios <viosname[,viosname2,...> | file=<filepath>
          [hm_log_level=<(0-55)>]
           Note:hm_log_level=<(hmLogLevel)(hvncpLogLevel)>
                if the value is set as 34, 3 indicates host_monitor log level, 4 indicates hvncp log level.
                Log level for each VIOS must be in the 0-5 range.
          [hm_spooling=<4-10>]
          [hm_api=<0|1|2|3>]
          [health_api=<0|1|2|3>]
start of changeHMmissedHBend of change
start of changeWhen VIOSes are down, you get the VIOS_HM_NONRESP_DETECTED event after the HMmissedHB value (in seconds). This tunable sets the HMresponsive attribute to NO when the VIOS is down after the HMmissedHB timeout. This tunable is introduced at the VIOS level. The default value for this tunable is 8. You can set the value from 8 to a maximum value of 300 for this attribute. But you cannot set a value less than 8. To find out the value of the HMmissedHB attribute, run the following command:
ksysmgr q vios
An output that is similar to this screen is displayed:

Name: <name>
Site: <site>
UUID: <uuid> 
Host: <host> 
Version: VIOS 3.1.2.00
State: MANAGED
HMstate: Yes
Last_response: 0 seconds
MAC_address: <mac_address> 
HM_versions: 2.00
2.01
2.02
HMmissedHB: 8
end of change
Notification contacts
  • To register contact details for notification from the KSYS:
    ksysmgr add notify user=username contact=email_address
    If you chose the advisory_mode option in the restart policy, you must register an email address to get notifications about the failures.
  • To modify the contact details for notification from the KSYS:
    ksysmgr modify notify oldcontact=old_username newcontact=new_username
    ksysmgr modify notify oldcontact=old_email_address newcontact=new_email_address
  • To query existing contact details:
    ksysmgr query notify [ contact | script ]\n\
          [ user=<username> | contact=<contact> ]\n\
          [ script=<full path script> ]\n\
  • To delete a specific contact:
    ksysmgr delete notify user=username
Event notification script management
  • To register notification scripts for specific events and errors:
    ksysmgr add notify script=full_path_script events=event_name
    You can add a maximum number of 10 event notification scripts to the KSYS configuration settings.
  • To modify a specific notification script:
    ksysmgr modify notify oldscript=old_file_name newscript=new_file_name
  • To query notification scripts:
    ksysmgr query notify script
  • To delete a specific notification script:
    ksysmgr delete notify script=file_name
Script management
  • To register scripts for specific KSYS operations such as discovery and verification:
    ksysmgr add script entity=<host_group|vm>
      pre_offline|post_online|pre_online|post_online|pre_verify|post_verify=<script_file_path>
  • To query the existing user scripts:
    ksysmgr query script entity=<host_group|vm>
  • To delete an existing user script:
    ksysmgr delete script entity=<host_group|vm>
          script_name=<pre_offline|post_online|pre_online|post_online|pre_verify|post_verify>
System-wide attributes
  • To query system status:
    ksysmgr query system
  • To modify the system attributes:
    ksysmgr modify system attribute=new_value
  • To stop health monitoring for high-availability in the entire configuration:
    ksysmgr modify system ha_monitor=disable
Configuration snapshots
  • To create a backup of the KSYS environment:
    ksysmgr add snapshot filepath=full_file_prefix_path
  • To restore the backed up configuration snapshot:
    ksysmgr restore snapshot filepath=full_file_prefix_path
  • To query snapshots:
    ksysmgr query snapshot filepath=full_file_prefix_path
Note: Do not restore or save an snapshot when an operation is running on the KSYS node.
You cannot remove a snapshot by using the ksysmgr command. You must remove the snapshot manually by using standard operating system commands.
Cleanup operations
  • To clean up a specific virtual machine in a specific host:
    ksysmgr [-f] cleanup vm <vmname1[,vmname2,...]> host=<hostname>
Migration operations (LPM)
  • To migrate a single VM or a set of VMs by using the Live Partition Mobility (LPM) operation:
    ksysmgr [-f] lpm vm vm1[,vm2,..] [to=hostname|uuid]
  • To validate an LPM operation without migrating virtual machines:
    ksysmgr [-f] lpm vm vm1[,vm2,..] action=validate
  • To migrate all VMs in a host:
    ksysmgr [-f] lpm host hostname|uuid [to=hostname|uuid]
  • To restore all VMs that belong to a specific host:
    ksysmgr restore host hostname|uuid
  • To recover a VM:
    ksysmgr lpm vm vmname action=recover
Manual restart operations
  • To relocate and restart a single VM or a set of VMs:
    ksysmgr [-f] restart vm vm1[,vm2,..] [to=hostname|uuid]
  • To relocate and restart all VMs in a host:
    ksysmgr [-f] restart host hostname|uuid [to=hostname|uuid]
    The manual restart commands must be used to relocate the VMs if you have set the advisory_mode option for the restart policy. You cannot restart a VM on the same host in which the VM is located by using the ksysmgr restart command. To restart a VM on the same host, use the restart option in the HMC. If the restart operations fail, you can attempt to recover the virtual machine in the same host where it is located.
  • To recover a VM in the same host where the VM is located:
    ksysmgr [-f] recover vm vmname
General queries
  • To check the version of the KSYS software:
    ksysmgr query version
  • To query the system-wide configuration details:
    ksysmgr query system
  • To list the various types of events that are generated by the KSYS subsystem:
    ksysmgr query event
    <vios=<viosname[,viosname2,...] ||
    hosts=<hostname1[,hostname2,...] ||
    host_group=<host_group_name>>
    query => q*, ls, get, sh*
    viodisk => viod*
  • To list the free disks that are attached to or shared among various VIOS:
    ksysmgr query viodisk vios=viosname
  • To check the current activities and general health of the environment:
    ksysmgr query system status
    This command displays error messages as a verbose output.
  • To monitor the activities that are running currently:
    ksysmgr q system status monitor=yes
  • To display the health status of the registered applications:
    ksysmgr query app
    You can use this command to check the status of the registered applications inside each virtual machine. The application status value GREEN indicates a stable application. The YELLOW value indicates an intermediate state of application in which the application is attempted to be restarted. The RED value indicates permanent failure of an application.

    The HA policies for an application can be configured in the VM only by using the ksysvmmgr command.

  • To review the relocation plan for a VM or a host:
    ksysmgr report system relocation_plan [vm=vm_list | host=host_list]
    You can also use UUID of VMs or hosts instead of names.
  • To print trace information from KSYS trace files to standard output:
    ksysmgr trace log type=<ksys|fde|fdelong|krest|krestlong|user|ALL>

Examples

The following examples show a scenario where you deploy a host group for HA management, enable HA policies for the host group, and perform planned and unplanned relocation operations for the virtual machines, if required:

  1. Identify the servers or hosts that will be part of the host group. Complete all the prerequisites that are specified in the Requirements topic.
  2. Create, verify, and synchronize a KSYS cluster by running the following command:
    ksysmgr add ksyscluster name 
        ksysnodes=ksysnode1 type=HA sync=yes
  3. Register all the HMCs in the environment by running the following command:
    ksysmgr add hmc HMC1 ip=x.x.x.x login=username password=password
    
  4. Create a host group by running the following command:
    ksysmgr add host_group HG1 hosts=hostA[,hostB,...]
  5. Identify the free disks that you can designate as repository disk and HA disk for the SSP cluster by running the following command:
    ksysmgr query viodisk host_group=HG1
  6. Modify the host group to add repository disk and HA disk by running the following command:
    ksysmgr modify host_group HG1 options 
         repo_disk=Disk1uuid ha_disk=Disk2uuid
  7. Configure the failure detection time and other policies according to your requirements by running the following commands:
    ksysmgr modify host_group HG1 options
    vm_failure_detection_speed=fast
    host_failure_detection_time=100
  8. Configure an email address for event notifications by running the following command:
    ksysmgr add notify user=John contact=john.doe@testmail.com
  9. Enable HA monitoring for the host group by running the following command:
    ksysmgr modify host_group HG1 options ha_monitor=enable
  10. Discover and verify the added resources and policies by running the following command:
    ksysmgr discover host_group HG1 verify=yes
  11. If you want to upgrade a host or if you plan a host maintenance, migrate all the virtual machines to another host by running the following command:
    ksysmgr lpm host hostA|uuid
  12. After the upgrade operation or maintenance activity of the host is complete, restore the virtual machines back to the host by running the following command:
    ksysmgr restore host hostA|uuid
  13. If a host or a virtual machine fails, restart the virtual machines on another host by running the following command:
    ksysmgr restart vm vm1[,vm2,...]
  14. To display only minimum information about VMs before performing the first discovery operation, run the following command:
    ksysmgr query vm display_all=yes
    Note: The display_all option can be used before performing the first discovery operation to display only minimum information about the VMs that are added to the KSYS configuration. To display the current information about a VM, use the ksysmgr query vm command without the display_all option.