com.emc.storageos.model.ports

Class StoragePortRestRep

java.lang.Object

com.emc.storageos.model.DataObjectRestRep

com.emc.storageos.model.DiscoveredDataObjectRestRep

com.emc.storageos.model.varray.VirtualArrayResourceRestRep

com.emc.storageos.model.ports.StoragePortRestRep

public class StoragePortRestRep
extends VirtualArrayResourceRestRep

Constructor Summary

Constructors

Constructor and Description
StoragePortRestRep()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAdapterName() The adapter name of the Storage Port
java.lang.Boolean	getAllocationDisqualified() True if at least one of the port metrics is above its limit value.
java.lang.Double	getAllocationMetric() The metric for the Storage Port Allocator.
java.lang.Long	getAvgBandwidth() The average bandwidth through the port (Gbps)
java.lang.String	getCompatibilityStatus() Whether or not this storage port is compatible with ViPR Valid values: COMPATIBLE INCOMPATIBLE UNKNOWN
java.lang.Double	getCpuPercentBusy() The number of non-idle ticks for the cpu that is hosting the port versus the total number of possible ticks.
java.lang.String	getDiscoveryStatus() Whether or not this storage pool is visible in discovery Valid values: VISIBLE NOTVISIBLE
java.lang.Long	getInitiatorLoad() The number of Initiators known by ViPR to be mapped to this port.
java.lang.String	getIpAddress() The port's IP address (for IP-based transport)
RelatedResourceRep	getNetwork() The ViPR network that connects to this port
java.lang.String	getOperationalStatus() The operational status of the port Valid values: OK NOT_OK UNKNOWN
java.lang.String	getPortAlias() The alias represents port's wwn id
java.lang.String	getPortEndPointId() ID of the endpoint with which this port is associated.
java.lang.String	getPortGroup() The name of this port's group.
java.lang.String	getPortName() The native name of the port.
java.lang.String	getPortNetworkId() The network address of the port.
java.lang.Double	getPortPercentBusy() The port percent busy as computed by the kbytes transferred per a given unit of time versus the maximum number of kbytes that could be transferred as computed from the port speed.
java.lang.Long	getPortSpeed() The port's clock speed (Gbps)
java.lang.String	getPortType() How the port connects its storage controller to its network Valid values: backend = connects a VPLEX storage controller to another array frontend = connects the storage controller to the hosts
java.lang.String	getRegistrationStatus() Whether or not this port is registered with ViPR.
java.lang.Long	getStaticLoad() The number of exports on the storage port
RelatedResourceRep	getStorageDevice() The storage system that hosts this port
java.lang.Long	getTcpPortNumber() The port's TCP port number (for IP-based transport)
java.lang.String	getTransportType() The protocol that this port uses to transport disk commands and responses across its network Valid values: FC IP
java.lang.Long	getVolumeLoad() The number of Volumes known by ViPR to be accessible via this port.
void	setAdapterName(java.lang.String adapterName)
void	setAllocationDisqualified(java.lang.Boolean allocationDisqualified)
void	setAllocationMetric(java.lang.Double allocationMetric)
void	setAvgBandwidth(java.lang.Long avgBandwidth)
void	setCompatibilityStatus(java.lang.String compatibilityStatus)
void	setCpuPercentBusy(java.lang.Double cpuPercentBusy)
void	setDiscoveryStatus(java.lang.String discoveryStatus)
void	setInitiatorLoad(java.lang.Long initiatorLoad)
void	setIpAddress(java.lang.String ipAddress)
void	setNetwork(RelatedResourceRep network)
void	setOperationalStatus(java.lang.String operationalStatus)
void	setPortAlias(java.lang.String portAlias)
void	setPortEndPointId(java.lang.String portEndPointId)
void	setPortGroup(java.lang.String portGroup)
void	setPortName(java.lang.String portName)
void	setPortNetworkId(java.lang.String portNetworkId)
void	setPortPercentBusy(java.lang.Double portPercentBusy)
void	setPortSpeed(java.lang.Long portSpeed)
void	setPortType(java.lang.String portType)
void	setRegistrationStatus(java.lang.String registrationStatus)
void	setStaticLoad(java.lang.Long staticLoad)
void	setStorageDevice(RelatedResourceRep storageDevice)
void	setTcpPortNumber(java.lang.Long tcpPortNumber)
void	setTransportType(java.lang.String transportType)
void	setVolumeLoad(java.lang.Long volumeLoad)

Methods inherited from class com.emc.storageos.model.varray.VirtualArrayResourceRestRep

getAssignedVirtualArrays, getConnectedVirtualArrays, getTaggedVirtualArrays, setAssignedVirtualArrays, setConnectedVirtualArrays, setTaggedVirtualArrays

Methods inherited from class com.emc.storageos.model.DiscoveredDataObjectRestRep

getNativeGuid, setNativeGuid

Methods inherited from class com.emc.storageos.model.DataObjectRestRep

getCreationTime, getGlobal, getId, getInactive, getInternal, getLink, getName, getRemote, getTags, getVdc, setCreationTime, setGlobal, setId, setInactive, setInternal, setLink, setName, setRemote, setTags, setVdc, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

StoragePortRestRep

public StoragePortRestRep()

Method Detail

getAdapterName

public java.lang.String getAdapterName()

The adapter name of the Storage Port

Returns:

Adapter name of Storage Port

setAdapterName

public void setAdapterName(java.lang.String adapterName)

getAvgBandwidth

public java.lang.Long getAvgBandwidth()

