def findNics(self, device=None): \
# pylint: disable=no-self-use,unused-argument
"""
Return a list of nics and dict containing properties for those nics
"""
raise AbstractMethod(
'findNics() has to be implemented in the concrete API class.')
def getSoftwareProfileList(self, tags=None): \
# pylint: disable=no-self-use,unused-argument
"""
Returns a list of all SoftwareProfile's in the system.
"""
raise AbstractMethod('getSoftwareProfileList has to be implemented'
' in the concrete API class.')
def rmPXEFile(self, nodename): \
# pylint: disable=no-self-use,unused-argument
"""
Clean up existing PXE configuration
"""
raise AbstractMethod(
'rmPXEFile() must be overriden in the derived class.')
def getTarCommand(self): \
# pylint: disable=no-self-use
"""
Return the GNU tar command.
"""
raise AbstractMethod(
'getTarCommand() must be implemented in the base class')
def getOsLockFilePath(self): \
# pylint: disable=no-self-use
"""
Returns global default for lock files
"""
raise AbstractMethod('getOsLockFilePath() has to be implemented'
' in the concrete API class.')
def getSudoInitScript(self): \
# pylint: disable=no-self-use,unused-argument
"""
Return script that initializes equivalent of the sudo command for
the given OS
"""
raise AbstractMethod('getSudoInitScript() must be implemented')
def activateNode(self, nodeName, softwareProfileName): \
# pylint: disable=unused-argument,no-self-use
"""activate node
Returns software profile name
"""
raise AbstractMethod('activateNode must be implemented in API class')
def getHardwareProfileList(self, optionDict=None, tags=None): \
# pylint: disable=no-self-use,unused-argument
"""
Return list of hardware profiles
"""
raise AbstractMethod('getHardwareProfileList has to be implemented'
' in the concrete API class.')
def getDbSystemServiceName(self): \
# pylint: disable=no-self-use
"""
Returns the mysql service name
"""
raise AbstractMethod(
'getMysqlServiceName() has to be implemented in the concrete'
' API class.')
def get_cloud_config(self, node, hardwareprofile, softwareprofile): \
# pylint: disable=no-self-use,unused-argument
"""
Get cloud-init compatible cloud config for node
"""
raise AbstractMethod(
'get_cloud_config() must be overridden in the derived class.')
def getKickstartFile(self,
node,
hardwareprofile=None,
softwareprofile=None): \
# pylint: disable=unused-argument,no-self-use
""" Get the kickstart file for a given node """
raise AbstractMethod(
'getKickstartFile must be implemented in API class')
def transferNodes(self,
srcSoftwareProfile,
dstSoftwareProfile,
count,
bForce=False): \
# pylint: disable=unused-argument,no-self-use
""" Returns the nodes that were transfered """
raise AbstractMethod('transferNodes must be implemented in API class')
def addVolume(self,
storageAdapter,
size,
nameFormat='*',
persistent=False): \
# pylint: disable=no-self-use,unused-argument
raise AbstractMethod('addVolume() must be implemented in the'
' concrete API class')
def writePXEFile(self,
node,
localboot=None,
hardwareProfile=None,
softwareProfile=None): \
# pylint: disable=no-self-use,unused-argument
raise AbstractMethod(
'writePXEFile() must be overriden in the derived class.')
def getNetworkInterfaces(self): \
# pylint: disable=no-self-use
"""
Return list of network interfaces on installer as reported by
"facter interfaces"
"""
raise AbstractMethod(
'getNetworkInterfaces has to be implemented in the concrete'
' API class.')
def getUsableNodes(self, softwareProfileName): \
# pylint: disable=no-self-use,unused-argument
"""
Returns list of nodes with the same hardware profile as the
specified software profile name
"""
raise AbstractMethod(
'getUsableNodes() has to be implemented in the concrete API'
' class.')
def hasRule(self, ruleId):
"""
Does engine know about the given rule.
Returns:
True if rule is known, False otherwise.
Throws:
None
"""
raise AbstractMethod('hasRule() has to be implemented in the'
' concrete API class.')
def getPackageSourceNames(self): \
# pylint: disable=no-self-use
"""
Get list of package source names.
Returns:
[packageSourceNames]
"""
raise AbstractMethod(
'getPackageSourceNames() has to be implemented in the concrete'
' API class.')
def setIdleState(self, softwareProfileName, state): \
# pylint: disable=no-self-use,unused-argument
"""
Set the idle software profile state
Returns:
-none-
Throws:
TortugaException
"""
raise AbstractMethod('setIdleState has to be implemented in the'
' concrete API class.')
def getSoftwareProfile(self, softwareProfileName, optionDict=None): \
# pylint: disable=no-self-use,unused-argument
"""
Get software profile information
Returns:
softwareProfile
Throws:
TortugaException
"""
raise AbstractMethod('getSoftwareProfile has to be implemented in'
' the concrete API class.')
def getRuleList(self): \
# pylint: disable=no-self-use
"""
Get rule list.
Returns:
[rules]
Throws:
TortugaException
"""
raise AbstractMethod('getRuleList() has to be implemented in the'
' concrete API class.')
def receiveApplicationData(self, applicationName, applicationData):
"""
Receive (and process) application monitoring data.
Returns:
None
Throws:
UserNotAuthorized
TortugaException
"""
raise AbstractMethod('receiveApplicationData() has to be'
' implemented in the concrete API class.')
def getRuleList(self):
"""
Get all known rules.
Returns:
[rule]
Throws:
UserNotAuthorized
TortugaException
"""
raise AbstractMethod('getRuleList() has to be implemented in the'
' concrete API class.')
def getServiceName(self): \
# pylint: disable=no-self-use
"""
Get service name.
Returns:
Service name
Throws:
None
"""
raise AbstractMethod(
'getServiceName() has to be implemented in the derived class.')
def getNodeList(self, tags=None): \
# pylint: disable=no-self-use,unused-argument
"""
Get the list of nodes
Returns:
List of nodes.
Throws:
TortugaException
"""
raise AbstractMethod(
'getNodeList has to be implemented in the concrete API class.')
def getIdleSoftwareProfileList(self): \
# pylint: disable=no-self-use,unused-argument
"""
Get the list of idle software profiles
Returns:
The list of idle softwareprofiles
Throws:
TortugaException
"""
raise AbstractMethod('getIdleSoftwareProfileList has to be'
' implemented in the concrete API class.')
def hasRule(self, ruleId): \
# pylint: disable=no-self-use,unused-argument
"""
Does engine know about the given rule.
Returns:
True if rule is known, False otherwise.
Throws:
None
"""
raise AbstractMethod('hasRule() has to be implemented in the'
' concrete API class.')
def deleteSoftwareProfile(self, softwareProfileName): \
# pylint: disable=no-self-use,unused-argument
"""
Delete software profile
Returns:
N/A
Throws:
TortugaException
"""
raise AbstractMethod('deleteSoftwareProfile has to be'
' implemented in the concrete API class.')
def getEnabledComponentList(self, softwareProfileName): \
# pylint: disable=no-self-use,unused-argument
"""
Get the list of enabled components
Returns:
The list of enabled components for a softwareprofile
Throws:
TortugaException
"""
raise AbstractMethod('getEnabledComponentList has to be'
' implemented in the concrete API class.')
def getConfigDir(self): \
# pylint: disable=no-self-use
"""
Get configuration directory.
Returns:
Configuration directory
Throws:
None
"""
raise AbstractMethod(
'getConfigDir() has to be implemented in the derived class.')