Parameter descriptions in source_input.rc file

The following are parameters and descriptions in the sample source_input.rc file:
Parameter Description
customer_interface Customer interface in the NPS host to which OAM IP is assigned.
customer_ip OAM IP address assigned to the NPS toolkit VM. The IP address is used to log in to the VM.
customer_gw Gateway of the OAM network.
vm_name Name of the VM. Special characters are not allowed. A folder with this name is created in /root/VirtualBox VMs, which is used while bringing up the NPS toolkit VM internally.
host_name Hostname to be set to the NPS toolkit VM.

If vim_type is rhocp, host_name must be a Fully Qualified Domain Name (FQDN). Only "-" and "." special characters are allowed.

root_password Password that will be set to NPS Toolkit VM.

This password is used while logging in to the NPS toolkit VM.

The following are the set of rules for a valid root_password:

  • root_password must not have 'root' as a substring (case-insensitive).

  • root_password must be at least 12 characters long and at most 16 characters long.

  • root_password must contain at least one uppercase letter (A-Z), one lowercase letter (a-z), one digit (0-9), and one special character (~!@#$%^&*-+_|(){}:;<>,.?/).

vagrant_user_password Password that will be set to NPS toolkit VM for vagrant user.

This password is used for logging in to the NPS toolkit VM as a vagrant user (username: vagrant).

The following are the set of rules for a valid vagrant_user_password:

  • vagrant_user_password must not have 'vagrant' as a substring (case-insensitive).

  • vagrant_user_password must be at least 12 characters long and at most 16 characters long.

  • vagrant_user_password must contain at least one uppercase letter (A-Z), one lowercase letter (a-z), one digit (0-9), and one special character (~!@#$%^&*-+_|(){}:;<>,.?/).

sync_folder Location in NPS host where artifacts are extracted.

This folder must always be in sync with the /var/artifacts folder inside the NPS toolkit VM.

resize Enter yes or no. By default, the NPS toolkit VM size will be 30 GB,

If you want VM size to be more than 30 GB, enter yes.

vm_size Size of the NPS toolkit VM in Gigabits (Gb) and the resize parameter value is yes.

vm_size >= 30, if vim_type is rhocp/rhosp/vmware.

vm_size should be minimum 300 GB.
vm_vcpu VCPUs to be allocated to the NPS toolkit VM.

Default : 2

vm_memory RAM memory to be allocated to the NPS toolkit VM in Gigabits (Gb).

Default : 2

VIM_TYPE The supported VIM type can be rhocp, rhosp, vmware or "". If VIM is not used, provide the value as "".
infrastructure infrastructure can be baremetal or rhosp.

If the VIM_TYPE is rhocp and installation is ocp on osp, then enter infrastructure as rhosp.

If the VIM_TYPE is rhocp and installation is on baremetal, then enter infrastructure as baremetal.

If the VIM_TYPE is vmware or rhosp, enter infrastructure as baremetal.

If vim is not used, enter the value as "".

release_name Name of the NPS folder after the untar operation.
proxy_port Enter the proxy port number.

Keep "" if proxy is not required. If proxy_port and proxy_hostname are given, the script takes care of exporting http_proxy and https_proxy to the NPS host and NPS toolkit VM environment and updates in the rhsm file.

proxy_hostname Enter the proxy hostname without http://. If this requires DNS resolution, ensure your DNS is active and is added in the resolv.conf file.

Keep "" if proxy is not required. If proxy_port and proxy_hostname are given, the script takes care of exporting http_proxy and https_proxy to the NPS host and NPS toolkit VM environment and updates in the rhsm file.

pool_id_physical Physical pool ID used while performing RHEL subscription on the NPS host machine.

Keep "", if VIM_TYPE is vmware or "".

pool_id_virtual Virtual pool ID used while performing RHEL subscription on the NPS toolkit VM.

Keep "", if VIM_TYPE is vmware or "".

rhel_username RHEL credential username, this is required to register the system with RHEL subscription manager.

Keep "", if VIM_TYPE is vmware or "".

rhel_password RHEL credential password, this is required to register the system with RHEL subscription manager.

Keep "", if VIM_TYPE is vmware or "".

unregister_host Unregister RHEL subscription on the NPS host. It can be yes or no.

Keep "", if VIM_TYPE is vmware or "".

NOTE:

Applicable only if you are using the NPS toolkit VM to download RHOSP repositories and make it as local repo.

unregister_vm Unregister RHEL subscription on the NPS VM.

Values are yes or no.