Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

array.truenas

Minimal configlet:

[array#1]
type = truenas
api = https://array.opensvc.com/api/v1.0
password = from system/sec/array1 key password
username = root

Minimal setup command:

om node set \
	--kw="type=truenas" \
	--kw="api=https://array.opensvc.com/api/v1.0" \
	--kw="password=from system/sec/array1 key password" \
	--kw="username=root"

api

required:    true
scopable:    false

Example:

api=https://array.opensvc.com/api/v1.0

The array rest api url.

insecure

required:    false
scopable:    false
default:     false
convert:     bool

Example:

insecure=true

Disable secure socket verification.

password

required:    true
scopable:    false

Example:

password=from system/sec/array1 key password

The password to use to log in, expressed as a datastore reference:

from <namespace>/<kind>/<name> key <name>

Array passwords are usually stored in sec datastores like system/sec/<array name>.

schedule

required:    false
scopable:    false

Schedule parameter for the pusharray node action.

See usr/share/doc/schedule for the schedule syntax.

timeout

required:    false
scopable:    false
default:     120s
convert:     duration

Example:

timeout=10s

The api request timeout.

type

required:    true
scopable:    false
candidates:  freenas, hds, eva, nexenta, vioserver, centera, symmetrix, emcvnx, netapp, hp3par, ibmds, ibmsvc, xtremio, dorado, hoc, truenas

The storage array driver name.

username

required:    true
scopable:    false

Example:

username=root

The username to use to log in.