node

allowed_networks

scopable False
required False
default 10.0.0.0/8 172.16.0.0/24 192.168.0.0/16
scope order specific > generic
convert list

The list of cidr blocks the agents allows creation of backend network into. Should be restricted to match your site constraints.

asset_env

scopable False
required False
default None
scope order specific > generic

An asset information to push to the collector on pushasset, overriding the currently stored value.

bios_version

scopable False
required False
default None
scope order specific > generic

Override for the corresponding pushasset discovery probe.

branch

scopable False
required False
default None
scope order specific > generic

Set the targeted opensvc agent branch. The downloaded upgrades will honor that branch. If not set, the repopkg imposes the target branch, which is not recommended with a public repopkg.

connect_to

scopable False
required False
default None
scope order specific > generic

An asset information to push to the collector on pushasset, overriding the currently discovered value. On GCE instances, defaults to the instance ip address.

cpu_cores

scopable False
required False
default None
scope order specific > generic
convert integer

Override for the corresponding pushasset discovery probe.

cpu_dies

scopable False
required False
default None
scope order specific > generic
convert integer

Override for the corresponding pushasset discovery probe.

cpu_freq

scopable False
required False
default None
scope order specific > generic

Override for the corresponding pushasset discovery probe.

cpu_model

scopable False
required False
default None
scope order specific > generic

Override for the corresponding pushasset discovery probe.

cpu_threads

scopable False
required False
default None
scope order specific > generic
convert integer

Override for the corresponding pushasset discovery probe.

dbcompliance

scopable False
required False
default Same protocol, server and port as dbopensvc, but with an different path.
scope order specific > generic

Set the uri of the collector's main xmlrpc server. The path part of the uri can be left unspecified.

dblog

scopable False
required False
default True
scope order specific > generic
convert boolean

If true and dbopensvc is set, the objects action logs are reported to the collector. Set to false to disable log reporting to the collector, event if dbopensvc is set.

dbopensvc

scopable False
required False
default None
scope order specific > generic

Set the uri of the collector main xmlrpc server. The path part of the uri can be left unspecified. If not set, the agent does not try to communicate with a collector.

enclosure

scopable False
required False
default None
scope order specific > generic

Override for the corresponding pushasset discovery probe.

env

scopable False
required False
default TST
scope order specific > generic
candidates DEV | DRP | FOR | INT | PRA | PRD | PRJ | PPRD | REC | STG | TMP | TST | UAT

A non-PRD service can not be brought up on a PRD node, but a PRD service can be startup on a non-PRD node (in a DRP situation).

loc_addr

scopable False
required False
default None
scope order specific > generic

An asset information to push to the collector on pushasset, overriding the currently stored value.

loc_building

scopable False
required False
default None
scope order specific > generic

An asset information to push to the collector on pushasset, overriding the currently stored value.

loc_city

scopable False
required False
default None
scope order specific > generic

An asset information to push to the collector on pushasset, overriding the currently stored value.

loc_country

scopable False
required False
default None
scope order specific > generic

An asset information to push to the collector on pushasset, overriding the currently stored value.

loc_floor

scopable False
required False
default None
scope order specific > generic

An asset information to push to the collector on pushasset, overriding the currently stored value.

loc_rack

scopable False
required False
default None
scope order specific > generic

An asset information to push to the collector on pushasset, overriding the currently stored value.

loc_room

scopable False
required False
default None
scope order specific > generic

An asset information to push to the collector on pushasset, overriding the currently stored value.

loc_zip

scopable False
required False
default None
scope order specific > generic

An asset information to push to the collector on pushasset, overriding the currently stored value.

maintenance_grace_period

scopable False
required False
default 60
scope order specific > generic
convert duration

A duration expression, like 1m30s, defining how long the daemon retains a remote in-maintenance node data. The maintenance state is announced to peers on daemon stop and daemon restart, but not on daemon shutdown. As long as the remote node data are retained, the local daemon won't opt-in to takeover its running instances. This parameter should be adjusted to span the daemon restart time.

manufacturer

scopable False
required False
default None
scope order specific > generic

Override for the corresponding pushasset discovery probe.

max_parallel

scopable False
required False
default 10
scope order specific > generic
convert integer

Allow a maximum of max_parallel subprocesses to run simultaneously on svcmgr --parallel <action> commands.

mem_banks

scopable False
required False
default None
scope order specific > generic
convert integer

Override for the corresponding pushasset discovery probe.

mem_bytes

scopable False
required False
default None
scope order specific > generic
convert size

Override for the corresponding pushasset discovery probe.

mem_slots

scopable False
required False
default None
scope order specific > generic
convert integer

Override for the corresponding pushasset discovery probe.

min_avail_mem

