This site will undergo a maintenance outage on Saturday, 13 September beginning at 2:30 AM Central/1 PM IST for a platform upgrade. The downtime will be ~three hours.

Default language.

Important This documentation space contains information about the on-premises version of BMC Helix Discovery. If you are using the SaaS version of BMC Helix Discovery, see BMC Helix Discovery (SaaS).

tw_consolidation_control


Run the tw_consolidation_control command line utility to do the following tasks:

  • Set up DDD and inferred consolidation connections
  • Approve new connections from the receiver
  • Remove consolidation connections
  • Pause inferred consolidation
  • Start a resync with the receiver
  • Show the current status of consolidation

Tip

Use the BMC Discovery user interface to perform the functionality provided by the tw_consolidation_control command line utility (see Consolidation). If you choose to run the utility, read the information in this section to learn its usage and to understand the risks and potential impact on your environment.

Using the tw_consolidation_control utility

To use the utility, type the following command, where options are any of the options described in the following table and the common command line options described in Using-command-line-utilities.

tw_consolidation_control [options]

In each section below, user examples have been included for your reference. In these examples, the user name is system , and the password is not specified on the command line. The utility prompts for the password after you enter the command. Type the commands on a single line; line breaks are provided in the examples to make them easier to read. Note the following points before you use the utility:

  • Consolidation must be enabled before you can set up a connection
  • A consolidation connection must be configured on the sender and confirmed on the receiver
  • Disabling consolidation removes ALL connections.

Common options to manage consolidation

Note

The common command line options are described in Using-command-line-utilities.

By using the common options with the tw_consolidation_control command line utility, you can perform the following tasks:

Enabling or disabling consolidation

Use the following common options with the tw_consolidation_control command line utility to enable or disable consolidation:

Command Line Option

Description

--enable

Enable consolidation.

--disable

Disable consolidation. This removes all consolidation configurations and requires user confirmation.

--disable --force

Force disable consolidation without confirmation.

 This removes all configuration and bypasses user confirmation!

Show consolidation status

Command Line Option

Description

--status

Show the current status of consolidation.

Actions performed on the sender

To register a DDD sender with a DDD receiver:

tw_consolidation_control --ddd --register-receiver --receiver-location host1

To register an Inferred sender with an Inferred receiver:

tw_consolidation_control --inferred --register-receiver --receiver-location host1

To unregister from the receiver:

tw_consolidation_control --unregister-receiver --receiver receiver1

Actions performed on the receiver

To approve a sender registration request:

tw_consolidation_control --approve-sender --sender sender1

To release a registered sender:

tw_consolidation_control --release-sender --sender sender1

Command line options

See the previous sections for examples of how these command line options are combined:

Command Line Option

Description

--abort-resync

Abort a resync with the inferred receiver.

--approve-sender

Approve a sender's registration request.

--clear-http-proxy

Clear HTTP proxy.

--ddd

Specify the consolidation request for DDD consolidation.

--disable

Disable consolidation.

--enable

Enable consolidation.

--force

Force the operation. This option bypasses user confirmation. It is intended for scripting. Use with caution.

--inferred

Specify the consolidation request for inferred consolidation.

--limit=LIMIT

Specify the number of items to display.

--pause-sync

Pause sync with the inferred receiver.

--proxy-password=PROXY_PASSWORD

Specify the password for the HTTPS proxy.

--proxy-url=PROXY_URL

Specify the URL for the HTTPS proxy.

--proxy-username=PROXY_USERNAME

Specify the user name for the HTTPS proxy.

--receiver=RECEIVER

The ID or name of the receiver system.

--receiver-location=RECEIVER_LOCATION

The receiver's hostname, IP address, or, for inferred consolidation only, the URL.

--register-receiver

Register with a receiver.

--release-sender

Release the sender.

--reset-receiver-counts

Reset counts with inferred receiver.

--resume-resync

Resume an aborted resync with inferred receiver.

--resync-id=RESYNC_ID

Specify the ID of a resync operation. Used in conjunction with --resume-resync.

--resync-status

Get status of resync with inferred receiver.

--sender=SENDER

Specify the ID or name of a sender system.

--set-http-proxy

Use an HTTP proxy. Used in conjunction with: --proxy-password, --proxy-url=PROXY_URL, and --proxy-username.

--start-resync

Start resync with inferred receiver.

--status

Show consolidation status.

--unpause-sync

Unpause sync with inferred receiver.

--unregister-receiver

Unregister from receiver.

--update-receiver

Update registration with receiver.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*