org.jclouds.compute.domain

Interface NodeMetadata

All Superinterfaces:

Comparable<ResourceMetadata<ComputeType>>, ComputeMetadata, ResourceMetadata<ComputeType>

All Known Implementing Classes:

NodeMetadataImpl

public interface NodeMetadata
extends ComputeMetadata

Author:

Adrian Cole, Ivan Meredith

Method Summary

Methods

Modifier and Type	Method and Description
String	getAdminPassword() Deprecated.
LoginCredentials	getCredentials() If possible, these are returned upon all detail requests.
String	getGroup() Tag used for all resources that belong to the same logical group.
Hardware	getHardware() The hardware this node is running, if possible to determine.
String	getHostname() note
String	getImageId() The id of the image this node was created from, if possible to correlate.
int	getLoginPort()
OperatingSystem	getOperatingSystem() The operating system this node is running, if possible to determine.
Set<String>	getPrivateAddresses() All private IP addresses.
Set<String>	getPublicAddresses() All public IP addresses, potentially including shared ips.
NodeState	getState() Current State of the node

Methods inherited from interface org.jclouds.compute.domain.ComputeMetadata

getId, getName, getProviderId, getTags, getType

Methods inherited from interface org.jclouds.domain.ResourceMetadata

getLocation, getUri, getUserMetadata

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getHostname

@Nullable
String getHostname()

note

hostname is something that is set in the operating system image, so this value, if present, cannot be guaranteed on images not directly controlled by the cloud provider.

Returns:

hostname of the node, or null if unknown

getGroup

@Nullable
String getGroup()

Tag used for all resources that belong to the same logical group. run, destroy commands are scoped to group.

Returns:

group for this node, or null, if not a part of a group

getHardware

@Nullable
Hardware getHardware()

The hardware this node is running, if possible to determine.

getImageId

@Nullable
String getImageId()

The id of the image this node was created from, if possible to correlate.

getOperatingSystem

@Nullable
OperatingSystem getOperatingSystem()

The operating system this node is running, if possible to determine.

getState

NodeState getState()

Current State of the node

getLoginPort

int getLoginPort()

Returns:

the TCP port used for terminal connections. Generally, this is port 22 for ssh.

getAdminPassword

@Nullable
@Deprecated
String getAdminPassword()

Deprecated.

will be removed in jclouds 1.4.0

secures access to root with a password. This password is required to access either the console or run sudo as root.

ex. echo 'password' |sudo -S command

Returns:

root or console password, if configured, or null.

See Also:

LoginCredentials.shouldAuthenticateSudo()

getCredentials

LoginCredentials getCredentials()

If possible, these are returned upon all detail requests. However, it is often the case that credentials are only available at "run" time.

getPublicAddresses

Set<String> getPublicAddresses()

All public IP addresses, potentially including shared ips.

getPrivateAddresses

Set<String> getPrivateAddresses()

All private IP addresses.