Skip to Content

Warning
Helix documentation is moving from docs.bmc.com to docs.helixops.ai

Key pages will redirect to the new domain on May 26, 2026. However, some legacy documentation links will not be redirected. 

In-product help links might not work after migration as we transition and update them within the product.

For any queries, reach out to IX-Support@helixops.ai.

Configuring the Windows Session-based CLI adapter

In a Windows environment, the Session-based CLI adapter opens a sub-shell. Subsequent commands execute in the sub-shell in a session. You can specify the command at the command level or at the command-group level.

The console prompt appears when the system is waiting for a command. This prompt indicates that a command has been executed.

The following table describes the configuration node elements for the Windows Session-based CLI adapter.


 Configuration node elements of the Windows Session-based CLI adapter

The following figure shows a sample configuration of the Windows Session-based CLI adapter.

XML sample of the Session-based CLI adapter configuration for Windows


<config>
<initial-command>
  <command prompt="c:\directory&gt;">cmd.exe</command>
</initial-command>
<character-set>Shift_JIS</character-set>
<prompt>&gt;</prompt>
<verify-os>false</verify-os>
<env-variables>
  <env-variable>
    <name>AddAndThenDelete_Name</name>
    <value>AddAndThenDelete_Value</value>
  </env-variable>
  <env-variable>
    <name>AddVariable_Name</name>
    <value>New_AddVariable_Value</value>
  </env-variable>
  <env-variable>
    <name>AddAndThenDelete_Name</name><!-- to delete which is recently added -->
    <value/>
  </env-variable>
</env-variables>
</config>

The following figure shows a sample configuration of the Windows Session-based CLI adapter to set environment variables.

XML sample of the Session-based CLI adapter configuration to set environment variables


<config/>
   <env-variables>
      <env-variable>
        <name>New_Variable11</name>
        <value>New_variable11_value</value>
      </env-variable>
      <env-variable>
        <name>New_Variable22</name>
        <value>New_variable22_value</value>
      </env-variable>
   </env-variables>
</config>

The following figure shows a sample configuration of the Windows Session-based CLI adapter to clear environment variables.

XML sample of the Session-based CLI adapter configuration to clear environment variables


<config>
   <env-variables>
      <env-variable>
        <name>New_Variable11</name>
        <value/>
      </env-variable>
      <env-variable>
        <name>New_Variable22</name>
        <value/>
      </env-variable>
   </env-variables>
</config>

The following figure shows a sample configuration of the Windows Session-based CLI with character-set.

XML sample of the Session-based CLI configuration with character-set


<config>
  <initial-command>
    <command prompt="c:\directory&gt;">cmd.exe</command>
  </initial-command>
  <character-set>Shift_JIS</character-set>
</config>

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

(archive) BMC Atrium Orchestrator Base Adapters 20.12.04