OPH_INSTANCES

Description

Type

Metadata Access.

Behaviour

It shows information about host partitions, hosts and dbms instances.

Parameters

  • action: command type; use:
    • “read” to access information (default),
    • “add” to create user-defined host partitions,
    • “remove” to remove user-defined host partitions.
  • level: show hosts with “1”, DBMS instances with “2” or host partitions with “3”.
  • host_filter: in “read” mode it is an optional filter on host name and can be used only with level 2; in “add” mode it is the list of host identifiers to be grouped in the user-defined partition.
  • nhost : in “add” or “remove” mode it is the number of hosts to be grouped in the user-defined partition. If it is non-zero then “host_filter” is negleted.
  • host_partition: in “read” mode it is an optional filter on host partition name and can be used only with level 3 (if no partition is specified, then the list of all partitions is shown); in “add” mode it is the name of the new partition; in “remove” mode it is the name of the partition to be removed.
  • ioserver_filter: optional filter on the type of I/O server used. Used only with level 2. Possible values are: “mysql_table” for MySQL I/O servers, “ophidiaio_memory” for Ophidia I/O servers only or “all” (default) for any type of I/O server.
  • host_status: optional filter on the status of analytics nodes. Possible values are: “up” for up hosts, “down” for down hosts, “all” (default) for all hosts.

System parameters

  • exec_mode: operator execution mode. Possible values are async (default) for asynchronous mode, sync for synchronous mode with json-compliant output.
  • ncores: number of parallel processes to be used (min. 1). This operator is not parallel, so the only possible value is 1.
  • sessionid: session identifier used server-side to manage sessions and jobs. Usually, users don’t need to use/modify it, except when it is necessary to create a new session or switch to another one.
  • objkey_filter: filter on the output of the operator written to file (default=all => no filter, none => no output, instances => shows operator’s output table, instances_summary => show operator’s output table with summary).

Examples

Show all information about hosts and dbms instances:

[OPH_TERM] >>  oph_instances level=2;host_filter=all;

Arguments

Argument name Type Mandatory Values Default Min/Max-value
action “string” “no” “read|add|remove” “read”  
level “int” “no” “1|2|3” “1” “1” / “3”
host_filter “string” “no”   “all”  
nhost “int” “no”   “0” “0” /
host_partition “string” “no”   “all”  
ioserver_filter “string” “no” “mysql_table|ophidiaio_memory|all” “all”  
host_status “string” “no” “up|down|all” “all”  
exec_mode “string” “no” “async|sync” “async”  
sessionid “string” “no”   “null”  
ncores “int” “no”   “1” “1” / “1”
objkey_filter “string” “no” “all|none|instances|instances_summary” “all”