Driver `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"

Supported keywords:

api
insecure
max_peers
password
schedule
timeout
type
username

Keyword `api`

required:    true
scopable:    false

Example:

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

Description:

The array rest api url.

Keyword `insecure`

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

Example:

insecure=true

Description:

Disable secure socket verification.

Keyword `max_peers`

required:    false
scopable:    false
convert:     int

Example:

max_peers=8

Description:

Keyword `password`

required:    true
scopable:    false

Example:

password=from system/sec/array1 key password

Description:

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

Value format:

New format: from <namespace>/<kind>/<name> key <key name>
Legacy format: <namespace>/<kind>/<name> (uses default key “password”)

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

Keyword `schedule`

required:    false
scopable:    false

Description:

Schedule parameter for the pusharray node action.

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

Keyword `timeout`

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

Example:

timeout=10s

Description:

The api request timeout.

Keyword `type`

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

Description:

The storage array driver name.

Keyword `username`

required:    true
scopable:    false

Example:

username=root

Description:

The username to use to log in.

Keyboard shortcuts

OpenSVC