server.ip-rct

IP-RCT server

type	object
properties
aeIdentifier	OnSphere instance communication identifier to the IP-RCT. Learn more about IP-RCT ↗️.
	type	string
certificatePath	The file path to the certificate used for SSL communications. An absolute path is required. Learn more about IP-RCT ↗️.
	type	string
disabledIpRctBehavior	Disables IP-RCT module default behavior. Should you want to disable alarm acknowledge, add ACKNOWLEDGE_ALARM to the list, and so on. Learn more about IP-RCT disabled behavior↗️
	type	array
	items	type	string
		enum	HANDLE_ALARM, ACKNOWLEDGE_ALARM, SEND_REMOTE_ORDER, SET_SPT_STATE
hostname	The IP address of the IP-RCT server. This address is used by the client to connect to the IP-RCT server on the network. For example, 192.168.42.1 is valid. Learn more about IP-RCT ↗️.
	type	string
isTemplateGeneratedByOspComposer	Name of the playbook that generated this file. If present, the file is managed by the Composer and may be overwritten on regeneration. Used for selective clean. Do not edit or set manually.
	type	string
moduleId	The IP-RCT module module.ip-rct ↗️ that this server will use to communicate. For example modules.ip-rct.ip-rct-1 is the default OnSphere path of the IP-RCT module.
	type	string
passwordProvider	The password to use for the connection to the IP-RCT server. It can be defined as plaintext or via a secret. Learn more about IP-RCT ↗️.
	oneOf	PLAINTEXT
		SECRET
		ENCRYPTED
port	The port number on which the IP-RCT server is listening. This port is used by the client to establish a connection with the server. It should be a valid port number between 0 and 65535. Learn more about IP-RCT ↗️.
	type	integer
templateId	The id of the template to use for this file
	type	string
templateVariables	The variables and their values to be replaced from the template
	type	object
	additionalProperties
username	The username to use for the connection to the IP-RCT server. It can be for example sysadmin. Learn more about IP-RCT ↗️.
	type	string
variablesFiles	The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.
	type	array
	items	type	string
additionalProperties	False

PLAINTEXT

type	object
properties
type	type	string
	enum	PLAINTEXT
	default	PLAINTEXT
password	The password to use in plaintext. It can be for example thisIs@TestPassword123.
	type	string
additionalProperties	False

SECRET

type	object
properties
type	type	string
	enum	SECRET
	default	SECRET
secretPath	The path of the secret containing the password. This is a path to the secret containing the password.
	type	string
additionalProperties	False

ENCRYPTED

type	object
properties
type	type	string
	enum	ENCRYPTED
	default	ENCRYPTED
encryptedPassword	The password encrypted Base64(IV+AES256(password, input)) the password must be a shared secret available for the osp-configuration-dispatcher see documentation ↗️ see toolbox ↗️
	type	string
secretPath	The full path to the secret exposed by the orchestrator; this password is used to encrypt the encryptedPassword. see documentation ↗️ see toolbox ↗️
	type	string
additionalProperties	False