ibmint create node command

Use the ibmint create node command to create an integration node in IBM® App Connect Enterprise.

Supported platforms

  • Windows
  • Linux®
  • Linux on POWER®
  • Linux on Z
  • AIX®
  • IBM z/OS® Container Extensions (zCX)

Purpose

When you use the ibmint create node command, the following actions are completed:
  1. Windows platformOn Windows only, the command installs a service under which the integration node runs.
  2. The command creates a record for the component in the registry.
  3. When you create an integration node, the default port that is used for the first integration node is 4414.

Syntax

Read syntax diagramSkip visual syntax diagramibmint create node nodeName   --queue-manager queueManagerName --node-conf-yaml filePath --shared-work-path directory --work-path directory --vault-key key --vaultrc-location directory --external-directory-vault directory --trace filePath --help 

Parameters

nodeName
The name of a locally defined integration node.
--queue-manager queueManagerName
The name of the IBM MQ queue manager that is associated with the integration node.
--node-conf-yaml filePath
The configuration file for the integration node.
--shared-work-path directory
The directory in which registry and configuration data is shared between multiple instances of this integration node.
--work-path directory
The directory in which internal data, such as installation logs, component details, and trace output are written.

If you want to create an App Connect Enterprise vault, you must specify the details of the vault key by using one of the following forms: (a) --vault-key or (b) --vaultrc-location. If either the --vault-key or the --vaultrc-location parameter is specified on the command, an App Connect Enterprise vault is created to hold the credentials that are used by the integration node when it accesses secured resources. You cannot use --vault-key and --vaultrc-location in the same command.

(a)
--vault-key key
(Optional) This parameter specifies the vault key to be used for creating the vault.
(b)
--vaultrc-location directory
(Optional) This parameter specifies the location of the .mqsivaultrc file that is used to locate the vault key.
If the directory that is specified does not exist, you must create it before you run the ibmint create node command with the --vaultrc-location parameter. The directory must contain a .mqsivaultrc file, which you can create by running the following command:
mqsivault --vaultrc-store-default-key --vault-key 12345678 --vaultrc-location directory

For more information, see mqsivault command.

If you want to use an external directory vault, use the --external-directory-vault parameter to specify the directory where the external directory vault is contained.

--external-directory-vault directory
The external directory vault to be associated to the integration node.
--trace filePath
(Optional) Use this parameter to send verbose internal trace to the specified file.
--help
(Optional) Use this parameter to display help information about the command.

Examples

Create an integration node:
ibmint create node INODE
Create an integration node and specify the queue manager to be used for the integration node:
ibmint create node INODE --queue-manager myQueueManager
Create an integration node and specify the working directory within which work files for this integration node are stored:
ibmint create node INODE --work-path C:\workpath
Create an integration node and specify the location of the .mqsivaultrc file that is used to locate the vault key:
ibmint create node INODE --vaultrc-location C:\vaultlocation
Create an integration node and specify a file to which verbose internal trace is sent:
ibmint create node INODE --trace C:\trace\myTraceFile
Display help information about the command:
ibmint create node--help