def saCkptCheckpointRead(checkpointHandle, ioVector, numberOfElements, erroneousVectorIndex): """Read data into ioVector from checkpoint associated with checkpointHandle. type arguments: SaCkptCheckpointHandleT checkpointHandle SaCkptIOVectorElementT* ioVector SaUint32T numberOfElements SaUint32T erroneousVectorIndex returns: SaAisErrorT """ ckptdll.saCkptCheckpointRead.argtypes = [ SaCkptCheckpointHandleT, POINTER(SaCkptIOVectorElementT), SaUint32T, POINTER(SaUint32T) ] ckptdll.saCkptCheckpointRead.restype = SaAisErrorT return ckptdll.saCkptCheckpointRead(checkpointHandle, BYREF(ioVector), numberOfElements, BYREF(erroneousVectorIndex))
def saAmfComponentErrorReport_4(amfHandle,
compName, errorDetectionTime, recommendedRecovery,
correlationIds):
"""Report error and provide recovery recommendation to AMF.
type arguments:
SaAmfHandleT amfHandle
SaNameT compName
SaTimeT errorDetectionTime
SaAmfRecommendedRecoveryT recommendedRecovery
SaNtfCorrelationIdsT correlationIds
returns:
SaAisErrorT
"""
amfdll.saAmfComponentErrorReport_4.argtypes = [SaAmfHandleT,
POINTER(SaNameT),
SaTimeT,
SaAmfRecommendedRecoveryT,
POINTER(SaNtfCorrelationIdsT)]
amfdll.saAmfComponentErrorReport_4.restype = SaAisErrorT
return amfdll.saAmfComponentErrorReport_4(amfHandle,
BYREF(compName),
errorDetectionTime,
recommendedRecovery,
BYREF(correlationIds))
def saAmfHealthcheckStart(amfHandle,
compName, healthcheckKey, invocationType,
recommendedRecovery):
"""Start AMF healthcheck for component.
type arguments:
SaAmfHandleT amfHandle
SaNameT compName
SaAmfHealthcheckKeyT healthcheckKey
SaAmfHealthcheckInvocationT invocationType
SaAmfRecommendedRecoveryT recommendedRecovery
returns:
SaAisErrorT
"""
amfdll.saAmfHealthcheckStart.argtypes = [SaAmfHandleT,
POINTER(SaNameT),
POINTER(SaAmfHealthcheckKeyT),
SaAmfHealthcheckInvocationT,
SaAmfRecommendedRecoveryT]
amfdll.saAmfHealthcheckStart.restype = SaAisErrorT
return amfdll.saAmfHealthcheckStart(amfHandle,
BYREF(compName), BYREF(healthcheckKey),
invocationType, recommendedRecovery)
def saAmfProtectionGroupTrack(amfHandle,
csiName, trackFlags, notificationBuffer):
"""Start AMF tracking changes for the protection group.
type arguments:
SaAmfHandleT amfHandle
SaNameT csiName
SaUint8T trackFlags
SaAmfProtectionGroupNotificationBufferT notificationBuffer
returns:
SaAisErrorT
"""
amfdll.saAmfProtectionGroupTrack.argtypes = [SaAmfHandleT,
POINTER(SaNameT),
SaUint8T,
POINTER(SaAmfProtectionGroupNotificationBufferT)]
amfdll.saAmfProtectionGroupTrack.restype = SaAisErrorT
return amfdll.saAmfProtectionGroupTrack(amfHandle,
BYREF(csiName), trackFlags,
BYREF(notificationBuffer))
def saAmfHAReadinessStateSet(amfHandle, compName, csiName, haReadinessState, correlationIds): """Set HA readiness state of pre-instantiable component for named CSI. type arguments: SaAmfHandleT amfHandle SaNameT compName SaNameT csiName SaAmfHAReadinessStateT haReadinessState SaNtfCorrelationIdsT correlationIds returns: SaAisErrorT """ amfdll.saAmfHAReadinessStateSet.argtypes = [SaAmfHandleT, POINTER(SaNameT), POINTER(SaNameT), SaAmfHAReadinessStateT, POINTER(SaNtfCorrelationIdsT)] amfdll.saAmfHAReadinessStateSet.restype = SaAisErrorT return amfdll.saAmfHAReadinessStateSet(amfHandle, BYREF(compName), BYREF(csiName), haReadinessState, BYREF(correlationIds))
def saAmfHealthcheckConfirm(amfHandle,
compName, healthcheckKey, healthcheckResult):
"""Confirm with AMF that component has performed healthcheck.
type arguments:
SaAmfHandleT amfHandle
SaNameT compName
SaAmfHealthcheckKeyT healthcheckKey
SaAisErrorT healthcheckResult
returns:
SaAisErrorT
"""
amfdll.saAmfHealthcheckConfirm.argtypes = [SaAmfHandleT,
POINTER(SaNameT),
POINTER(SaAmfHealthcheckKeyT),
SaAisErrorT]
amfdll.saAmfHealthcheckConfirm.restype = SaAisErrorT
return amfdll.saAmfHealthcheckConfirm(amfHandle,
BYREF(compName), BYREF(healthcheckKey),
healthcheckResult)
def saLogStreamOpen_2(logHandle, logStreamName, logFileCreateAttributes,
logStreamOpenFlags, timeout, logStreamHandle):
"""Open a log stream.
type arguments:
SaLogHandleT logHandle
SaNameT logStreamName
SaLogFileCreateAttributesT_2 logFileCreateAttributes
SaLogStreamOpenFlagsT logStreamOpenFlags
SaTimeT timeout
SaLogStreamHandleT logStreamHandle
returns:
SaAisErrorT
"""
logdll.saLogStreamOpen_2.argtypes = [
SaLogHandleT,
POINTER(SaNameT),
POINTER(SaLogFileCreateAttributesT_2), SaLogStreamOpenFlagsT, SaTimeT,
POINTER(SaLogStreamHandleT)
]
logdll.saLogStreamOpen_2.restype = SaAisErrorT
return logdll.saLogStreamOpen_2(logHandle, BYREF(logStreamName),
BYREF(logFileCreateAttributes),
logStreamOpenFlags, timeout,
BYREF(logStreamHandle))
def saCkptCheckpointOpenAsync(ckptHandle, invocation, checkpointName, checkpointCreationAttributes, checkpointOpenFlags): """Open existing checkpoint or create a new one without blocking. type arguments: SaCkptHandleT ckptHandle SaInvocationT invocation SaNameT checkpointName SaCkptCheckpointCreationAttributesT checkpointCreationAttributes SaCkptCheckpointOpenFlagsT checkpointOpenFlags returns: SaAisErrorT """ ckptdll.saCkptCheckpointOpenAsync.argtypes = [ SaCkptHandleT, SaInvocationT, POINTER(SaNameT), POINTER(SaCkptCheckpointCreationAttributesT), SaCkptCheckpointOpenFlagsT ] ckptdll.saCkptCheckpointOpenAsync.restype = SaAisErrorT return ckptdll.saCkptCheckpointOpenAsync(ckptHandle, invocation, BYREF(checkpointName), BYREF(checkpointCreationAttributes), checkpointOpenFlags)
def saImmOmAdminOperationContinue(ownerHandle, objectName, continuationId,
operationReturnValue):
"""Continue invocation of an administrative operation initiated with
an administrative handle that has since been finalized.
type arguments:
SaImmAdminOwnerHandleT ownerHandle
SaNameT objectName
SaImmContinuationIdT continuationId
SaAisErrorT operationReturnValue
returns:
SaAisErrorT
"""
omdll.saImmOmAdminOperationContinue.argtypes = [
SaImmAdminOwnerHandleT,
POINTER(SaNameT), SaImmContinuationIdT,
POINTER(SaAisErrorT)
]
omdll.saImmOmAdminOperationContinue.restype = SaAisErrorT
return omdll.saImmOmAdminOperationContinue(ownerHandle, BYREF(objectName),
continuationId,
BYREF(operationReturnValue))
def saLogStreamOpenAsync_2(logHandle, logStreamName, logFileCreateAttributes,
logStreamOpenFlags, invocation):
"""Open a log stream asynchronously.
type arguments:
SaLogHandleT logHandle
SaNameT logStreamName
SaLogFileCreateAttributesT_2 logFileCreateAttributes
SaLogStreamOpenFlagsT logStreamOpenFlags
SaInvocationT invocation
returns:
SaAisErrorT
"""
logdll.saLogStreamOpenAsync_2.argtypes = [
SaLogHandleT,
POINTER(SaNameT),
POINTER(SaLogFileCreateAttributesT_2), SaLogStreamOpenFlagsT,
SaInvocationT
]
logdll.saLogStreamOpenAsync_2.restype = SaAisErrorT
return logdll.saLogStreamOpenAsync_2(logHandle, BYREF(logStreamName),
BYREF(logFileCreateAttributes),
logStreamOpenFlags, invocation)
def saImmOmAdminOperationInvoke_2(ownerHandle, objectName, continuationId,
operationId, params, operationReturnValue,
timeout):
"""Request registered runtime owner of named object to perform the
identified administration operation.
type arguments:
SaImmAdminOwnerHandleT ownerHandle
SaNameT* objectName
SaImmContinuationIdT continuationId
SaImmAdminOperationIdT operationId
SaImmAdminOperationParamsT_2** params
SaAisErrorT* operationReturnValue
SaTimeT timeout
returns:
SaAisErrorT
"""
c_params = marshalNullArray(params, POINTER(SaImmAdminOperationParamsT_2))
omdll.saImmOmAdminOperationInvoke_2.argtypes = [
SaImmAdminOwnerHandleT,
POINTER(SaNameT), SaImmContinuationIdT, SaImmAdminOperationIdT,
POINTER(POINTER(SaImmAdminOperationParamsT_2)),
POINTER(SaAisErrorT), SaTimeT
]
omdll.saImmOmAdminOperationInvoke_2.restype = SaAisErrorT
return omdll.saImmOmAdminOperationInvoke_2(ownerHandle, BYREF(objectName),
continuationId, operationId,
c_params,
BYREF(operationReturnValue),
timeout)
def saImmOmAccessorGet_2(accessorHandle, objectName, attributeNames,
attributes):
"""Use object accessor handle to obtain values of object attributes.
type arguments:
SaImmAccessorHandleT accessorHandle
SaNameT objectName
SaImmAttrNameT attributeNames
POINTER(POINTER(SaImmAttrValuesT_2))() attributes
returns:
SaAisErrorT
"""
c_attributeNames = marshalNullArray(attributeNames)
omdll.saImmOmAccessorGet_2.argtypes = [
SaImmAccessorHandleT,
POINTER(SaNameT),
POINTER(SaImmAttrNameT),
POINTER(POINTER(POINTER(SaImmAttrValuesT_2)))
]
omdll.saImmOmAccessorGet_2.restype = SaAisErrorT
return omdll.saImmOmAccessorGet_2(accessorHandle, BYREF(objectName),
c_attributeNames, BYREF(attributes))
def saImmOmSearchInitialize_2(immHandle, rootName, scope, searchOptions,
searchParams, attributeNames, searchHandle):
"""Initialize a search operation limited to objects identified by
rootName and scope.
type arguments:
SaImmHandleT immHandle
SaNameT rootName
SaImmScopeT scope
SaImmSearchOptionsT searchOptions
SaImmSearchParametersT_2 searchParams
SaImmAttrNameT attributeNames
SaImmSearchHandleT searchHandle
returns:
SaAisErrorT
"""
c_attributeNames = marshalNullArray(attributeNames)
omdll.saImmOmSearchInitialize_2.argtypes = [
SaImmHandleT,
POINTER(SaNameT), SaImmScopeT, SaImmSearchOptionsT,
POINTER(SaImmSearchParametersT_2),
POINTER(SaImmAttrNameT),
POINTER(SaImmSearchHandleT)
]
omdll.saImmOmSearchInitialize_2.restype = SaAisErrorT
return omdll.saImmOmSearchInitialize_2(immHandle, BYREF(rootName), scope,
searchOptions, BYREF(searchParams),
c_attributeNames,
BYREF(searchHandle))
def saImmOmClassDescriptionGet_2(immHandle, className, classCategory,
attrDefinitions):
"""Get descriptor of object class identified by className.
type arguments:
SaImmHandleT immHandle
SaImmClassNameT className
SaImmClassCategoryT classCategory
SaImmAttrDefinitionT_2*** attrDefinitions
returns:
SaAisErrorT
"""
omdll.saImmOmClassDescriptionGet_2.argtypes = [
SaImmHandleT, SaImmClassNameT,
POINTER(SaImmClassCategoryT),
POINTER(POINTER(POINTER(SaImmAttrDefinitionT_2)))
]
omdll.saImmOmClassDescriptionGet_2.restype = SaAisErrorT
return omdll.saImmOmClassDescriptionGet_2(immHandle, className,
BYREF(classCategory),
BYREF(attrDefinitions))
def saImmOiAugmentCcbInitialize(immOiHandle, ccbId64, ccbHandle, ownerHandle):
"""Allows the OI implementers to augment ops to a ccb related
to a current ccb-upcall, before returning from the upcall.
This is allowed inside:
SaImmOiCcbObjectCreateCallbackT
SaImmOiCcbObjectDeleteCallbackT
SaImmOiCcbObjectModifyCallbackT
It is NOT allowed inside:
SaImmOiCcbCompletedCallbackT
SaImmOiApplyCallbackT
SaImmOiAbortCallbackT
type arguments:
SaImmOiHandleT immOiHandle
SaImmOiCcbIdT ccbId64
SaImmCcbHandleT *ccbHandle
SaImmAdminOwnerHandleT *ownerHandle
returns:
SaAisErrorT
"""
oidll.saImmOiAugmentCcbInitialize.argtypes = [
SaImmOiHandleT, SaImmOiCcbIdT,
POINTER(SaImmCcbHandleT),
POINTER(SaImmAdminOwnerHandleT)
]
oidll.saImmOiAugmentCcbInitialize.restype = SaAisErrorT
return oidll.saImmOiAugmentCcbInitialize(immOiHandle, ccbId64,
BYREF(ccbHandle),
BYREF(ownerHandle))
def saClmInitialize_3(clmHandle, clmCallbacks, version):
"""Register invoking process with CLM.
type arguments:
SaClmHandleT clmHandle
SaClmCallbacksT_3 clmCallbacks
SaVersionT version
returns:
SaAisErrorT
"""
return clmdll.saClmInitialize_3(BYREF(clmHandle), BYREF(clmCallbacks),
BYREF(version))
def saSmfInitialize(smfHandle, smfCallbacks, version):
"""Register invoking process with SMF.
type arguments:
SaSmfHandleT smfHandle
SaSmfCallbacksT smfCallbacks
SaVersionT version
returns:
SaAisErrorT
"""
return smfdll.saSmfInitialize(BYREF(smfHandle), BYREF(smfCallbacks),
BYREF(version))
def saLckInitialize(lckHandle, lckCallbacks, version):
"""Register invoking process with Lock Service.
type arguments:
SaLckHandleT lckHandle
SaLckCallbacksT lckCallbacks
SaVersionT version
returns:
SaAisErrorT
"""
return lckdll.saLckInitialize(BYREF(lckHandle), BYREF(lckCallbacks),
BYREF(version))
def saMsgQueueStatusGet(msgHandle, queueName, queueStatus): """Retrieve information about the status of the message queue. type arguments: SaMsgHandleT msgHandle SaNameT queueName SaMsgQueueStatusT queueStatus returns: SaAisErrorT """ return msgdll.saMsgQueueStatusGet(msgHandle, BYREF(queueName), BYREF(queueStatus))
def saMsgInitialize(msgHandle, msgCallbacks, version): """Register invoking process with Message Service. type arguments: SaMsgHandleT msgHandle SaMsgCallbacksT msgCallbacks SaVersionT version returns: SaAisErrorT """ return msgdll.saMsgInitialize(BYREF(msgHandle), BYREF(msgCallbacks), BYREF(version))
def saMsgQueueGroupRemove(msgHandle, queueGroupName, queueName): """Remove a message queue from a message queue group. type arguments: SaMsgHandleT msgHandle SaNameT queueGroupName SaNameT queueName returns: SaAisErrorT """ return msgdll.saMsgQueueGroupRemove(msgHandle, BYREF(queueGroupName), BYREF(queueName))
def saMsgQueueGroupInsert(msgHandle, queueGroupName, queueName): """Insert a message queue into a message queue group. type arguments: SaMsgHandleT msgHandle SaNameT queueGroupName SaNameT queueName returns: SaAisErrorT """ return msgdll.saMsgQueueGroupInsert(msgHandle, BYREF(queueGroupName), BYREF(queueName))
def saImmOmAdminOperationContinueAsync(ownerHandle, invocation, objectName,
continuationId):
"""Continue asynchronous invocation of an administrative operation
initiated with an administrative handle that has since been finalized.
type arguments:
SaImmAdminOwnerHandleT ownerHandle
SaInvocationT invocation
SaNameT objectName
SaImmContinuationIdT continuationId
returns:
SaAisErrorT
"""
omdll.saImmOmAdminOperationContinueAsync.argtypes = [
SaImmAdminOwnerHandleT, SaInvocationT,
POINTER(SaNameT), SaImmContinuationIdT
]
omdll.saImmOmAdminOperationContinueAsync.restype = SaAisErrorT
return omdll.saImmOmAdminOperationContinueAsync(ownerHandle, invocation,
BYREF(objectName),
continuationId)
def saLogWriteLogAsync(logStreamHandle, invocation, ackFlags, logRecord):
"""Log a record to the log stream asynchronously.
type arguments:
SaLogStreamHandleT logStreamHandle
SaInvocationT invocation
SaLogAckFlagsT ackFlags
SaLogRecordT logRecord
returns:
SaAisErrorT
"""
logdll.saLogWriteLogAsync.argtypes = [SaLogStreamHandleT,
SaInvocationT,
SaLogAckFlagsT,
POINTER(SaLogRecordT)]
logdll.saLogWriteLogAsync.restype = SaAisErrorT
return logdll.saLogWriteLogAsync(logStreamHandle,
invocation,
ackFlags,
BYREF(logRecord))
def saCkptSectionCreate(checkpointHandle,
sectionCreationAttributes,
initialData,
initialDataSize):
"""Create new section in checkpoint associated with checkpointHandle.
type arguments:
SaCkptCheckpointHandleT checkpointHandle
SaCkptSectionCreationAttributesT sectionCreationAttributes
void initialData
SaSizeT initialDataSize
returns:
SaAisErrorT
"""
ckptdll.saCkptSectionCreate.argtypes = [
SaCkptCheckpointHandleT,
POINTER(SaCkptSectionCreationAttributesT),
SaVoidPtr,
SaSizeT
]
ckptdll.saCkptSectionCreate.restype = SaAisErrorT
return ckptdll.saCkptSectionCreate(checkpointHandle,
BYREF(sectionCreationAttributes),
initialData,
initialDataSize)
def saCkptSectionExpirationTimeSet(checkpointHandle, sectionId, expirationTime): """Set expiration of identified section within checkpoint identified by checkpointHandle. type arguments: SaCkptCheckpointHandleT checkpointHandle SaCkptSectionIdT sectionId SaTimeT expirationTime returns: SaAisErrorT """ ckptdll.saCkptSectionExpirationTimeSet.argtypes = [ SaCkptCheckpointHandleT, POINTER(SaCkptSectionIdT), SaTimeT ] ckptdll.saCkptSectionExpirationTimeSet.restype = SaAisErrorT return ckptdll.saCkptSectionExpirationTimeSet(checkpointHandle, BYREF(sectionId), expirationTime)
def saCkptSectionIterationInitialize(checkpointHandle, sectionsChosen, expirationTime, sectionIterationHandle): """Get iteration handle for checkpoint associated with checkpointHandle. type arguments: SaCkptCheckpointHandleT checkpointHandle SaCkptSectionsChosenT sectionsChosen SaTimeT expirationTime SaCkptSectionIterationHandleT sectionIterationHandle returns: SaAisErrorT """ ckptdll.saCkptSectionIterationInitialize.argtypes = [ SaCkptCheckpointHandleT, SaCkptSectionsChosenT, SaTimeT, POINTER(SaCkptSectionIterationHandleT) ] ckptdll.saCkptSectionIterationInitialize.restype = SaAisErrorT return ckptdll.saCkptSectionIterationInitialize(checkpointHandle, sectionsChosen, expirationTime, BYREF(sectionIterationHandle))
def saAmfPmStop(amfHandle, compName, stopQualifier, processId, pmErrors):
"""Stop AMF passive monitoring of specific errors.
type arguments:
SaAmfHandleT amfHandle
SaNameT compName
SaAmfPmStopQualifierT stopQualifier
SaInt64T processId
SaAmfPmErrorsT pmErrors
returns:
SaAisErrorT
"""
amfdll.saAmfPmStop.argtypes = [SaAmfHandleT,
POINTER(SaNameT),
SaAmfPmStopQualifierT,
SaInt64T,
SaAmfPmErrorsT]
amfdll.saAmfPmStop.restype = SaAisErrorT
return amfdll.saAmfPmStop(amfHandle,
BYREF(compName), stopQualifier, processId, pmErrors)
def saAmfPmStart_3(amfHandle,
compName, processId, descendentsTreeDepth, pmErrors,
recommendedRecovery):
"""Start AMF passive monitoring of specific errors.
type arguments:
SaAmfHandleT amfHandle
SaNameT compName
SaInt64T processId
SaInt32T descendentsTreeDepth
SaAmfPmErrorsT pmErrors
SaAmfRecommendedRecoveryT recommendedRecovery
returns:
SaAisErrorT
"""
amfdll.saAmfPmStart_3.argtypes = [SaAmfHandleT,
POINTER(SaNameT),
SaInt64T,
SaInt32T,
SaAmfPmErrorsT,
SaAmfRecommendedRecoveryT]
amfdll.saAmfPmStart_3.restype = SaAisErrorT
return amfdll.saAmfPmStart_3(amfHandle,
BYREF(compName), processId, descendentsTreeDepth,
pmErrors, recommendedRecovery)
def saCkptSectionOverwrite(checkpointHandle, sectionId, dataBuffer, dataSize): """Overwrite identified section in checkpoint associated with checkpointHandle. type arguments: SaCkptCheckpointHandleT checkpointHandle SaCkptSectionIdT sectionId SaVoidPtr dataBuffer SaSizeT dataSize returns: SaAisErrorT """ ckptdll.saCkptSectionOverwrite.argtypes = [ SaCkptCheckpointHandleT, POINTER(SaCkptSectionIdT), SaVoidPtr, SaSizeT ] ckptdll.saCkptSectionOverwrite.restype = SaAisErrorT return ckptdll.saCkptSectionOverwrite(checkpointHandle, BYREF(sectionId), dataBuffer, dataSize)