essmkyml command

Runs ESS deployment command to create and run container used to deploy working IBM Storage Scale System cluster.

Synopsis


essmkyml [ -c] [ -f YML_FILENAME ] [ -v] [--clean-up]
         [ --no-clean-up-on-startup] [ --no-use-EMS-hostname ]    
         [ -h | --help ]

Availability

Available with IBM Storage Scale System.

Description

The essmkyml command helps to create and run container in order to deploy working ESS cluster. This command must be run only on the EMS node. The essmkyml command prompts you to confirm EMS FQDN and change it, provide the container short name and provide a free IP address on the FSP subnet for the container FSP connection.

Parameters

-h | --help
Displays usage information about this command and exits.
-c | --not-prepare-start-container
Do not prepare or start container. It will require to run essmgr to do the preparations and run the container.
-f YML_FILENAME | --filename YML_FILENAME
The YML filename to operate on. By default, essmgr.yml is used.
-v | --verbose
Shows verbose messages in the console.
--clean-up
Clean up all container images of this ESS type and network bridges. No confirmation of any kind, use with caution.
--no-clean-up-on-startup
Network bridges are not restarted when a container is started.
--no-use-EMS-hostname
Do not use EMS hostname for derivating the remaining information. This is not recommended setting. Always set the EMS hostname to Management Network.

Exit status

0
Successful completion.
nonzero
A failure has occurred.

Security

You must have root authority to run the essmkyml command.

Examples

  1. # ./essmkyml 
Is the current EMS FQDN c145f05zems06.gpfs.net correct (y/n):y
Please type the desired and resolvable short hostname [ess5k-cems0]: cems0
Please type the FSP IP of the container [10.0.0.5]: 10.0.0.80
    Note: The values in parentheses ([ ]) are examples or the last entered values.
  2. If all of the checks pass, the essmgr.yml file is written and you can proceed to bridge creation, if applicable, and running the container. At this point, if all checks are successful, the image is loaded and container is started.
    # ESS 5000 CONTAINER root@cems0:/ #

Location

/opt/ibm/ess/tools/bin