DX Core server | HCL Digital Experience
This topic provides information about restarting the DX Core server and on creating
core server configuration report using the DXClient tool. The
dx-core-configuration-reports
command is used to generate the
differential reports on various core configurations between two DX server nodes.
Restart DX Core server
Important: Running the
restart-dx-core command in the Kubernetes-based deployments
might not restart all pods as expected, but this limitation will be addressed in the
future releases. For now, if you want to restart all pods, use the Kubernetes
interfaces such as
kubectl
.The restart-dx-core command is used to restart the DX Core server.
- Command description
-
This command invokes the restart-dx-core tool inside the DXClient and runs the DX Core restart action.
dxclient restart-dx-core
- Help command
-
This command shows the help information for
restart-dx-core
command usage:dxclient restart-dx-core -h
- Command options
-
Use this attribute to specify the username that is required for authenticating with the DX Core:
-dxUsername <value>
Use this attribute to specify the password that is required for authenticating with the DX Core:-dxPassword <value>
Use this attribute to specify the hostname of the target DX server:
-hostname <value>
Use this attribute to specify the port number of thecw_profile
:-dxConnectPort <value>
Use this attribute to specify the username that is required for authenticating to thecw_profile
:-dxConnectUsername <value>
Use this attribute to specify the password that is required for authenticating to thecw_profile
:-dxConnectPassword <value>
Specify either thedxProfileName
ordxProfilePath
of the DX core server:- Use this attribute to specify the profile name of the DX core
server (for example:
wp_profile
):-dxProfileName <Profile name of the DX core server>
- Use this attribute to specify the profile path of the DX server
(for example:
/opt/HCL/wp_profile
):-dxProfilePath <Path of the DX core server profile>
The values that are passed through the command line override the default values.
Use this attribute and retrigger the command to check the status of any previous request that was incomplete.-requestId <Unique ID of a previously triggered restart request>
- Use this attribute to specify the profile name of the DX core
server (for example:
- Example:
-
dxclient restart-dx-core -dxUsername <dxUsername> -dxPassword <dxPassword> -hostname <hostname> -dxConnectPort <dxConnectPort> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxProfileName <Profile name of the DX core server>
DX Core server configuration report
- Command description
-
The
dx-core-configuration-reports
command shows the summary of the configurations of a single DX server or both source and target DX servers, which users can use to compare.dxclient dx-core-configuration-reports [OPTIONS]
- Help command
-
This command shows the help information for
dx-core-configuration-reports
command usage:dxclient dx-core-configuration-reports summary-report -h
- Command options
-
Use this attribute to specify the hostname of the target DX server:
-hostname <value>
Use this attribute to specify the port number ofcw_profile
:-dxConnectPort <value>
Use this attribute to specify the user name that is required for authenticating tocw_profile
:-dxConnectUsername <value>
Use this attribute to specify the password that is required for authenticating tocw_profile
:-dxConnectPassword <value>
Use this attribute to specify the profile name of the DX core server:-dxProfileName <Profile name of the DX core server>
Use this attribute to specify the host name of the target DX core server:-targetHostname <value>
Use this attribute to specify the port number of the target cw_profile server:-targetDxConnectPort <value>
Use this attribute to specify the user name of the target server:-targetDxConnectUsername <value>
Use this attribute to specify the password of the target server:-targetDxConnectPassword <value>
Use this attribute to specify the profile name of the target server:-targetDxProfileName <Profile name of the DX core server>
Note:- The target server details are needed only when the user needs to generate the summary of the configurations of both source and target servers.
- Example:
-
dxclient dx-core-configuration-reports summary-report -hostname <hostname> -dxConnectUsername <dxConnectUsername> -dxConnectPassword <dxConnectPassword> -dxConnectPort <dxConnectPort> -targetHostname <targetHostname> -targetDxConnectUsername <targetDxConnectUsername> -targetDxConnectPassword <targetDxConnectPassword> -targetDxConnectPort <targetDxConnectPort>
Note: The attribute
-dxConnectHostname
is deprecated in CF202 and later
releases. It is recommended that you start using the replacement parameter
-hostname
starting from CF202 wherever necessary.