<Get> element
Syntax
Parent element: <CfgMethod>, <ParameterDef>
The following attribute is supported:
| Attribute | Required | Type | Description |
|---|---|---|---|
| type | yes | string | Specifies the type of the get command (current or nextboot). |
The following child elements are supported:
| Child elements | Required | Number | Description |
|---|---|---|---|
| <Command> | no | 0 – 1 | Command |
| <Argument> | no | 0 – 1 | Command-line arguments |
| <Stdin> | no | 0 – 1 | Arguments supported by the <Stdin> element |
| <Filter> | no | 0 – 1 | Filter |
| <Mask> | no | 0 – 1 | Output capturing mask |
| <Prereq> | no | 0 – any | Assigns a prerequisite to the get operation |
The <Command> element must be defined for each parameter, either at the <CfgMethod> level or directly at the <ParameterDef> level.
Usage
The <Get> element describes how the value of a particular parameter is captured. It can be used either directly under the <ParameterDef> element, or under a <CfgMethod> element referenced in the <ParameterDef> element using the cfgmethod attribute, or using a combination of those two possibilities.
Two Get elements should be defined for each parameter, one for each supported value of the type attribute:
- Get type=“current” identifies the method that will be run to retrieve the runtime value of the parameter.
- Get type=“nextboot” identifies the method that will be run to retrieve the value that the parameter will have after the next reboot of the system.
- The get method to be run depends on the operation being performed:
- If the artexget command is called with the –r flag, the current get method is used.
- If the artexget command is called with the –n flag, the nextboot get method is used.
- If the artexget command is called with the –p flag, the method run depends on the parameters input to the applyType attribute. The current get method is used for the parameters that have their applyType attribute set to runtime and the nextboot get method is used for the parameters that have an applyType attribute of reboot.
Related Information
The <Mask> element.