com.morpheusdata.core

Interface MorpheusContext

public interface MorpheusContext

Provides a means to interact or query data from the main Morpheus application back into the various provider extensions It is important to note that most methods in the context are asynchronous and rely on RxJava based interfaces so as to present the ability for the implementation of the MorpheusContext to be disconnected from the core application. The MorpheusContext typically provides getters for multiple subcontexts. These Sub Context interfaces are useful for organizing calls so as to reduce the size of the individual Context Class (i.e. a Connector app could implement the MorpheusContext and relay communication back to the Morpheus Application itself)

See Also:

MorpheusComputeContext, MorpheusNetworkContext, MorpheusTaskContext

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<TaskConfig>	buildComputeServerConfig(ComputeServer container, java.util.Map baseConfig, Task task, java.util.Collection excludes, java.util.Map opts)
io.reactivex.Single<TaskConfig>	buildContainerConfig(Container container, java.util.Map baseConfig, Task task, java.util.Collection excludes, java.util.Map opts)
io.reactivex.Single<TaskConfig>	buildInstanceConfig(Instance instance, java.util.Map baseConfig, Task task, java.util.Collection excludes, java.util.Map opts)
io.reactivex.Single<TaskResult>	executeCommandOnServer(ComputeServer server, java.lang.String command) Execute a command on a server using the default connection details
io.reactivex.Single<TaskResult>	executeCommandOnServer(ComputeServer server, java.lang.String command, java.lang.Boolean rpc, java.lang.String sshUsername, java.lang.String sshPassword, java.lang.String publicKey, java.lang.String privateKey, java.lang.String passPhrase, java.lang.Boolean noProfile, java.lang.Boolean sudo) Execute a command on a server using custom connection details
io.reactivex.Single<TaskResult>	executeCommandOnWorkload(Container container, java.lang.String command) Execute a command on a Container or VM using the standard connection details
io.reactivex.Single<TaskResult>	executeCommandOnWorkload(Container container, java.lang.String command, java.lang.String sshUsername, java.lang.String sshPassword, java.lang.String publicKey, java.lang.String privateKey, java.lang.String passPhrase, java.lang.Boolean noProfile, java.lang.String runAsUser, java.lang.Boolean sudo) Execute a command on a Container or VM using custom connection details
io.reactivex.Single<TaskResult>	executeSshCommand(java.lang.String address, java.lang.Integer port, java.lang.String username, java.lang.String password, java.lang.String command, java.lang.String publicKey, java.lang.String privateKey, java.lang.String passPhrase, java.lang.Boolean ignoreExitStatus, LogLevel logLevel, java.lang.Boolean doPty, java.lang.String runAsUser, java.lang.Boolean sudo) Execute an ssh command
io.reactivex.Single<TaskResult>	executeWindowsCommand(java.lang.String address, java.lang.Integer port, java.lang.String username, java.lang.String password, java.lang.String command, java.lang.Boolean noProfile, java.lang.Boolean elevated) Execute a command on a Windows machine
MorpheusComputeContext	getCompute() Returns the Compute Context used for performing updates or queries on compute related assets within Morpheus
MorpheusNetworkContext	getNetwork() Returns the NetworkContext used for performing updates or queries on network related assets within Morpheus.
MorpheusTaskContext	getTask() Returns the Task context used for automation tasks on assets within Morpheus.

Method Detail

getCompute

MorpheusComputeContext getCompute()

Returns the Compute Context used for performing updates or queries on compute related assets within Morpheus

Returns:

An Instance of the Compute Context to be used typically by CloudProvider implementations.

getNetwork

MorpheusNetworkContext getNetwork()

Returns the NetworkContext used for performing updates or queries on network related assets within Morpheus. Typically this would be called by a DNSProvider or IPAMProvider.

Returns:

An Instance of the Network Context to be used for calls by various network providers

getTask

MorpheusTaskContext getTask()

Returns the Task context used for automation tasks on assets within Morpheus. Typically this would be called by a TaskProvider.

Returns:

An Instance of the Task Context to be used for calls by various task providers

executeSshCommand

io.reactivex.Single<TaskResult> executeSshCommand(java.lang.String address,
                                                  java.lang.Integer port,
                                                  java.lang.String username,
                                                  java.lang.String password,
                                                  java.lang.String command,
                                                  java.lang.String publicKey,
                                                  java.lang.String privateKey,
                                                  java.lang.String passPhrase,
                                                  java.lang.Boolean ignoreExitStatus,
                                                  LogLevel logLevel,
                                                  java.lang.Boolean doPty,
                                                  java.lang.String runAsUser,
                                                  java.lang.Boolean sudo)

