> ## Documentation Index
> Fetch the complete documentation index at: https://docs.incredibuild.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Change Settings using CLI (Command Line)

Last updated on Jul 12, 2023

Some settings can be modified using the command line or scripts.

These commands require root user permissions.

<Accordion title="Enable/Disable Agents as Helpers">
  ### Get Status

  Run this on any agent to view if an agent is enabled or disabled to participate as a helper in builds (returns true if enabled, false if disabled).

  ```
  /opt/incredibuild/management/get_agent_params.py enable-as-helper
  ```

  ### Set Status

  Run these on any agent to modify enable or disable it's ability to participate as a helper in builds.

  ```
  sudo /opt/incredibuild/management/set_agent_params.py enable-as-helper
  ```

  ```
  sudo /opt/incredibuild/management/set_agent_params.py disable-as-helper
  ```
</Accordion>

<Accordion title="Change Coordinator">
  ### Get Coordinator

  To view the Coordinator that a helper is associated with, run this on any agent machine:

  ```
  /opt/incredibuild/management/get_agent_params.py coordinator
  ```

  ### Set Coordinator

  To change the Coordinator that a helper is associated with, run this on any agent machine:

  ```
  sudo /opt/incredibuild/management/set_agent_params.py coordinator <hostname/IP of new Coordinator>
  ```

  After this is done, you also need [unsubscribe the licenses](/linux/3.1.8/manage-agent-subscription) on the original Coordinator and resubscribe them on the new Coordinator.

  For example:

  ```
  sudo /opt/incredibuild/management/set_agent_params.py coordinator 192.168.10.50
  ```
</Accordion>

<Accordion title="Maximum Number of Helper Cores">
  ### Get Maximum Number of Local Helpers

  To view the maximum number of available local cores required to start a new build, run this command on any agent machine:

  ```
  /opt/incredibuild/management/get_agent_params.py max-helper-cores
  ```

  ### Set Maximum Number of Local Helpers

  To change the maximum number of cores that an Agent can use when participating in builds, run this command on any agent machine:

  ```
  sudo /opt/incredibuild/management/set_agent_params.py max-helper-cores <number>
  ```

  For example:

  ```
  sudo /opt/incredibuild/management/set_agent_params.py max-helper-cores 64
  ```
</Accordion>

<Accordion title="Minimum Number of Local Helper Cores">
  ### Get Minimum Number of Local Helpers

  To view the minimum number of available local cores required to start a new build, run this command on any agent machine:

  ```
  /opt/incredibuild/management/get_agent_params.py min-local-cores
  ```

  ### Set Minimum Number of Local Helpers

  To change the minimum number of available local cores required to start a new build, run this command on any agent machine:

  ```
  sudo /opt/incredibuild/management/set_agent_params.py min-local-cores <number>
  ```

  For example:

  ```
  sudo /opt/incredibuild/management/set_agent_params.py min-local-cores 8
  ```
</Accordion>

<Accordion title="Maximum Initiator Cores">
  ### Get Maximum Initiator Cores

  To view the maximum number of cores that can be used by the agent when acting as the Initiator of a build, run this on any agent:

  ```
  /opt/incredibuild/management/get_agent_params.py max-initiator-cores
  ```

  ### Set Maximum Initiator Cores

  To set the maximum number of cores that can be used by the agent when acting as the Initiator of a build, run this on any agent:

  ```
  sudo /opt/incredibuild/management/set_agent_params.py max-initiator-cores <number of max initiator cores>
  ```

  For example:

  ```
  sudo /opt/incredibuild/management/set_agent_params.py max-initiator-cores 16
  ```
</Accordion>

<Accordion title="Build Groups">
  ### Get Build Group

  To view what Build Group an agent is in, run this on the agent:

  ```
  /opt/incredibuild/management/get_agent_params.py build-group
  ```

  ### Set Build Group

  Run this on your Primary Coordinator to assign an agent to a build group. You can use add the --include-offline flag (optional) at the end to implement the assignment even if the agent is offline.

  ```
  sudo /opt/incredibuild/management/set_build_group.py <agent ip or host name> <group name> --include-offline (optional param)
  ```

  For example:

  ```
  sudo /opt/incredibuild/management/set_build_group.py 192.168.10.50 group1 --include-offline (optional param)
  ```
</Accordion>
