Port Configuration

Port mappings enable you to access data while running the simulator via user-defined ports on the host machine. An everyday use case for this feature is accessing logs for the image running inside the simulator.

Users can update port mappings via the Configure port mappings tab in the Hardware Profile screen for the Image Configuration Tool. You can assign port mappings to standard ports like SSH, HTTP, Web Debug, and Java Debug. You can even add your port to configure.

For each port, KOS Studio displays the port the simulator uses internally and allows you to provide port mapping for either your whole team or just for you.

Figure 1 : Port Configuration

Types of Port Mappings :

KOS Studio supports three types of port mappings :

  1. Internal Port
  2. Team Port
  3. Local Overrides.

Internal Port :

The internal port represents the port KOS Studio uses internally for that particular protocol. You can only view this information, and it is not user-editable.

Team Port :

The team port represents the port that a particular protocol uses across the team. Learn more about image collaboration. Assigning a team port makes sure everyone on the team uses the same port for better collaboration.

Consider the Following when using team port mapping :

  1. Updating team port mapping updates mapping for everyone using that image, so be cautious. A team port mapping overrides the system setting.

Local Override :

Local override enables you to override port mappings on the current machine. A user uses a local override to change his settings without updating the team settings. A local port mapping overrides the team setting; if there is no team setting, it overrides the system setting.

The blue dot indicates the active setting. Deleting local override updates the image to system settings.

Port Mapping for Child Images :

KOS studio also enables you to create a child image of an Image. Child image inherits parent’s port mappings. Updating port mapping in the parent image updates those settings for the child image if the child’s port mappings are unchanged.

Access and view the port mappings for an image

  1. Log in to KOS Studio, and from My Images, click on Open Image Manager (in the upper right corner of the screen).
  2. For the image you want to update from the list of images, click Settings for that image(on the right-hand side for the image row).
  3. Select the Hardware Settings >> Configure port mappings tab on the Image Configuration window.

Adding port mapping

  1. Log in to KOS Studio, and from My Images, click on Open Image Manager (in the upper right corner of the screen).
  2. Select the image from the list of images you want to update the port mappings and click Settings for that image(on the right-hand side for the image row).
  3. Select Hardware Settings >Configure port mappings tab on the Image Configuration window.
  4. Select the one you want to add port mappings for from the displayed list of available protocols. Provide the internal simulator port, team mapping, and local override for the newly added port. Consider following :
    • Use ports higher than 1024 for port forwarding.
    • If you have a Local Override Specified, it will take precedence over the Team Port. KOS studio will always show an indicator next to the active port mapping.
    • Grayed-out port value indicates an inherited port for child images, which can be updated to a different value if needed.
Figure 2: Inherited Port value

Adding a custom port and port mapping

  1. Log in to KOS Studio, and from My Images, click on Open Image Manager (in the upper right corner of the screen).
  2. Select the image from the list of images you want to update the port mappings and click Settings for that image(on the right-hand side for the image row).
  3. Select Hardware Settings >Configure port mappings tab from the open Image Configuration window.
  4. Click the Add new port on the Configure port mapping tab. Here, provide the internal simulator port, team mapping, and local override for the newly added port. Consider following :
    • Use ports higher than 1024 as port forwarding.
    • If you have a Local Override Specified, it will take precedence over the Team Port. KOS studio will always show an indicator next to the active port mapping.