The average bandwidth through the port (Gbps)

setAvgBandwidth

public void setAvgBandwidth(java.lang.Long avgBandwidth)

getIpAddress

public java.lang.String getIpAddress()

The port's IP address (for IP-based transport)

setIpAddress

public void setIpAddress(java.lang.String ipAddress)

getPortEndPointId

public java.lang.String getPortEndPointId()

ID of the endpoint with which this port is associated.

setPortEndPointId

public void setPortEndPointId(java.lang.String portEndPointId)

getPortGroup

public java.lang.String getPortGroup()

The name of this port's group. A port group is a mapping that is configured on a storage system between a collection of ports, a collection of volumes and a collection of hosts that use those volumes. This name is what the storage system uses to identify the port group. mapped known by Vipr to this port

setPortGroup

public void setPortGroup(java.lang.String portGroup)

getPortName

public java.lang.String getPortName()

The native name of the port. This name consists of identifiers that are used by the hosting storage system. It may also follow a naming convention that is in common use for that make and model of storage system.

setPortName

public void setPortName(java.lang.String portName)

getPortAlias

public java.lang.String getPortAlias()

The alias represents port's wwn id

setPortAlias

public void setPortAlias(java.lang.String portAlias)

getPortNetworkId

public java.lang.String getPortNetworkId()

The network address of the port. When Fibre-Channel (FC) is the transport protocol, the address is a World Wide Name (WWN). If the port is using an IP-based protocol, this is an IP address, or name of the port that a storage system uses to identify the port.

setPortNetworkId

public void setPortNetworkId(java.lang.String portNetworkId)

getPortSpeed

public java.lang.Long getPortSpeed()

The port's clock speed (Gbps)

setPortSpeed

public void setPortSpeed(java.lang.Long portSpeed)

getPortType

public java.lang.String getPortType()

How the port connects its storage controller to its network Valid values: backend = connects a VPLEX storage controller to another array frontend = connects the storage controller to the hosts

setPortType

public void setPortType(java.lang.String portType)

getStaticLoad

public java.lang.Long getStaticLoad()

The number of exports on the storage port

setStaticLoad

public void setStaticLoad(java.lang.Long staticLoad)

getStorageDevice

public RelatedResourceRep getStorageDevice()

The storage system that hosts this port

setStorageDevice

public void setStorageDevice(RelatedResourceRep storageDevice)

getTcpPortNumber

public java.lang.Long getTcpPortNumber()

The port's TCP port number (for IP-based transport)

setTcpPortNumber

public void setTcpPortNumber(java.lang.Long tcpPortNumber)

getTransportType

public java.lang.String getTransportType()

The protocol that this port uses to transport disk commands and responses across its network Valid values: FC IP

setTransportType

public void setTransportType(java.lang.String transportType)

getNetwork

public RelatedResourceRep getNetwork()

The ViPR network that connects to this port

setNetwork

public void setNetwork(RelatedResourceRep network)

getRegistrationStatus

public java.lang.String getRegistrationStatus()

Whether or not this port is registered with ViPR. A port must be registered before it can be managed by ViPR. Valid values: REGISTERED UNREGISTERED

setRegistrationStatus

public void setRegistrationStatus(java.lang.String registrationStatus)

getOperationalStatus

public java.lang.String getOperationalStatus()

The operational status of the port Valid values: OK NOT_OK UNKNOWN

setOperationalStatus

public void setOperationalStatus(java.lang.String operationalStatus)

getCompatibilityStatus

public java.lang.String getCompatibilityStatus()

Whether or not this storage port is compatible with ViPR Valid values: COMPATIBLE INCOMPATIBLE UNKNOWN

setCompatibilityStatus

public void setCompatibilityStatus(java.lang.String compatibilityStatus)

getAllocationMetric

public java.lang.Double getAllocationMetric()

The metric for the Storage Port Allocator. Lower metric numbers are preferred over higher metric numbers for allocation.

setAllocationMetric

public void setAllocationMetric(java.lang.Double allocationMetric)

getPortPercentBusy

public java.lang.Double getPortPercentBusy()

The port percent busy as computed by the kbytes transferred per a given unit of time versus the maximum number of kbytes that could be transferred as computed from the port speed.

setPortPercentBusy

public void setPortPercentBusy(java.lang.Double portPercentBusy)

getCpuPercentBusy

public java.lang.Double getCpuPercentBusy()

The number of non-idle ticks for the cpu that is hosting the port versus the total number of possible ticks.

setCpuPercentBusy

public void setCpuPercentBusy(java.lang.Double cpuPercentBusy)

getInitiatorLoad

public java.lang.Long getInitiatorLoad()

The number of Initiators known by ViPR to be mapped to this port.

setInitiatorLoad

public void setInitiatorLoad(java.lang.Long initiatorLoad)

getVolumeLoad

public java.lang.Long getVolumeLoad()

The number of Volumes known by ViPR to be accessible via this port.

setVolumeLoad

public void setVolumeLoad(java.lang.Long volumeLoad)

getAllocationDisqualified

public java.lang.Boolean getAllocationDisqualified()

True if at least one of the port metrics is above its limit value. This will prevent allocation of the port.

setAllocationDisqualified

public void setAllocationDisqualified(java.lang.Boolean allocationDisqualified)

getDiscoveryStatus

public java.lang.String getDiscoveryStatus()

Whether or not this storage pool is visible in discovery Valid values: VISIBLE NOTVISIBLE

setDiscoveryStatus

public void setDiscoveryStatus(java.lang.String discoveryStatus)