com.emc.storageos.model.host

Class HostParam

java.lang.Object

com.emc.storageos.model.host.HostParam

Direct Known Subclasses:

HostCreateParam, HostUpdateParam

public abstract class HostParam
extends java.lang.Object

Captures POST/PUT data for a host.

Constructor Summary

Constructors

Constructor and Description
HostParam()

Method Summary

Modifier and Type	Method and Description
java.net.URI	getBootVolume()
java.net.URI	getCluster() The URI of the cluster if the host is in a cluster.
java.lang.Boolean	getDiscoverable() Gets the discoverable flag.
java.lang.String	getHostName() The short or fully qualified host name or IP address of the host management interface.
java.lang.String	getName() The user label for this host.
java.lang.String	getOsVersion() The operating system version of the host.
java.lang.String	getPassword() The password credential used to login to the host.
java.lang.Integer	getPortNumber() The integer port number of the host management interface.
java.net.URI	getProject() This field is currently not used.
java.net.URI	getTenant() The URI of the tenant owning the host.
java.lang.String	getType() The host type.
java.lang.String	getUserName() The user name used to log in to the host.
java.lang.Boolean	getUseSsl() The boolean flag that indicates if SSL should be used when communicating with the host.
java.net.URI	getVcenterDataCenter() The URI of a vCenter data center if the host is an ESX host in a data center.
void	setBootVolume(java.net.URI bootVolume)
void	setCluster(java.net.URI cluster)
void	setDiscoverable(java.lang.Boolean discoverable)
void	setHostName(java.lang.String hostName)
void	setName(java.lang.String name)
void	setOsVersion(java.lang.String osVersion)
void	setPassword(java.lang.String password)
void	setPortNumber(java.lang.Integer portNumber)
void	setProject(java.net.URI project)
void	setTenant(java.net.URI tenant)
void	setType(java.lang.String type)
void	setUserName(java.lang.String userName)
void	setUseSsl(java.lang.Boolean useSsl)
void	setVcenterDataCenter(java.net.URI vcenterDataCenter)

Methods inherited from class java.lang.Object

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

Constructor Detail

HostParam

public HostParam()

Method Detail

getType

public java.lang.String getType()

The host type. Valid values: Windows HPUX Linux Esx SUNVCS Other

setType

public void setType(java.lang.String type)

getHostName

@Endpoint(type=HOST)
public java.lang.String getHostName()

The short or fully qualified host name or IP address of the host management interface.

setHostName

public void setHostName(java.lang.String hostName)

getOsVersion

public java.lang.String getOsVersion()

The operating system version of the host.

setOsVersion

public void setOsVersion(java.lang.String osVersion)

getName

@Length(min=2,
        max=128)
public java.lang.String getName()

The user label for this host.

setName

public void setName(java.lang.String name)

getPortNumber

@Range(min=1L,
       max=65535L)
public java.lang.Integer getPortNumber()

The integer port number of the host management interface.

setPortNumber

public void setPortNumber(java.lang.Integer portNumber)

getUserName

public java.lang.String getUserName()

The user name used to log in to the host.

setUserName

public void setUserName(java.lang.String userName)

getPassword

public java.lang.String getPassword()

The password credential used to login to the host.

setPassword

public void setPassword(java.lang.String password)

getUseSsl

public java.lang.Boolean getUseSsl()

The boolean flag that indicates if SSL should be used when communicating with the host.

setUseSsl

public void setUseSsl(java.lang.Boolean useSsl)

getCluster

public java.net.URI getCluster()

The URI of the cluster if the host is in a cluster.

setCluster

public void setCluster(java.net.URI cluster)

getVcenterDataCenter

public java.net.URI getVcenterDataCenter()

The URI of a vCenter data center if the host is an ESX host in a data center.

setVcenterDataCenter

public void setVcenterDataCenter(java.net.URI vcenterDataCenter)

getProject

public java.net.URI getProject()

This field is currently not used. Any values passed into it will be ignored.

setProject

public void setProject(java.net.URI project)

getDiscoverable

public java.lang.Boolean getDiscoverable()

Gets the discoverable flag. Discoverable indicates if automatic discovery should be performed against this host. Defaults to true.

Returns:

true if automatic discovery is enabled, false if automatic discovery is disabled. default value is true

setDiscoverable

public void setDiscoverable(java.lang.Boolean discoverable)

getTenant

public java.net.URI getTenant()

The URI of the tenant owning the host.

setTenant

public void setTenant(java.net.URI tenant)

getBootVolume

public java.net.URI getBootVolume()

setBootVolume

public void setBootVolume(java.net.URI bootVolume)