Editing the network configuration YAML file

Learn how to populate a System_Name.yml file specifying the system's node side network configuration.
Verify if your system already uses the YAML file for network configuration. The file should be in /opt/ibm/appliance/platform/apos-comms/customer_network_config/ansible. Typically, the system's name is used as the file base name. When editing your System_Name.yml file, you must use spaces. Do not use Tab.

If the YAML file already exists on the system

Before updating your YAML file, save a copy as <System_Name>.yml.backup for safe-keeping.
Tip: Note that there must only be one copy of the YAML file in the directory. Save backups to a different location, for example, cp System_Name.yml /tmp.

If the YAML file does not exist on the system

If the YAML file was not used before on your system, you can use the provided template to create the file.
Note: The steps in this task require Cloud Pak for Data System version or newer. If you have a release older than, and the /opt/ibm/appliance/platform/apos-comms/customer_network_config/ansible directory does not exist on your system, you must extract the template host yml file from the rpm in the upgrade bundle. In the upgrade bundle, there is a ibm-apos-network-tools-*.rpm file in the upgrade/aposcomms directory after it is extracted. Follow these steps:
  1. Check if system bundle is extracted to /localrepo/1.0.x.x_release/EXTRACT/system
  2. If it is not, run the command:
    tar xvf /localrepo/1.0.x.x_release/icpds_system*.tar.gz -C /localrepo/1.0.x.x_release/EXTRACT/system
  3. Change to directory:
    cd /localrepo/1.0.x.x_release/EXTRACT/system/upgrade/aposcomms
  4. Run
    rpm2cpio ibm-apos-network-tools-*.rpm | cpio -idmv
  5. If it does not exist, create /customer_network_config/ansible directory by running:
    mkdir -p /opt/ibm/appliance/platform/apos-comms/customer_network_config/ansible/
  6. Copy the hosts.template.yml file from the following directory inside the bundle
Once you confirm that /opt/ibm/appliance/platform/apos-comms/customer_network_config/ansible exists in the system:
  1. ssh to the control node e1n1:
    [root@service-laptop ~]# ssh e1n1
    [root@e1n1 ~]#
  2. A template file is supplied with the system. Copy the template, use the system's name as the file base name.
    [root@e1n1 ~]# cd /opt/ibm/appliance/platform/apos-comms/customer_network_config/ansible
    [root@e1n1 ~]# cp ./hosts.template.yml ./System_Name.yml

Important notes

All network related changes must be driven through the YAML file, and NOT manually editing configuration files on the system.

There must be only one .yml file apart from the template in the /opt/ibm/appliance/platform/apos-comms/customer_network_config/ansible directory, otherwise you might face issues when configuring the network.

Node configuration is done from the control node itself:
[root@service-laptop ~]# ssh e1n1
[root@e1n1 ~]#
After connecting to node e1n1, make sure to run all commands in a screen session. This will safeguard your progress in the event you lose connectivity to the node during the Ansible playbook run.
  • To create a screen session:
    screen -X <myusername-yaml>
  • To detach from a screen session without killing it:
  • To list existing screen sessions:
    screen -list
  • To reattach to a detached screen session:
    screen -R <screen name, including prefix numbers and ".">
The following sections provide instructions on filling in the file. The text formatting must not be changed, it is important to preserve white spaces or indentation as is. You must either use the template that is available on the system, or copy paste the contents of the sample available in Template and sample YAML, and only modify the required values. Replace <VALUE> (deleting the square brackets) as necessary. If you do not need to modify a value, leave the <OPTIONAL> tag from the template as is. Once you edit the file, validate it as described in Validating the YAML file.

Follow the links below to learn about specific sections in the YAML file. You can also browse the common tasks for detailed instructions on updating specific settings.