Reference Guide

From UniCluster-UC5

activate-node 
Transfers the given idle node to the given active software profile.
add-admin 
Adds an administrative user to the Tortuga system.
add-admin-to-profile 
Associates an administrative user with a given hardware or software profile.
add-network 
Adds a network to the Tortuga system.
add-nodes 
Adds nodes to the system.
add-rule 
Adds a Tortuga Rule Engine rule to the Tortuga system.
add-volume 
Create a new SAN volume.
add-volume-to-node 
Add an existing SAN volume to a node.
boot-host 
Creates the PXE (Preboot eXecution Environment) configuration files for node booting.
build-image 
Builds the root filesystem for diskless and imaged nodes.
build-initrd 
Builds the initial ram-disk for booting diskless and imaged nodes.
cfmclient 
CFM (Cluster File Manager) client updater.
cfmsync 
Signals the nodes in the cluster to update their files and/or packages/components.
clear-idle-software-profile 
Removes an idle software profile association from a hardware profile.
copy-hardware-profile 
Copy an existing hardware profile.
copy-software-profile 
Copy an existing software profile.
create-hardware-profile 
Creates a new hardware profile from a template.
create-software-profile 
Creates a new software profile from a template.
delete-admin 
Deletes an administrative user from the Tortuga system.
delete-admin-from-profile 
Removes an administrative user from a given hardware or software profile.
delete-hardware-profile 
Removes a hardware profile from the Tortuga System.
delete-kit 
Removes an installed kit from the Tortuga system. All components from a kit must be disabled before the kit can be removed.
delete-network 
Removes a network from the Tortuga System.
delete-node 
Removes a node from the Tortuga System.
delete-profile-mapping 
Removes a profile mapping from the Tortuga System.
delete-rule 
Removes a rule from the Tortuga System.
delete-software-profile 
Removes a software profile from the Tortuga System.
delete-volume 
Delete a SAN volume from the system.
disable-component 
Disables a component that is currently associated with a software profile.
disable-rule 
Disable rule in the Tortuga Rule Engine.
driver-patch 
Updates an initrd image for a package-based install.
enable-component 
Enables a component on an existing software profile.
enable-rule 
Enable rule in the Tortuga Rule Engine.
execute-rule 
Execute rule in the Tortuga Rule Engine.
freeipmi 
Provides in-band and out-of-band IPMI (Intelligent Platform Management Interface) software based on the IPMI v1.5/2.0 specification.
genconfig 
Tortuga/UniCluster configuration file generator.
generate-nii-profile 
(Re)generate node/cluster information file
get-active-children 
Gets the list of active nodes associated with a given software profile.
get-admin 
Gets an adminstrative user from the Tortuga system.
get-admin-list 
Returns the list of administrative users configured in the system.
get-children 
Gets all nodes belonging to a given parent node.
get-component-list 
Returns the list of Tortuga components available in the system.
get-hardware-profile 
Displays details of a hardware profile.
get-hardware-profile-list 
Returns the list of hardware profiles configured in the system.
get-idle-children 
Gets the list of idle nodes associated with a given software profile.
get-idle-software-profiles 
Gets a list of available idle software profiles.
get-kit 
Gets details of a specific kit.
get-kit-list 
Returns the list of kits available in the system.
get-network 
Gets the details of a specific network.
get-network-list 
Returns the list of networks configured in the system.
get-node-list 
Gets the nodes associated with a given software profile that are in the given state.
get-nodes-in-software-profile 
Gets the nodes associated with a given software profile that are in the given state.
get-node-software-profile-id 
Gets the software profile ID of the given node.
get-node-software-profile-name 
Gets the software profile name of the given node.
get-node-status 
Gets the status of a node or all nodes.
get-nodes-with-component 
Gets the list of nodes that have the specified component enabled.
get-os-key-list 
Display license keys associated with operating systems.
get-rule 
Gets details of a Tortuga Rule Engine rule from the system.
get-rule-list 
Returns the list of rules configured in the system.
get-software-profile 
Displays details of a software profile.
get-software-profile-list 
Returns the list of software profiles configured in the system.
get-software-profile-nodes 
Gets a list of nodes for a given software profile.
get-usable-hardware-profile-list 
Display usable software to hardware profile mappings.
get-usable-hardware-profiles 
Shows the software to hardware profile mappings for the specified software profile.
get-volume-list 
Get the list of volumes in the SAN system optionally by associated node.
idle-node 
Transitions a node from the active state to the idle state.
imageedit 
Allows for creation of filesystem "overlays" for imaged and diskless nodes.
install-kit 
Adds a feature kit to the Tortuga system.
install-os-kit 
Adds an OS kit to the Tortuga system.
ipmitool 
Controls IPMI-enabled devices.
module 
Command interface to the Modules package.
post-add-host 
This tool is run after a node is added to trigger the execution of the add_host component hook.
post-application-data 
Post an XML file to the Tortuga Rule Engine.
remove-volume-from-node 
Remove a SAN volume mapping from a node.
pdsh 
Runs command in parallel on multiple nodes.
post-application-data 
Posts an XML file to the Tortuga Rule Engine.
repopatch 
Update an installed operating system kit.
remove-volume-from-node 
Remove a SAN volume mapping from a node.
retrieve-cfm-secret-file 
Retrieve the CFM secret file for the specified node.
schedule-update 
Schedule a cluster update.
set-idle-software-profile 
Sets the idle software profile for a given hardware profile.
set-idle-state 
Marks a software profile as idle or non-idle.
set-nic-device-order 
Modify the MAC<‐>NIC assignments of a node.
set-os-key 
Associate license key(s) with operating systems.
set-parent-node 
Sets the parent node for a given node.
set-profile-mapping 
Adjusts the software user's hardware profile mapping.
set-software-override-allowed 
Sets the software override allowed attribute on a given hardware profile.
set-virtual-container-software-profile 
Sets the virtual container software-profile attribute for a given hardware profile.
tortugarc 
Tortuga kit component action executer.
transfer-node 
Transfers nodes from one software profile to another.
transfer-unmanaged-node 
Transfers nodes to the "unmanaged" type.
unicluster-setup 
Creates initial UniCluster configuration.
update-admin 
Updates an existing administrative user in the Tortuga system.
update-hardware-profile 
Updates an existing hardware profile in the Tortuga system.
update-network 
Adds a network to the Tortuga system.
update-node-status 
Update a node’s status
update-software-profile 
Updates an existing software profile in the Tortuga system.
update-volume 
Update an existing SAN volume.

[ UniCluster Documentation ]