Driver array.pure

Minimal configlet:

[array#1]
type = pure
api = https://array.opensvc.com/api/v1.0
client_id = bd2c75d0-f0d5-11ee-a362-8b0f2d1b83d7
issuer = opensvc
key_id = df80ae3a-f0d5-11ee-94c9-b7c8d2f57c4f
secret = system/sec/array1
username = opensvc

Minimal setup command:

om node set \
	--kw="type=pure" \
	--kw="api=https://array.opensvc.com/api/v1.0" \
	--kw="client_id=bd2c75d0-f0d5-11ee-a362-8b0f2d1b83d7" \
	--kw="issuer=opensvc" \
	--kw="key_id=df80ae3a-f0d5-11ee-94c9-b7c8d2f57c4f" \
	--kw="secret=system/sec/array1" \
	--kw="username=opensvc"

Supported keywords:

• api
• client_id
• comment
• insecure
• issuer
• key_id
• schedule
• secret
• type
• username

Keyword api

required:    true
scopable:    false

Example:

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

Description:

The array rest api url.

Keyword client_id

required:    true
scopable:    false

Example:

client_id=bd2c75d0-f0d5-11ee-a362-8b0f2d1b83d7

Description:

The client id to use as the aud key in the payload of the login jwt.

Keyword comment

required:    false
scopable:    false

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 insecure

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

Example:

insecure=true

Description:

Disable secure socket verification.

Keyword issuer

required:    true
scopable:    false

Example:

issuer=opensvc

Description:

The issuer to use as the iss key in the payload of the login jwt token.

Keyword key_id

required:    true
scopable:    false

Example:

key_id=df80ae3a-f0d5-11ee-94c9-b7c8d2f57c4f

Description:

The key id to use as the kid key in the header of the login jwt.

Keyword schedule

required:    false
scopable:    false

Description:

Schedule parameter for the pusharray node action.

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

Keyword secret

required:    true
scopable:    false

Example:

secret=system/sec/array1

Description:

The secret to use to store the information required to create the login jwt, expressed as a reference to a secret. The secret must be in the system namespace and must have the following keys: private_key.

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=opensvc

Description:

The username to use as the sub key in the payload of the login jwt.