com.emc.esu.sysmgmt

Class SysMgmtApi

java.lang.Object

com.emc.esu.sysmgmt.SysMgmtApi

public class SysMgmtApi
extends java.lang.Object

Main Façade for the Atmos system management API.

Constructor Summary

Constructors

Constructor and Description
SysMgmtApi() Default constructor
SysMgmtApi(java.lang.String proto, java.lang.String host, int port, java.lang.String username, java.lang.String password) Constructs a new SysMgmtApi connection

Method Summary

Methods

Modifier and Type	Method and Description
static void	disableCertificateValidation() Many Atmos systems have self-signed certificates for their system admin consoles.
java.lang.String	getHost() Gets the current hostname
int	getPort() Gets the current connection port
java.lang.String	getPoxCookie()
java.lang.String	getProto() Returns the current connection protocol
GetUidResponse	getUidPox(java.lang.String subTenantName, java.lang.String uid)
java.lang.String	getUsername() Gets the current SysAdmin username
ListHostsResponse	listHosts(java.lang.String rmgName) Lists all of the hosts in the given RMG.
ListRmgResponse	listRmgs() Lists all of the RMGs in your cloud.
ListRmgResponsePox	listRmgsPox()
void	poxLogin()
void	poxLogin(java.lang.String tenantName, java.lang.String tenantAdmin, java.lang.String tenantAdminPassword)
void	setHost(java.lang.String host) Sets the hostname to connect to
void	setPassword(java.lang.String password) Sets the SysAdmin password to use.
void	setPort(int port)
void	setProto(java.lang.String proto) Sets the current connection protocol.
void	setUsername(java.lang.String username) Sets the SysAdmin username to connect with

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SysMgmtApi

public SysMgmtApi()

Default constructor

SysMgmtApi

public SysMgmtApi(java.lang.String proto,
          java.lang.String host,
          int port,
          java.lang.String username,
          java.lang.String password)

Constructs a new SysMgmtApi connection

Parameters:

proto - The protocol to use, generally "https"

host - The host to connect to. Can be any Atmos host.

port - The port to connect to. Generally 443 for https.

username - Your SysAdmin user.

password - Your SysAdmin password.

Method Detail

listRmgs

public ListRmgResponse listRmgs()

Lists all of the RMGs in your cloud.

Returns:

a ListRmgResponse

listRmgsPox

public ListRmgResponsePox listRmgsPox()
                               throws java.lang.Exception

Throws:

java.lang.Exception

listHosts

public ListHostsResponse listHosts(java.lang.String rmgName)

Lists all of the hosts in the given RMG.

Parameters:

rmgName - the name of the RMG to list

Returns:

a ListHostsResponse

getProto

public java.lang.String getProto()

Returns the current connection protocol

Returns:

the proto

setProto

public void setProto(java.lang.String proto)

Sets the current connection protocol.

Parameters:

proto - the proto to set

getHost

public java.lang.String getHost()

Gets the current hostname

Returns:

the host

setHost

public void setHost(java.lang.String host)

Sets the hostname to connect to

Parameters:

host - the host to set

getPort

public int getPort()

Gets the current connection port

Returns:

the port

setPort

public void setPort(int port)

Parameters:

port - the port to set

getUsername

public java.lang.String getUsername()

Gets the current SysAdmin username

Returns:

the username

setUsername

public void setUsername(java.lang.String username)

Sets the SysAdmin username to connect with

Parameters:

username - the username to set

setPassword

public void setPassword(java.lang.String password)

Sets the SysAdmin password to use.

Parameters:

password - the password to set

disableCertificateValidation

public static void disableCertificateValidation()
                                         throws java.security.NoSuchAlgorithmException,
                                                java.security.KeyManagementException

Many Atmos systems have self-signed certificates for their system admin consoles. If so, you will need to call this method to install a special certificate validator and hostname verifier so an Exception is not thrown when connecting to the server. NOTE currently, this installs a default verifier for ALL connections, even non-Atmos systems.

Throws:

java.security.NoSuchAlgorithmException

java.security.KeyManagementException

getPoxCookie

public java.lang.String getPoxCookie()

Returns:

the poxCookie

poxLogin

public void poxLogin(java.lang.String tenantName,
            java.lang.String tenantAdmin,
            java.lang.String tenantAdminPassword)
              throws java.io.IOException,
                     java.net.URISyntaxException

Throws:

java.io.IOException

java.net.URISyntaxException

poxLogin

public void poxLogin()
              throws java.io.IOException,
                     java.net.URISyntaxException

Throws:

java.io.IOException

java.net.URISyntaxException

getUidPox

public GetUidResponse getUidPox(java.lang.String subTenantName,
                       java.lang.String uid)
                         throws java.lang.Exception

Throws:

java.lang.Exception