scopable False
required False
default 2%
scope order specific > generic
convert size

The minimum required available memory to allow orchestration.

min_avail_swap

scopable False
required False
default 10%
scope order specific > generic
convert size

The minimum required available swap to allow orchestration.

model

scopable False
required False
default None
scope order specific > generic

Override for the corresponding pushasset discovery probe.

oci

scopable False
required False
default None
scope order specific > generic

The default micro-container driver. If not set, prefer podman if installed, fallback to docker.

os_arch

scopable False
required False
default None
scope order specific > generic

Override for the corresponding pushasset discovery probe.

os_kernel

scopable False
required False
default None
scope order specific > generic

Override for the corresponding pushasset discovery probe.

os_release

scopable False
required False
default None
scope order specific > generic

Override for the corresponding pushasset discovery probe.

os_vendor

scopable False
required False
default None
scope order specific > generic

Override for the corresponding pushasset discovery probe.

pkg_format

scopable False
required False
default auto
scope order specific > generic
candidates tar | auto

Force usage of a package format. Only the tar format can be forced.

prkey

scopable False
required False
default <autogenerated>
scope order specific > generic

The scsi3 persistent reservation key used by the pr resources.

ready_period

scopable False
required False
default 5
scope order specific > generic
convert duration

A duration expression, like 10s, defining how long the daemon monitor waits before starting a service instance in ready state. A peer node can preempt the start during this period. Usually set to allow at least a couple of heartbeats to be received.

rejoin_grace_period

scopable False
required False
default 90
scope order specific > generic
convert duration

A duration expression, like 90m, defining how long the daemon restrains from taking start decisions if no heartbeat has been received from a peer since daemon startup. This should be adjusted to the maximum delay you can afford to give a chance to services to start on their placement leader after a simultaneous node reboot.

repo

scopable False
required False
default None
scope order specific > generic

Set the uri of the opensvc agent package repository and compliance modules gzipped tarball repository. This parameter is used by the nodemgr updatepkg and nodemgr updatecomp commands.

Expected repository structure:

ROOT
+- compliance
 +- compliance-100.tar.gz
 +- compliance-101.tar.gz
 +- current -> compliance-101.tar.gz
+- packages
 +- deb
 +- depot
 +- pkg
 +- sunos-pkg
 +- rpms
  +- current -> 2.0/current
  +- 1.9
   +- current -> opensvc-1.9-50.rpm
   +- opensvc-1.9-49.rpm
   +- opensvc-1.9-50.rpm
  +- 2.0
   +- current -> opensvc-2.0-90.rpm
   +- opensvc-2.0-90.rpm
 +- tbz

repocomp

scopable False
required False
default None
scope order specific > generic

Set the uri of the opensvc compliance modules gzipped tarball repository. This parameter is used by the nodemgr updatecomp command.

Expected repository structure:

ROOT
+- compliance-100.tar.gz
+- compliance-101.tar.gz
+- current -> compliance-101.tar.gz

repopkg

scopable False
required False
default None
scope order specific > generic

Set the uri of the opensvc agent package repository. This parameter is used by the nodemgr updatepkg command.

Expected repository structure:

ROOT
+- deb
+- depot
+- pkg
+- sunos-pkg
+- rpms
 +- current -> 2.0/current
 +- 1.9
  +- current -> opensvc-1.9-50.rpm
  +- opensvc-1.9-49.rpm
  +- opensvc-1.9-50.rpm
 +- 2.0
  +- current -> opensvc-2.0-90.rpm
  +- opensvc-2.0-90.rpm
+- tbz

ruser

scopable False
required False
default root
scope order specific > generic

Set the remote user to use to login to a remote node with ssh and rsync. The remote user must have the privileges to run as root the following commands on the remote node: * nodemgr * svcmgr * rsync The default ruser is root for all nodes. ruser accepts a list of user[@node] ... If @node is ommited, user is considered the new default user.

sec_zone

scopable False
required False
default None
scope order specific > generic

An asset information to push to the collector on pushasset, overriding the currently stored value.

serial

scopable False
required False
default None
scope order specific > generic

Override for the corresponding pushasset discovery probe.

sp_version

scopable False
required False
default None
scope order specific > generic

Override for the corresponding pushasset discovery probe.

team_integ

scopable False
required False
default None
scope order specific > generic

An asset information to push to the collector on pushasset, overriding the currently stored value.

team_support

scopable False
required False
default None
scope order specific > generic

An asset information to push to the collector on pushasset, overriding the currently stored value.

tz

scopable False
required False
default None
scope order specific > generic

Override for the corresponding pushasset discovery probe.

uuid

scopable False
required False
default None
scope order specific > generic

The auth token provided by the collector on nodemgr register.