CUBiT API: CheckHostConsistency

1.1. Description

Check the setup of all hosts in the domain to make sure their representation is internally complete within CUBiT. This method is only available to users to CUBiT Domain Admins and can be considered a maintenance method that should rarely, if ever, need to be run. Three areas of setup consistency are checked for each host:

1. Verification and re-application of the host's internal database representation within CUBiT. This may be needed after an upgrade of the CUBiT application is installed.
2. Verification that the IP address assigned to the host matches the hostname. If you suspect DNS setup issues in your domain, this test should catch them (unless the errors are transient). CUBiT will not let you create hosts with invalid DNS, but if DNS for the host gets changed improperly after the host is created, your host will experience many problems in the CUBiT environment until it is fixed.
3. Verification of the IP mask/gateway configured for the host with the actual one it resolves to.
4. Re-generation of statistics system performance monitoring configuration files for the host. If monitoring is not properly working for a host, regenerating the configuration files will usually fix the problem.

Depending on the number of hosts in your domain, this method can take some time to complete. If you have questions on the output of this method, please see your local CUBiT Administrator or contact CollabNet directly for assistance.

1.2. URL

/cubit_api/1/check_host_consistency

1.3. Authentication

This method requires authentication using an API key.

1.4. Parameters

	sig ( Required, once )
	API authentication hash signature. 
	Type: String
	userid ( Required, once )
	The login name of the user initiating the request. 
	Type: String

1.5. Example Response

Successful completion of host consistency check:

	<?xml version='1.0'?>
	<cubit version='1'>
		<status>OK</status>
		<output>All Hosts OK</output>
	</cubit>
	
	If the user is not a CUBiT Domain Admin:

	<?xml version='1.0'?>
	<cubit version='1'>
		<error>User 'grue' is not authorized to run this method.</error>
	</cubit>
	
	If there is an error re-generating the host's internal database 
	representation for at least one host:

	<?xml version='1.0'?>
	<cubit version='1'>
		<status>OK</status>
			<output>Hosts which were not successfully updated:
			cu011.dev.cubitdemo.net</output>
	</cubit>
	
	If the system performance statistics configuration files are not
	properly generated for at least one host:

	<?xml version='1.0'?>
	<cubit version='1'>
		<status>OK</status>
			<output>Hosts which are not properly setup to collect
			performance data: cu011.dev.cubitdemo.net</output>
	</cubit>
	
	If there is a DNS mismatch for at least one host:

	<?xml version='1.0'?>
	<cubit version='1'>
		<status>OK</status>
			<output>Hosts which require re-ip'ing:
			cu011.dev.cubitdemo.net</output>
	</cubit>
	
	If there is a IP mask mis-match:

	<?xml version='1.0'?>
	<cubit version='1'>
		<status>OK</status>
			<output>Hosts whose IP mask/gateway does not match with the
			IP mask/gateway it resolves to:
			cu011.dev.cubitdemo.net</output>
	</cubit>	  
	  

1.6. Response Codes

• 200 - ok
• 400 - Login failed / Insufficient permissions