Select - OpenSVC

Select Objects

Commands use the om <selector> <action> syntax to operate on a selection of objects. The om <selector> ls command can test a selector before submitting a dangerous action.

Note the selector expression may need to be quoted for the shell not to interpret the ! and * characters.

All Objects

List all cluster objects (services, volumes, etc.).

om '**' ls

All Services

List all service objects.

om '*' ls
om '*/svc/*' ls

Single Object

List a specific object.

om <path> ls
om ns1/svc/web1 ls

List of objects

With a /tmp/svc.list containing:

# Ignored object paths
; svc1
;svc2

# Ignored empty lines

# Honored object paths
# Leading and trailing whitespaces are trimmed
svc3
  svc4

An action can be executed using:

cat /tmp/svc.list | om - ls

om - ls </tmp/svc.list

The template output renderer of many om command can produce lists of object paths matching criteria.

# Start all objects in avail=down state
om svc ls -o 'template={{ range . }}{{ if ne .data.avail "up" }}{{println .meta.object}}{{ end }}{{ end }}' | om - start

# Freeze all objects not frozen
om svc ls -o 'template={{ range . }}{{ if ne .data.frozen "frozen" }}{{println .meta.object}}{{ end }}{{ end }}' | om - freeze

Unions

List multiple specific objects.

om <path1>,<path2> ls
om ns1/svc/web1,ns1/vol/web1 ls

Intersections

List objects matching multiple criteria.

om 'ns1/*/web1+*/svc/*' ls

is equivallent to

om ns1/svc/web1 ls

Mixing Unions and Intersections

The unioned expressions are evaluated from comma to comma, intersections are evaluated in the context of the current union.

For example,

om 'ns1/svc/*+ns1/*/web1,ns2/svc/web2'

is parsed as:

(ns1/svc/* intersected with ns1/*/web1) unioned with (ns2/svc/web2)

and evaluates as:

ns1/svc/web1
ns2/svc/web1

Negation

The negation marker is !. This symbol needs quoting for the shell not to interpret it.

Example:

# All object of namespace `ns1` except those named `web1`:
om 'ns1/**+!**/web1' ls

Services by State

Filter services based on their overall status.

List all services in the down state:
```
om '*' ls --status down
```
List all services in up and warn states:
```
om '*' ls --status up,warn
```

Service Selector Expressions

Use powerful expressions to filter objects based on configuration parameters.

om <expr> ls

Where $\text{}$ is a pattern or condition: $\text{}$ or $\text{[!]\text{}\text{}\text{}}$.

Parameter ($\text{}$)	Description
$\text{.\text{}}$	A key within a specific resource ID in the service config.
$\text{.\text{}}$	A key within a driver group (e.g., `disk`, `fs`, `app`).
$\text{}$	A key in the service configuration file header.

Operator ($\text{}$)	Description
$\text{<}, \text{>}, \text{<=}, \text{>=}, \text{=}$	Standard comparison operators.
$\text{:}$	Existence test operator (value is empty).
$\text{~}$	Regular expression operator.

Separators / Modifiers	Description
$\text{!}$	Negation operator.
$\text{+}$	AND expression separator.
$\text{,}$	OR expression separator.

Note: Matching is case-sensitive, except for boolean values.

Examples

Services with name ending with dns OR starting with ha, AND which have an app resource with a timeout greater than 1:

om '*dns,web*' config get -o 'template={{range .}}{{if and (hasPrefix .keyword "app#") (hasSuffix .keyword ".timeout") (ge .value 1)}}{{end}}'

Services with at least one ip resource AND one task resource:
```
om 'ip:+task:' ls
# ha1, ha2, ha3, registry
```
Services with at least one monitored resource AND with monitor_schedule not set:
```
om '!monitor_schedule+.monitor=true' ls
# ha1, ha4
```