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

Driver array.hds

Minimal configlet:

[array#1]
type = hds
password = from system/sec/array1 key password
url = https://hdsmanager/
username = root

Minimal setup command:

om test/ccfg/foo set \
	--kw="type=hds" \
	--kw="password=from system/sec/array1 key password" \
	--kw="url=https://hdsmanager/" \
	--kw="username=root"

Supported keywords:

  • bin
  • comment
  • jre_path
  • name
  • password
  • schedule
  • type
  • url
  • username

Keyword bin

required:    false
scopable:    false
rbac:        This driver group requires the root grant.

Example:

bin=/opt/hds/bin/HiCommandCLI

Description:

The HDS manager executable to use.

Keyword comment

required:    false
scopable:    false
rbac:        This driver group requires the root grant.

Description:

A free form text describing the role of the object, of the node, or of the section it is set in.

The keyword is accepted in any section, so the DEFAULT section can document a configuration as a whole, and a resource, pool, heartbeat, array or network section can document itself.

The agent does not interpret the value.

Keyword jre_path

required:    false
scopable:    false
rbac:        This driver group requires the root grant.

Example:

jre_path=/opt/java

Description:

The path hosting the java installation to use to execute the HiCommandCLI.

Keyword name

required:    false
scopable:    false
rbac:        This driver group requires the root grant.

Example:

name=HUSVM.1234

Description:

The name of the array. If not provided, fallback to the section name suffix.

Keyword password

required:    true
scopable:    false
rbac:        This driver group requires the root grant.

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
rbac:        This driver group requires the root grant.

Description:

Schedule parameter for the pusharray node action.

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

Keyword type

required:    true
scopable:    false
candidates:  freenas, hds, eva, nexenta, vioserver, centera, symmetrix, emcvnx, netapp, hp3par, ibmds, ibmsvc, xtremio, dorado, hoc, truenas
rbac:        This driver group requires the root grant.

Description:

The storage array driver name.

Keyword url

required:    true
scopable:    false
rbac:        This driver group requires the root grant.

Example:

url=https://hdsmanager/

Description:

The url passed to HiCommandCli, pointing the manager in charge of the array.

Keyword username

required:    true
scopable:    false
rbac:        This driver group requires the root grant.

Example:

username=root

Description:

The username to use to log in.