Execute an ssh command

Parameters:

address - internet address

port - port number

username - ssh username

password - ssh password

command - the command to be executed

publicKey - public key as a String

privateKey - private key as a string

passPhrase - passphrase for privateKey

ignoreExitStatus - defaults to false. When enabled, marks the command execution as successful, regardless of exit code

logLevel - defaults to LogLevel debug

doPty - Allocate a Pseudo-Terminal

runAsUser - specify a user to run the command as

sudo - execute the command with sudo permissions

Returns:

A result object detailing the command execution

executeWindowsCommand

io.reactivex.Single<TaskResult> executeWindowsCommand(java.lang.String address,
                                                      java.lang.Integer port,
                                                      java.lang.String username,
                                                      java.lang.String password,
                                                      java.lang.String command,
                                                      java.lang.Boolean noProfile,
                                                      java.lang.Boolean elevated)

Execute a command on a Windows machine

Parameters:

address - internet address

port - port number

username - connection username

password - connection password

command - the command to be executed

noProfile - add a –noprofile argument to PowerShell

elevated - use elevated privileges

Returns:

A result object detailing the command execution

executeCommandOnWorkload

io.reactivex.Single<TaskResult> executeCommandOnWorkload(Container container,
                                                         java.lang.String command)

Execute a command on a Container or VM using the standard connection details

Parameters:

container - resource to execute on which to execute the command

command - the command to be executed

Returns:

A result object detailing the command execution

executeCommandOnWorkload

io.reactivex.Single<TaskResult> executeCommandOnWorkload(Container container,
                                                         java.lang.String command,
                                                         java.lang.String sshUsername,
                                                         java.lang.String sshPassword,
                                                         java.lang.String publicKey,
                                                         java.lang.String privateKey,
                                                         java.lang.String passPhrase,
                                                         java.lang.Boolean noProfile,
                                                         java.lang.String runAsUser,
                                                         java.lang.Boolean sudo)

Execute a command on a Container or VM using custom connection details

Parameters:

container - resource to execute on which to execute the command

command - the command to be executed

sshUsername - username

sshPassword - password

publicKey - public key as a String

privateKey - private key as a String

passPhrase - passphrase for privateKey

noProfile - for Windows VMs, add a –noprofile argument to PowerShell

runAsUser - run the command as a specific user

sudo - execute the command with sudo permissions

Returns:

A result object detailing the command execution

executeCommandOnServer

io.reactivex.Single<TaskResult> executeCommandOnServer(ComputeServer server,
                                                       java.lang.String command)

Execute a command on a server using the default connection details

Parameters:

server - server on which to execute the command

command - the command to be executed

Returns:

A result object detailing the command execution

executeCommandOnServer

io.reactivex.Single<TaskResult> executeCommandOnServer(ComputeServer server,
                                                       java.lang.String command,
                                                       java.lang.Boolean rpc,
                                                       java.lang.String sshUsername,
                                                       java.lang.String sshPassword,
                                                       java.lang.String publicKey,
                                                       java.lang.String privateKey,
                                                       java.lang.String passPhrase,
                                                       java.lang.Boolean noProfile,
                                                       java.lang.Boolean sudo)

Execute a command on a server using custom connection details

Parameters:

server - server on which to execute the command

command - the command to be executed

rpc - when enabled, override the agent mode and execute over ssh/winrm

sshUsername - username

sshPassword - password

publicKey - public key as a String

privateKey - private key as a String

passPhrase - passphrase for privateKey

noProfile - for Windows VMs, add a –noprofile argument to PowerShell

sudo - execute the command with sudo permissions

Returns:

A result object detailing the command execution

buildInstanceConfig

io.reactivex.Single<TaskConfig> buildInstanceConfig(Instance instance,
                                                    java.util.Map baseConfig,
                                                    Task task,
                                                    java.util.Collection excludes,
                                                    java.util.Map opts)

buildContainerConfig

io.reactivex.Single<TaskConfig> buildContainerConfig(Container container,
                                                     java.util.Map baseConfig,
                                                     Task task,
                                                     java.util.Collection excludes,
                                                     java.util.Map opts)

buildComputeServerConfig

io.reactivex.Single<TaskConfig> buildComputeServerConfig(ComputeServer container,
                                                         java.util.Map baseConfig,
                                                         Task task,
                                                         java.util.Collection excludes,
                                                         java.util.Map opts)