Skip to content

Asset

An asset is a structure used to track a computer upon which situate can operate. An Asset has an ID that is used to uniquely identify it and a name that is used to as a conventient display name. It also has other data that can be used to identfy the operating system and version as well as other interesting pieces of information.

Static Methods

getAsset(id) → Asset

Returns the asset matching the given asset id.

Returns: Asset - The Asset or null if the asset is not found.

Parameters:

ParameterTypeDescription
idStringThe id of the agent to search for.

getAssetByName(name) → Array

Returns the all the assets matching the given name.

Returns: Array - An array of Asset objects whose name matches the asset name provided.

Parameters:

ParameterTypeDescription
nameStringThe name of the asset to search for.

getAllAssetIds() → Array

Returns an array containing all of asset ids.

Returns: Array - An array of String.

Instance Methods

getPubkey() → String

Returns the public key used to communicate with this asset.

Returns: String - The public key.

getName() → String

Returns the display name of this asset

Returns: String - The display name.

getHostname() → String

Returns the host name of this asset

Returns: String - The host name.

getSysname() → String

Returns the sysname of this asset. The sysname is the value of "uname -s" on Unix or "Windows" for windows.

Returns: String - The sysname.

getRelease() → String

Returns OS release. This will be "uname -r" on Unix boxes and the build and patch level on Windows boxes.

Returns: String - The release.

getVersion() → String

Returns the version of the operating system.

Returns: String - The OS version

getMachine() → String

Returns the architecture type of this asset. This will be something like x86_64 or i686.

Returns: String - The OS machine name.

getDistro() → String

Returns the Distribution name for this asset. On Linux, this will be the specific linux distribution name. On Windows this may be a value like "Windows 2003 R2".

Returns: String - The distro name.

getAgentVersion() → String

Returns the version of the situate agent running on this asset.

Returns: String - The agent version.

getAuth() → Array

Returns list of authentication services supported by the asset.

Returns: Array - An Array of String.

getIpAddress() → String

Returns the IP address the asset used to connect.

Returns: String - The IP address.

isMasq() → bool

Returns true if the asset is configured as a "call home" asset.

Returns: bool - true if the asset is a "call home" asset.

getId() → String

Returns the ID of the asset.

Returns: String - The ID.

getAgentId() → String

Returns the ID of the Asset. This represents a unique ID stored on the computer and is not the same as the asset id returned by getId().

Returns: String - The ID of the agent.

Workload Automation and Orchestration