Status in source: mandatory.
Technical details
{
"smi_kind": "OBJECT-TYPE",
"definition": [
"hpiHotSwapExtractTimeout",
"OBJECT-TYPE",
"SYNTAX",
"SaHpiTime",
"ACCESS",
"read-write",
"STATUS",
"mandatory",
"DESCRIPTION",
"\"This function allows the HPI User to configure a timeout for how long to wait before the default auto-extraction policy is invoked. This function accepts a parameter instructing the resource to impose a delay before performing its default hot swap policy for auto-extraction. The parameter may be set to SAHPI_TIMEOUT_IMMEDIATE to direct the resource to proceed immediately to auto-extraction, or to SAHPI_TIMEOUT_BLOCK to prevent auto-extraction from ever occurring on a resource. If the parameter is set to another value, then it defines the number of nanoseconds between the time a hot swap event with hpiHotSwapState = extractionPending(5) is generated and the time that the auto-extraction policy will be invoked for the resource. If, during this time period, a hpiHotSwapPolicyCancel function call is processed, the timer will be stopped, and the auto-extraction policy will not be invoked. Once the auto-extraction process begins, the HPI User will not be allowed to take control of the extraction process; hence, the timeout should be set appropriately to allow for this condition. Note that the timeout period begins when the hot swap event with hpiHotSwapState = extractionPending(4) is initially generated.\"",
"::=",
"{",
"hpiHotSwapEntry",
"4",
"}"
],
"syntax_tree": [
[
"row",
"SaHpiTime"
],
null,
[
"MaxAccessPart",
"read-write"
],
[
"Status",
"mandatory"
],
[
"DESCRIPTION",
"This function allows the HPI User to configure a timeout for how long to wait before the default auto-extraction policy is invoked. This function accepts a parameter instructing the resource to impose a delay before performing its default hot swap policy for auto-extraction. The parameter may be set to SAHPI_TIMEOUT_IMMEDIATE to direct the resource to proceed immediately to auto-extraction, or to SAHPI_TIMEOUT_BLOCK to prevent auto-extraction from ever occurring on a resource. If the parameter is set to another value, then it defines the number of nanoseconds between the time a hot swap event with hpiHotSwapState = extractionPending(5) is generated and the time that the auto-extraction policy will be invoked for the resource. If, during this time period, a hpiHotSwapPolicyCancel function call is processed, the timer will be stopped, and the auto-extraction policy will not be invoked. Once the auto-extraction process begins, the HPI User will not be allowed to take control of the extraction process; hence, the timeout should be set appropriately to allow for this condition. Note that the timeout period begins when the hot swap event with hpiHotSwapState = extractionPending(4) is initially generated."
],
null,
null,
null,
null
]
}