updatecell CLI command

For an integration with Infrastructure Management in the high-availability mode, you need to provide details of the load balancer node (and the associated cell) rather than the Infrastructure Management primary or secondary server.

If you apply high availability to an existing Infrastructure Management deployment, it is possible that existing external configurations created on IT Data Analytics are referring to Infrastructure Management cells that are changed or renamed. In this scenario, you need to update the new cell details by running the updatecell CLI command.

To understand the syntax and examples, see:

Related topics

Integrating

configureexternalfields CLI command

Syntax

Note

Before you run the command, note the following points:

Set up the CLI. For more information, see Managing the product from the command line interface.
Prefix this command with the following, as appropriate:
- For Windows: itda.bat
- For Linux: ./itda.sh

updatecell -d <hostname> -p <portNumber> -u <username> -w 
<password> -profilename <externalConfigurationName> -profiletype <externalConfigurationType> -f <fileDetails> [-l <locale>] [-v] [-s]

Angle brackets (< >) indicate a variable value that needs to be user defined.
Square brackets ([ ]) indicate optional parameters.

The following table describes the parameters used in the syntax:

Parameter	Description
-u	User name to use to connect with the Console Server.
-w	Password corresponding to the user name to use to connect with the Console Server.
-d	Host name of the Console Server
-p	Port number of the Console Server.
`-profilename`	Name of the external configuration to which the cell belongs (for which you want to change details). Tip: The name is case-insensitive.
`-profiletype`	Type of external configuration. The value can be one of the following: `BPPM`: If the cell for which you want to change details is associated with the BPPM Configuration type of external configuration. `BPPMCell`: If the cell for which you want to change details is associated with the BPPM Cell Configuration type of external configuration. Tip: The value is case-insensitive.
-f	Path to the file containing the new cell details that need to be updated. The path can be absolute or relative. The file must contain the previous cell name and the new cell details (key-value pairs) in the format, "`parameterName": "parameterValue"` as provided in the sample file. The parameters in the file are explained as follows:
	Parameter Name	Description
	`previousCellName`	Name of the existing cell selected in the external configuration on IT Data Analytics (that you want to replace with the new cell name). Specifying this parameter is mandatory. Unless you specify this parameter, you cannot successfully run this command.
	`cellName`	New cell name that you want to update in the specified external configuration.
	`cellHost`	Name of the host associated with the new cell name.
	`cellPort`	Name of the port associated with the new cell name.
	`secondaryCellHost`	Name of the secondary host associated with the new cell name. Providing this value can be useful only if you are trying to change cell details for a BPPMCell type of external configuration. If the host associated with the cell updated in the external configuration goes down, IT Data Analytics will automatically revert to the secondary cell based on the details provided for this parameter and the `secondaryCellPort` parameter.
	`secondaryCellPort`	Name of the port associated with the secondary host name. Providing this value can be useful only if you are trying to change cell details for a BPPMCell type of external configuration. If the host associated with the cell updated in the external configuration goes down, IT Data Analytics will automatically revert to the secondary cell based on the details provided for this parameter and the `secondaryCellHost` parameter.
-l	(Optional) Indicates the locale in which you want to display messages when the command is run. You can set one of the following locales: English Simplified Chinese German French By default, the messages are displayed in the locale of the system on which the CLI is run. The value can be set to one of the following depending on the locale you choose: English: `en` Simplified Chinese: `chs` German: `de` French: `fr` Example: If you want to set the locale as Simplified Chinese, you need to specify, `l=chs`.
-v	(Optional) Version of the IT Data Analytics product.
-s	(Optional) Indicates an HTTPS connection.

Example inputs

The following example provides the input for changing the cell details for an external configuration named, TSIM_Clm-03.

updatecell -u admin -w admin12345 -d localhost -p 9797 -profilename TSIM_Clm-03 -profiletype "BPPM" -f ".\src\test\resources\updateTSIMCell_CLI_Input.txt"

Page tree

updatecell CLI command

Syntax

Example inputs