Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%Net] >  [Provision] >  [Configure]
Private  Storage   

class %Net.Provision.Configure extends %RegisteredObject

Represents a Provisioning object. Each Provisioning object must first be connected, then authenticated with the remote system. Note that there are multiple methods of authentication: password and publickey. Once connected and authenticated, the Provisioning object can be used to perform installation of InterSystems IRIS on a remote system. Once installed, the object can also be used to apply for EM Management. NOTE: Provisioning is not supported on OpenVMS platforms.
NOTE: Sudo is required for install. Note also that the "Defaults requiretty" setting in /etc/sudoers must be disabled (the default). SSH must be configured on the target machine, with PasswordAuthentication for sshd.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
32 22


Summary

Properties
Authenticated CacheGroup CacheKeyFile CachePassword
CacheUser EMManageStatus EMSystemLog InstallDir
InstanceName KitDir KitFile Log
ManagerGroup Manifest Password RemoteOutput
SSHHostKey SSHHostName SSHPassPhrase SSHPort
SSHPrivateKeyFile SSHPublicKeyFile SSPort SecurityType
Session Sftp Status TempDir
Unicode Upgrade Username WSPort

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
AuthenticateWithKeyPair AuthenticateWithUsername EMGetGUID EMManage
EMManagePass EMRemove ManageCache Provision
Status


Properties

• property Authenticated as %Boolean [ InitialExpression = 0 ];
• property CacheGroup as %String [ InitialExpression = "irisusr" ];
• property CacheKeyFile as %String;
• property CachePassword as %String [ InitialExpression = "SYS" ];
• property CacheUser as %String [ InitialExpression = "irisusr" ];
• property EMManageStatus as %String;
Output log from execution of EM Manage.
• property EMSystemLog as %String;
System log from EM Manage
• property InstallDir as %String;
Where we install the instance on the remote machine.
• property InstanceName as %String;
Instance name we install on the remote machine
• property KitDir as %String;
Directory where the kit lives on the local machine.
This may be a network drive which is available on the remote machine as well.
• property KitFile as %String;
Name of the tar file we are going to install.
• property Log as %String [ InitialExpression = "Provision_"_$j_".log" ];
Output log from this session.
• property ManagerGroup as %String [ InitialExpression = "root" ];
• property Manifest as %String;
• property Password as %String;
• property RemoteOutput as %String;
Output from remote operation
• property SSHHostKey as %String;
• property SSHHostName as %String;
• property SSHPassPhrase as %String;
• property SSHPort as %Integer [ InitialExpression = 22 ];
• property SSHPrivateKeyFile as %String;
• property SSHPublicKeyFile as %String;
• property SSPort as %Integer;
• property SecurityType as %String [ InitialExpression = "Minimal" ];
• property Session as %Net.SSH.Session;
• property Sftp as %Net.SSH.SFTP;
• property Status as %Integer;
• property TempDir as %String [ InitialExpression = "/tmp/iris_install" ];
Temporary directory on the remote machine which we create, and the kit is unpacked to.
The instance name gets appended to this.
• property Unicode as %Boolean [ InitialExpression = 1 ];
• property Upgrade as %Boolean [ InitialExpression = 0 ];
• property Username as %String;
• property WSPort as %Integer;

Methods

• method AuthenticateWithKeyPair() as %Status
Authenticate with the remote server using a public/private key pair and passphrase (for the private key)
• method AuthenticateWithUsername() as %Status
Authenticate with the remote server using a username/password via the "password" authentication scheme. Note that this is NOT the same as keyboard-interactive which is typically what login sessions use.
• method EMGetGUID(Output GUID As %String) as %Status
• method EMManage(CredentialAlias As %String, CAfile As %String, Certfile As %String, Keyfile As %String, cachegrp As %String = "irisusr", Pass As %String, Host As %String, Port As %Integer, Prefix As %String = "", Description As %String = "") as %Status
Sends an Apply for Management request on behalf of the instance to the specified EM Server.
An X509 Credential alias, and location of X509 Certificates are passed. An X509 Credential corresponding to the Alias is created if it does not already exist.
The EM Manager host, port number, and prefix are used to contact the EM Server.
CredentialAlias - Credential alias to be used.
CAfile - Certificate Authority X.509 certificate file (should also be in the /mgr directory of the instance).
Certfile - Client certificate file.
Keyfile - Client certificate key file.
cachegrp - group owner for the files on target system.
Pass - Client certificate password (if any).
Host - EM host name or IP address.
Port - EM Webserver port number.
Prefix - EM instance URLPrefix (if any).
Description (optional) - User text to describe the Apply for Management request on the EM Server.
• method EMManagePass(Host As %String, Port As %Integer, Prefix As %String = "", Description As %String = "") as %Status
Sends an Apply for Management request on behalf of the instance to the specified EM Server based on password policy.
Host - EM host name or IP address.
Port - EM Webserver port number.
Prefix - EM instance URLPrefix (if any).
Description (optional) - User text to describe the Apply for Management request on the EM Server.
• method EMRemove() as %Status
Sends an Apply for Management request on behalf of the instance to the specified EM Server.
An X509 Credential alias, and location of X509 Certificates are passed. An X509 Credential corresponding to the Alias is created if it does not already exist.
The EM Manager host, port number, and prefix are used to contact the EM Server.
CredentialAlias - Credential alias to be used.
CAfile - Certificate Authority X.509 certificate file (should also be in the /mgr directory of the instance).
Certfile - Client certificate file.
Keyfile - Client certificate key file.
cachegrp - group owner for the files on target system.
Pass - Client certificate password (if any).
Host - EM host name or IP address.
Port - EM Webserver port number.
Prefix - EM instance URLPrefix (if any).
Description (optional) - User text to describe the Apply for Management request on the EM Server.
• method ManageCache(instancename As %String = "", command As %String = "stop", options As %String = "", ByRef Status As %String) as %Status
• method Provision() as %Status
Provision the target machine.
User must have sudo privilege on target machine.
cachekitfile - tar file for the cache installation kit.
cachekey (optional) - cache key file.
manifest (optional) - user install manifest file.
At the end, the tarfile has been expanded and is ready for install.
• method Status(ByRef Properties As %String, ByRef Response As %String) as %Status
Get status of a InterSystems IRIS instance. Response is one of the following: LongForm = 0 - APPDEV1/home/appdev1^2016.1.0.513.0^running, since Fri Jul 24 10:29:04 2015^cache.cpf^1972^57772^62972^ok^
LongForm = 1 -
Configuration 'APPDEV1' (default)
directory: /home/appdev1
versionid: 2016.1.0.513.0
conf file: cache.cpf (SuperServer port = 1972, WebServer = 57772)
status: running, since Fri Jul 24 10:29:04 2015
state: ok
If the instance doesn't exist, then - iris: instance 'APPDEV1' not found


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.